Content-type: text/html Man page of dxbook

dxbook

Section: Misc. Reference Manual Pages (1X)
Index Return to Main Contents
 

NAME

dxbook - Invokes Bookreader.  

SYNOPSIS

dxbook [flags ] [ bookshelf book [ section ] ]  

PARAMETERS

Specifies 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. If the argument specified is a book file, Bookreader first opens the bookshelf file as if no argument were specified, but the Library window starts up as an icon. Bookreader then opens the specified book. Specifies the symbol name for a Topic to be opened in the specified book file. Section is a symbolic name that the book's author has defined to be associated with a section title. This is useful for books that you have written or whose source files you have access to.  

FLAGS

Specifies the display screen where dxbook displays its windows. If the display flag is not specified, dxbook uses the display screen specified by the DISPLAY environment variable. The display flag 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). This flag is the same as the -d flag.  

DESCRIPTION

Bookreader lets you read online documentation.

The dxbook command runs Bookreader. You can also run Bookreader by selecting the Bookreader item from the Applications menu of the Session Manager.

Bookreader has three windows: Library window, Navigation window, and Topic window. The Library window lists the libraries, bookshelves and books available to read. The Navigation window displays a book's table of contents, index, and other directories such as tables and examples. The Topic window displays the contents of the book section you have selected to read.

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

You open a book by double clicking MB1 on the book title in the Library window. 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 can 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 click on a reference to another section to display the new section 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 Hotspots menu item from the Topic window View menu.  

Specifying Libraries

When you first run Bookreader, the list of bookshelves and books that appears in the Library 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 bookshelf argument on the command line. If the bookshelf 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. Specifies 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. Specifies the bookshelf file. If DECW_BOOKSHELF is not set and the bookshelf 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"

All titles appear in the Library window when you run Bookreader.  

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 Specifies 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. Specifies the resource. Specifies 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 and the application name identifier is dxbook.

Bookreader has three class names: Specifies resources for the Library window. Specifies resources for the Navigation window. Specifies resources for the Topic window.

The following resources are available for dxbook: Specifies the Navigation window background color. Use only with the BookreaderNavigation name identifier. The default is white. Specifies the Navigation and Topic window foreground color. Use only with the BookreaderNavigation and BookreaderTopic name identifiers. The default is black. Specifies the x coordinate for the top left corner of the specified Bookreader window. The defaults are 3 for the Library and Navigation windows and 408 for the Topic window. Specifies the y coordinate for the top left corner of the specified Bookreader window. The defaults are 25 for the Library window, 80 for the Navigation window, and 75 for the Topic window. Specifies the width in millimeters of the specified Bookreader window. The defaults are 98 for the Library window, 101 for the Navigation window, and 159 for the Topic window. Specifies the height in millimeters of the specified Bookreader window. The defaults are 100 for the Library window, 145 for the Navigation window, and 178 for the Topic window. 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. The default is 3. 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. Specifies the number of pixels to offset the x coordinate of subsequent Navigation windows when more than one is open. Use only with the BookreaderNavigation and BookreaderTopic name identifiers. The defaults are 0 for the Navigation window and 35 for the Topic window. Specifies the number of pixels to offset the y coordinate of subsequent windows when more than one is open. Use only with the BookreaderNavigation and BookreaderTopic name identifiers. The default is 35. Specifies the maximum default Topic window width. Use only with the BookreaderTopic name identifier. The default is 765. Specifies the maximum default Topic window height. Use only with the BookreaderTopic name identifier. The default is 645. Specifies if hotspots are turned on by default. Use only with the BookreaderTopic name identifier. The default is false. Specifies if extensions are turned on by default. Use only with the BookreaderTopic name identifier. The default is true.

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. The .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 To implement tear-off menus in each of the Bookreader windows, add these entries to your .Xdefaults file:
*BookreaderLibrary*tearOffModel: XMTEAR_OFF_ENABLED *BookreaderNavigation*tearOffModel: XMTEAR_OFF_ENABLED *BookreaderTopic*tearOffModel: XMTEAR_OFF_ENABLED
 

FILES

Bookreader binary Default bookshelf  

RELATED INFORMATION

Bookreader Online Help

Using Bookreader

To use Bookreader online help, choose an item from the Help menu. The Using Bookreader document is available in the default bookshelf. delim off


 

Index

NAME
SYNOPSIS
PARAMETERS
FLAGS
DESCRIPTION
Specifying Libraries
X DEFAULTS
EXAMPLES
FILES
RELATED INFORMATION

This document was created by man2html, using the manual pages.
Time: 02:42:46 GMT, October 02, 2010