Digital

NAME

dxbook − Bookreader

SYNOPSIS

dxbook [ options ] [ bookshelf book [ symbol ] ]

PARAMETERS

bookshelfSpecifies a bookshelf file. If you do not include this argument, Bookreader uses the file specified by the DECW_BOOKSHELF environment variable. If DECW_BOOKSHELF is not defined, Bookreader uses the default bookshelf file, /usr/lib/dxbook/library.decw_bookshelf. 

bookIf the argument specified is a book file, Bookreader will first open the bookshelf file as if no argument were specified, but the Library window will start up iconified. Bookreader will then open the specified book. 

symbolSpecifies the symbol name for a topic to be opened in the specified book file. 

DESCRIPTION

The dxbook command runs Bookreader. You can also run Bookreader by selecting the Bookreader item from the Applications menu of the Session Manager.  Bookreader lets you view on-line documentation on your workstation screen. 

Bookreader has three types of windows: library windows, navigation windows, and topic windows. The library window lists the bookshelves and books available from Bookreader. The navigation window displays a book’s directories, for example table of contents and index, when it is open. The topic window displays the contents of the book you have selected to view. 

A bookshelf is a group of related books. To view a book that is in a shelf, you first open the shelf by double clicking MB1 on the shelf title.  When you open a shelf, a list of the books and bookshelves in that shelf appears in the library window. 

When you open a book by double clicking MB1 on the book title, the table of contents for that book appears in the navigation window. 

You can move through a book’s contents in the topic window using the scroll bar and the Go Back, Topic, and Screen buttons. 

In the topic window, a reference in the text to a figure, a table, or an example is a hotspot. That is, if you position the pointer at the reference and double click MB1, the figure, table, or example is displayed in a separate window. A figure, table, or example may also be displayed by selecting it from the book’s table of contents in the navigation window. 

Cross-references to other sections of text are also hotspots.  Double clicking on a reference to another section causes the new topic to be displayed in the topic window. 

Hotspots are normally highlighted only when you move the pointer over the reference. You can cause hotspots to be continuously highlighted by choosing the Hot Spot menu item from the topic window View menu. 

FLAGS

−bg color Specifies the color of the navigation window’s background (color displays only). The default is white. 

−d dispname Specifies the display screen on which dxbook displays its windows.  If the display option is not specified, dxbook uses the display screen specified by the DISPLAY environment variable.  The display option has the format hostname:number.number.  Using two colons (::) instead of one (:) causes DECnet to be used for transport.  The setting :0.0 is the default.  For more information, see X(1X). 

−display dispname This option is the same as the −d option. 

−fg color Specifies the color of Bookreader windows’ foreground (color displays only).  The default is black. 

−geometry Specifies the width, length, and location of the dxbook navigation window. If the geometry argument is not specified, dxbook uses default values. The geometry option has the format =[width][xlength][x][y], where width and length are specified in pixels.  Note that changing the width or length of the navigation window may make the contents of the window difficult to read.  For more information about the screen coordinate system, see X(1X). 

−rv Reverses the default color values (for example, black becomes white and white becomes black). 

Popup-Menus

In the work area of a window, popup-menus are available. Each of the windows (the library window, the navigation window, and the topic window) contains the following popup-menus:

File menu
Link menu
View menu

The items on a menu can vary depending on where you are when you select the menu.

Many of the items on the File and View menus of the topic window have equivalent command buttons, located along the bottom edge of the topic window. You can select a function using the menu item or the equivalent command button. 

File Menu

The following list contains all options that appear on the File menu in any of the three windows:

Close BookCloses the book currently displayed in the navigation window. 

Close TopicCloses the topic window. 

ExitExits from the Bookreader application and closes all windows. 

Open BookOpens the book you have selected. The table of contents appears in the navigation window. 

Open Book...Opens a book that is located in your directory. 

Open Book in New WindowOpens the book you have selected. The table of contents appears in a new navigation window. 

Open TopicOpens a selected topic. 

Open Topic in New WindowCreates a new topic window and opens the selected topic. 

Switch Library...Changes to a library located in your directory. 

Switch to Default Library...Changes from a library located in your directory to a default library. 

Link Menu

The same options appear on the Link menu in all three types of windows.  The Link menu options are the following:

Complete LinkCreates a new information link, making the current object the target. The source is the object selected with Start Link. 

Complete Link...Lets you modify information about the source, target, and link, then create a new information link. 

Go BackCancels the most recent Go To or Visit operation. Use Go Back when you "change your mind."

Go ToDisplays an object to which the current object is linked and closes the window that displays the current object. 

HighlightEnables highlighting for linked objects. 

Show HistoryDisplays a dialog box that shows the steps in the history list. The history list is a record of all Visit and Go To operations. 

Show Links...Displays a dialog box that shows the links for the selected object. 

Start LinkStarts the process of creating an information link and makes the selected object the source for the link. 

Step ForwardSteps forward to the next object on the current LinkWorks path. For more information, see Getting Started with LinkWorks. 

Turn Highlight OffDisables highlighting for linked objects. 

VisitDisplays an object to which the current object is linked. Unlike Go To, Visit does not close the window containing the current object. 

View Menu

The following list contains all options that appear on the View menu in any of the three windows:

CollapseCollapses the highlighted item (Contents, Figures, Tables, Examples, or Index), leaving only the header displayed. 

Collapse AllCollapses all information in the navigation window, leaving only first-level headers displayed. 

ContentsDisplays the table of contents for the open book. 

ExamplesDisplays the list of examples in the open book. 

ExpandExpands the selected item. In the case of an item such as Index, this is only a partial expansion. 

ExtensionsEnables and disables highlighting of programming language extensions. By default, extensions to programming languages are highlighted in the topic window. 

FiguresDisplays the list of figures in the book that is open. 

Fully ExpandFully expands the selected item. For example, fully expands all index entries. 

Go BackDisplays the topic you were viewing just prior to the current topic. 

Hot SpotsEnables and disables highlighting of hotspots, which are references to figures, tables, examples, footnotes, or other sections of text.  By default, hotspots are not highlighted. 

Next TopicDisplays the next topic in the book. 

Previous TopicDisplays the previous topic in the book. 

X Defaults

The dxbook application reads the .Xdefaults file during startup and uses the appropriate resource specification to customize the appearance or characteristics of its displayed dxbook window. The format for a resource specification in the .Xdefaults file is:

[name∗]resource: value

nameSpecifies the application name or the name string that restricts the resource assignment to that application or to a component of an application. If this argument is not specified, the resource assignment is globally available to all X applications. 

resourceSpecifies the resource. 

valueSpecifies the value that is to be assigned to the resource. 

For more information, see X(1X). 

Because each toolkit-based application can consist of a combination of widgets (for example, push buttons and a scroll bar), you can form the name string by adding widget class and name identifiers to the string. For further information about adding class and name identifiers, see X(1X). 

For dxbook , the application class identifier is DXBookreader. 

For dxbook , the application name identifier is dxbook. 

Bookreader has three class names:

BookreaderLibrarySpecifies resources for the library window. 

BookreaderNavigationSpecifies resources for the Navigation window. 

BookreaderTopicSpecifies resources for the Topic window. 

The resources available for dxbook are the following. Default values are in parentheses. 

background (white) Specifies the navigation window background color. foreground (black) Specifies the navigation and topic window foreground color. BookreaderLibrary.x (3) Specifies the default x coordinate for the library window. BookreaderLibrary.y (25) Specifies the default y coordinate for the library window. BookreaderLibrary.mm_width (98) Specifies the width in millimeters of the library window. BookreaderLibrary.mm_height (100) Specifies the height in millimeters of the library window. BookreaderLibrary.initialState (3) Specifies whether Bookreader starts up with the library window displayed, or starts up as an icon. Setting the initial state to 3 causes Bookreader to start up as an icon. BookreaderLibrary.shelf_to_open_on_startup (first) Specifies a top level shelf to expand when opening the library window at startup. The default is the first top level shelf. Last and none can also be specified. BookreaderNavigation.x (3) Specifies the default x coordinate for the navigation window. BookreaderNavigation.y (80) Specifies the default y coordinate for the navigation window. BookreaderNavigation.mm_width (101) Specifies the width in millimeters of the navigation window. BookreaderNavigation.mm_height (145) Specifies the height in millimeters of the navigation window. BookreaderNavigation.x_offset (0) Specifies the number of pixels to offset the x coordinate of subsequent navigation windows when more than one is open. BookreaderNavigation.y_offset (35) Specifies the number of pixels to offset the y coordinate of subsequent navigation windows when more than one is open. BookreaderTopic.x (408) Specifies the default x coordinate for the topic window. BookreaderTopic.y (75) Specifies the default y coordinate for the topic window. BookreaderTopic.mm_width (159) Specifies the width in millimeters of the topic window. BookreaderTopic.mm_height (178) Specifies the height in millimeters of the topic window. BookreaderTopic.x_offset (35) Specifies the number of pixels to offset the x coordinate of subsequent topic windows when more than one is open. BookreaderTopic.y_offset (35) Specifies the number of pixels to offset the y coordinate of subsequent topic windows when more than one is open. BookreaderTopic.max_default_topic_width (765) Specifies the maximum default topic window width. BookreaderTopic.max_default_topic_height (645) Specifies the maximum default topic window height. BookreaderTopic.show_hot_spots (false) Specifies if hotspots are turned on by default. BookreaderTopic.show_extensions (true) Specifies if extensions are turned on by default. Bookreader does not save any of its resources, so it is safe to modify all of them locally.

In all cases, .mm_width and .mm_height are specified in millimeters. .x_offset and .y_offset specify the relative placement of subsequent instances of the same type of window. 

Examples

To change the foreground color of the Bookreader windows, add the following entry to your .Xdefaults file:

dxbook∗foreground: yellow

To cause Bookreader to always start up as an icon, add this entry to your .Xdefaults file:

∗BookreaderLibrary.initialState: 3

To reposition the library window to the bottom right corner of your screen, add this entry to your .Xdefaults file:

dxbook.BookreaderLibrary.x:  -0
dxbook.BookreaderLibrary.y:  -0

Specifying Libraries

When you first run Bookreader, the list of bookshelves and books that appears in the navigation window is the top-level library. A special file called the bookshelf file contains an entry for each bookshelf and book that appears in the top-level library.  You can specify the bookshelf file explicitly, using the file argument on the command line. If the file argument is not included, or does not contain an explicit pathname specification, Bookreader uses the environment variables DECW_BOOK and DECW_BOOKSHELF to locate the bookshelf file. 

DECW_BOOKSpecifies the search path for book and bookshelf files.  Separate multiple pathnames with spaces. If DECW_BOOK is not set and no explicit pathname is specified on the command line, Bookreader looks for book and bookshelf files in /usr/lib/dxbook. 

DECW_BOOKSHELFSpecifies the bookshelf file. If DECW_BOOKSHELF is not set and the file argument is not included on the command line, Bookreader looks for a bookshelf file named library.decw_bookshelf. 

If DECW_BOOKSHELF is not set, but DECW_BOOK is, Bookreader looks for bookshelf files named library.decw_bookshelf using the search path specified by DECW_BOOK. 

The environment variables allow you to have Bookreader recognize additional books or bookshelf files. You can store bookshelf files and their associated book files in different directories, and set the environment variable DECW_BOOK to specify all the pathnames. For example, you have the default bookshelf and books in /usr/lib/dxbook, and another bookshelf with its books in /usr/local/lib/localbooks.  You set DECW_BOOK to specify both pathnames:

setenv DECW_BOOK "/usr/lib/dxbook /usr/local/lib/localbooks"

and all titles appear in the navigation window when you run Bookreader. 

FILES

/usr/bin/dxbook Bookreader binary

/usr/lib/dxbook/library.decw_bookshelf Default bookshelf

RELATED INFORMATION

Using Bookreader Available online in the default bookshelf