Online_Documentation_Library________________________ CD-ROM User's Guide AA-QDGTC-XE This guide describes how to use the Online Documentation Library CD-ROMs. Platforms Supported: OpenVMS VAX OpenVMS Alpha Digital UNIX[R] (formerly DEC OSF/1[R]) ULTRIX VAX and ULTRIX RISC Revision/Update Information: This is a revised document. Digital Equipment Corporation Maynard, Massachusetts ________________________________________________________________ July 1995 The optical disc publication and all component parts as appearing herein are copyrighted. Digital Equipment Corporation makes no representations that the use of its products in the manner described in this publication will not infringe on existing or future patent rights, nor do the descriptions contained in this publication imply the granting of licenses to make, use, or sell equipment or software in accordance with the description. Possession, use, or copying of the software described in this publication is authorized only pursuant to a valid written license from Digital or an authorized sublicensor. © Digital Equipment Corporation 1995. All rights reserved. The following are trademarks of Digital Equipment Corporation: Bookreader, DECwindows, Digital, InfoServer, OpenVMS, PATHWORKS, ULTRIX, VAX, VAXcluster, VAX DOCUMENT, VMS, and the DIGITAL logo. The following are third-party trademarks: PostScript is a registered trademark of Adobe Systems, Incorporated. Motif and OSF/1 are registered trademarks of the Open Software Foundation, Inc. UNIX is a registered trademark in the United States and other countries, licensed exclusively through X/Open Company, Ltd. All other trademarks and registered trademarks are the property of their respective holders. This document is available on CD-ROM. This document was prepared using VAX DOCUMENT Version 2.1. _________________________________________________________________ Contents Preface................................................... v 1 Overview of the CD-ROM User's Guide 1.1 About These CD-ROMs .......................... 1-1 1.1.1 Before Using the CD-ROMs.................. 1-1 1.1.2 Handling the CD-ROMs...................... 1-1 1.2 Getting Started with Bookreader............... 1-2 2 OpenVMS VAX Online Documentation Library 2.1 Required Environment.......................... 2-1 2.2 Mounting and Controlling Access to a CD-ROM... 2-1 2.3 Enabling Access to Online Documentation....... 2-2 2.3.1 Executing BOOKBROWSER.COM................. 2-2 2.3.2 Providing Clusterwide Access to Online Documentation............................. 2-3 2.4 Reading Books on the CD-ROMs ................. 2-3 2.4.1 Redefining DECW$BOOK...................... 2-3 2.4.2 Defining DECW$BOOKSHELF................... 2-4 2.4.3 Accessing CD-ROMs Simultaneously.......... 2-5 2.4.4 Making a CD-ROM the Default Library....... 2-5 2.4.5 Running Bookreader........................ 2-6 2.5 Printing a Listing of Products................ 2-6 iii 3 OpenVMS Alpha Online Documentation Library 3.1 Required Environment.......................... 3-1 3.2 Mounting and Controlling Access to a CD-ROM... 3-1 3.3 Enabling Access to Online Documentation....... 3-2 3.3.1 Executing BOOKBROWSER.COM................. 3-2 3.3.2 Providing Clusterwide Access to Online Documentation............................. 3-3 3.4 Reading Books on the CD-ROM................... 3-3 3.4.1 Redefining DECW$BOOK...................... 3-3 3.4.2 Defining DECW$BOOKSHELF................... 3-4 3.4.3 Accessing CD-ROMs Simultaneously.......... 3-5 3.4.4 Making a CD-ROM the Default Library....... 3-5 3.4.5 Running Bookreader........................ 3-6 3.5 Printing a Listing of Products................ 3-6 4 Digital UNIX Online Documentation Library 4.1 Required Environment.......................... 4-1 4.2 Mounting and Controlling Access to a CD-ROM .............................................. 4-1 4.3 Enabling Access to Online Documentation....... 4-4 4.3.1 Registering Bookbrowser................... 4-4 4.4 Reading Books on the CD-ROMs.................. 4-5 4.4.1 Specifying Bookreader Libraries........... 4-5 4.4.2 Accessing Bookreader Documentation from a Server.................................... 4-6 4.4.3 Running Bookreader........................ 4-7 4.5 Printing a Listing of Products................ 4-7 5 ULTRIX Online Documentation Library 5.1 Required Environment.......................... 5-1 5.2 Mounting and Controlling Access to a CD-ROM... 5-1 5.3 Enabling Access to Online Documentation....... 5-3 5.3.1 Registering Bookbrowser................... 5-4 5.4 Reading Books on the CD-ROMs.................. 5-4 5.4.1 Specifying Bookreader Libraries........... 5-4 5.4.2 Accessing Bookreader Documentation from a Server.................................... 5-6 5.4.3 Running Bookreader........................ 5-7 5.5 Printing a Listing of Products................ 5-7 iv Index v _________________________________________________________________ Preface This guide provides introductory information about the Online Documentation Library CD-ROMs for the following platforms: o OpenVMS VAX (see Chapter 2) o OpenVMS Alpha (see Chapter 3) o Digital UNIX (see Chapter 4) o ULTRIX VAX and ULTRIX RISC (see Chapter 5) Contents of This Guide This guide begins with an overview chapter providing information about the Online Documentation Library CD-ROMs that is common to all platforms. The rest of the guide consists of chapters for each operating system, describing: o The environment required to run Bookreader o Mounting a CD-ROM o Providing access to Bookreader documentation on a CD-ROM o Reading books from a CD-ROM o Printing a listing of products v Ordering Information Digital Equipment Corporation provides the following: o Product binaries - Through quarterly library distributions - Through individual kit purchases o Product documentation - Through online documentation CD-ROMs included with the software product library or as a separate offering - In printed format o ECO and MUP distribution - As a separate consolidated offering released eight times a year - On some platforms, as part of the software product library at the time of the platform's quarterly release For individual product ordering information, consult your Digital account representative. Call 1-800-DIGITAL to place orders in the United States. Contact your local Digital subsidiary outside the United States. Order numbers for software kits, printed manuals, and software service are included in product cover letters or are listed on the Software Product Descriptions (SPDs). Providing Feedback Digital welcomes your comments on its products. To make it easy for you to provide feedback, Digital has created the following Internet mail account: cdrom_docs@zko.dec.com Use this account to provide comments on this guide, and the Online Documentation Library Master Index. vi Conventions The following conventions are used in this guide: ___________________________________________________________ Convention____________Meaning______________________________ For_OpenVMS_platforms:_____________________________________ UPPERCASE TEXT Uppercase letters indicate the name of a command, a file, a parameter, a procedure, or utility. $ The dollar sign ($) indicates the DIGITAL Command Language (DCL) prompt on OpenVMS systems. This prompt may be different on your system. ___________________________________________________________ For_platforms_based_on_UNIX_systems:_______________________ % The percent sign (%) indicates the user prompt on ULTRIX and Digital UNIX systems. # The pound sign (#) indicates the system manager prompt on ULTRIX and Digital UNIX systems. Digital UNIX, References to Digital UNIX and Digital UNIX Systems Digital UNIX Systems refer to the Digital UNIX (formerly DEC OSF/1) operating system running on Alpha processor hardware. ___________________________________________________________ For_all_platforms:_________________________________________ $ MOUNT DKA400: Boldface monospace text represents VAXDOCNOV941 user input in interactive examples. $ mount -r /dev/rz4c /mnt device-name volume- Lowercase italics indicate a variable label string. These variables include product identifiers, hardware devices, directory locations, file ______________________names,_and_mount_points._____________ vii 1 _________________________________________________________________ Overview of the CD-ROM User's Guide The following information about Digital's Online Documentation Library CD-ROMs applies to all platforms. 1.1 About These CD-ROMs Digital's Online Documentation Library CD-ROMs contain documentation files designed to be used with Bookreader software, the online information access tool. These files are located in the [DECW$BOOK] or /decw_book directories of the Online Documentation Library CD-ROMs. Included in these directories is the Getting Started bookshelf, which contains information about using Bookreader software. 1.1.1 Before Using the CD-ROMs Make sure you are familiar with the system hardware, including the compact disc drive. The Optical Disc Drive Owner's Manual for each type of drive contains instructions for using the disc drive. 1.1.2 Handling the CD-ROMs The CD-ROMs accompanying this booklet are enclosed in an antistatic envelope. To be mounted on your system, a CD-ROM must be removed from this envelope and loaded into a caddy. In handling the CD-ROM, always grasp it by its edges only. For information about inserting the CD-ROM in the disc drive, refer to the Optical Disc Drive Owner's Manual. Overview of the CD-ROM User's Guide 1-1 Overview of the CD-ROM User's Guide 1.2 Getting Started with Bookreader 1.2 Getting Started with Bookreader Because you can read the documentation files on these CD-ROMs only with Bookreader, you should be familiar with how to use Bookreader. If you are not familiar with using Bookreader, follow the directions for running Bookreader in the chapter that describes your operating system. Then return to this section and use the following procedure to begin using Bookreader from a DECwindows terminal, personal computer, or workstation: 1. Using the mouse, move the pointer to the Getting Started topic (bookshelf) in the initial Bookreader window, and double-click Mouse Button 1 (MB1) to open the bookshelf. 2. Double-click MB1 to open the Using Bookreader book. 3. Double-click MB1 on a contents heading you want to read; Bookreader opens a topic window, which displays the text of the section you have selected. The Using Bookreader Contents remains displayed in the book Contents window. 4. Navigate through the document using either the Contents displayed in the book Contents window or the buttons at the bottom of the topic window. o To go to the next topic or screen, click the right arrow buttons beside Topic and Screen. o To go to a previous topic or screen, click the left arrow buttons beside Topic and Screen. 5. To close the Using Bookreader book, choose Close Book from the File menu in the book Contents window. This closes both windows. 6. To select another book from the Getting Started bookshelf, double-click on the appropriate title. 7. To exit Bookreader, choose Exit or Quit from the File menu in the Bookreader window. 1-2 Overview of the CD-ROM User's Guide 2 _________________________________________________________________ OpenVMS VAX Online Documentation Library This chapter describes how to use the OpenVMS VAX Online Documentation Library CD-ROMs. 2.1 Required Environment To read online documentation, you must have the following environment: o Bookreader software. Bookreader is packaged with DECwindows Motif, which is part of the OpenVMS VAX operating system environment. o A bitmap DECwindows display (a workstation or a personal computer using PATHWORKS software). o A CD-ROM reader. 2.2 Mounting and Controlling Access to a CD-ROM To access the files on an OpenVMS VAX Software Product Library CD-ROM, mount the CD-ROM using the following procedure: 1. Find the appropriate volume label on the face of the CD-ROM. 2. Load the CD-ROM into a protective caddy. 3. Insert the caddy into the drive. 4. Log in to the system manager's account (SYSTEM). 5. Mount the CD-ROM by entering the MOUNT command in the following format: MOUNT device-name: volume-label OpenVMS VAX Online Documentation Library 2-1 OpenVMS VAX Online Documentation Library 2.2 Mounting and Controlling Access to a CD-ROM For example: $ MOUNT DKA400: VAXDOCJAN941 2.3 Enabling Access to Online Documentation Online documentation is made accessible either through individual product licenses, which must be registered and loaded, or through the use of the BOOKBROWSER.COM command procedure. If a software product is registered by means of a Product Authorization Key (PAK), you do not need to enable the online documentation; the product's online documentation is already accessible. If a software product is not registered (no PAK has been installed), execute BOOKBROWSER.COM as described in Section 2.3.1 to access the product's online documentation. Online documentation is provided as is and is not covered by other Digital warranties. 2.3.1 Executing BOOKBROWSER.COM The BOOKBROWSER.COM command procedure registers the Bookbrowser PAK on your system and loads the appropriate information into your system's software license database. Executing BOOKBROWSER.COM provides you with access to all documents contained on this CD-ROM at no additional cost. To execute BOOKBROWSER.COM, complete the following procedure: 1. Mount the CD-ROM containing the online documentation you want to read (see Section 2.2). 2. Execute BOOKBROWSER.COM by entering a DCL command in the following format: @device-name:[DECW$BOOK]BOOKBROWSER.COM where: device-name is the name of the device on which you have mounted the CD-ROM. For example: $ @DKA400:[DECW$BOOK]BOOKBROWSER.COM 2-2 OpenVMS VAX Online Documentation Library OpenVMS VAX Online Documentation Library 2.3 Enabling Access to Online Documentation 2.3.2 Providing Clusterwide Access to Online Documentation Once you have run BOOKBROWSER.COM, you can provide clusterwide access to the online documentation CD-ROMs in one of two ways: o Reboot the cluster o Invoke the OpenVMS System Management Utility (SYSMAN) Both methods load the Bookbrowser PAK into the clusterwide license database, but SYSMAN does this without requiring you to reboot the cluster. To load the Bookbrowser PAK into the clusterwide license database, complete the following procedure: 1. Log in to the SYSTEM account. 2. Enter the following commands: $ RUN SYS$SYSTEM:SYSMAN SYSMAN> SET ENVIRONMENT/CLUSTER SYSMAN> DO LICENSE LOAD BOOKBROWSER SYSMAN> EXIT The Bookbrowser PAK is loaded into the clusterwide license database. 2.4 Reading Books on the CD-ROMs This section describes how to read books on the OpenVMS VAX Online Documentation Library CD-ROMs. 2.4.1 Redefining DECW$BOOK During installation, the DECwindows software automatically creates a library directory for Bookreader on your system disk. The DECwindows software also defines the logical name DECW$BOOK to refer to this directory. When you invoke Bookreader, it reads the library file in the directory defined by DECW$BOOK. To read the library files on the OpenVMS VAX Online Documentation Library CD-ROMs, you must redefine the DECW$BOOK logical name to refer to the directory [DECW$BOOK] on the CD-ROMs. OpenVMS VAX Online Documentation Library 2-3 OpenVMS VAX Online Documentation Library 2.4 Reading Books on the CD-ROMs Use a command in the following format to redefine the DECW$BOOK logical name to refer to the [DECW$BOOK] directory on the CD-ROM: DEFINE/SYSTEM DECW$BOOK device-name:[DECW$BOOK] where: device-name is the name of the device where the Online Documentation Library CD-ROM is mounted. For example: $ DEFINE/SYSTEM DECW$BOOK DKA400:[DECW$BOOK] 2.4.2 Defining DECW$BOOKSHELF You can also define the DECW$BOOKSHELF logical name to direct Bookreader to a file on the CD-ROM that contains another structured library. To define the DECW$BOOKSHELF logical name, use a command in one of the following formats. Substitute the name of the device where you have mounted the Online Documentation Library CD-ROM for device-name. Also, be sure the file name contains the semicolon (;) as shown. o To display a library in which documentation is organized into categories: DEFINE/SYSTEM DECW$BOOKSHELF device-name:[DECW$BOOK]LIBRARY.DECW$BOOKSHELF; For example: $ DEFINE/SYSTEM DECW$BOOKSHELF DKA400:[DECW$BOOK]LIBRARY.DECW$BOOKSHELF; o To display a library in which documentation is organized alphabetically: DEFINE/SYSTEM DECW$BOOKSHELF device-name:[DECW$BOOK]DMASTER.DECW$BOOKSHELF; For example: $ DEFINE/SYSTEM DECW$BOOKSHELF DKA400:[DECW$BOOK]DMASTER.DECW$BOOKSHELF; If you do not define DECW$BOOKSHELF, Bookreader displays the default library defined by DECW$BOOK. 2-4 OpenVMS VAX Online Documentation Library OpenVMS VAX Online Documentation Library 2.4 Reading Books on the CD-ROMs 2.4.3 Accessing CD-ROMs Simultaneously To access books on multiple CD-ROMs, you must define DECW$BOOK to point to multiple devices and define DECW$BOOKSHELF to point to the library structure of your choice. Because all bookshelf files are on all CD-ROMs, you can define DECW$BOOKSHELF to point to the LIBRARY.DECW$BOOKSHELF on CD-ROM 1. To access books on multiple CD-ROMs: 1. Define DECW$BOOK using a command in the following format: DEFINE/SYSTEM DECW$BOOK device-name1:[DECW$BOOK],device-name2:[DECW$BOOK],- _$ device-name3:[DECW$BOOK] For example: $ DEFINE/SYSTEM DECW$BOOK DKA200:[DECW$BOOK],DKA300:[DECW$BOOK],- _$ DKA400:[DECW$BOOK] 2. Define DECW$BOOKSHELF, using a command in the following format. Make sure the file name contains the semicolon as shown. DEFINE/SYSTEM DECW$BOOKSHELF device-name1:[DECW$BOOK]LIBRARY.DECW$BOOKSHELF; For example: $ DEFINE/SYSTEM DECW$BOOKSHELF DKA400:[DECW$BOOK]LIBRARY.DECW$BOOKSHELF; 3. If you invoked Bookreader before you defined the logical names, exit Bookreader and invoke it again. 2.4.4 Making a CD-ROM the Default Library To define a CD-ROM as the default library, add a command line defining DECW$BOOK to your startup command procedure located in SYS$MANAGER. Add a line in the following format: DEFINE/SYSTEM DECW$BOOK device-name:[DECW$BOOK] For example, the following command line establishes the CD-ROM mounted on DKA400 as the library from which books will be read each time you start up the system: $ DEFINE/SYSTEM DECW$BOOK DKA400:[DECW$BOOK] OpenVMS VAX Online Documentation Library 2-5 OpenVMS VAX Online Documentation Library 2.4 Reading Books on the CD-ROMs 2.4.5 Running Bookreader To run Bookreader, choose Bookreader from the Applications menu on your Session Manager menu. If you are not familiar with Bookreader, see Section 1.2 for introductory instructions on its use. 2.5 Printing a Listing of Products The following files are available in the [README] directory on the first CD-ROM: o CDMASTER_INDEX.PS (.TXT) A printable version of the OpenVMS VAX Online Documentation Library Master Index, which provides a listing of all the products in this release o USER_GUIDE.PS (.TXT) A printable version of the Online Documentation Library CD-ROM User's Guide (this guide) To print a hardcopy listing (in ASCII or PostScript format) of one of these files, enter a command in one of the following formats: PRINT/QUEUE=queue-name device-name:[README]file-name.TXT PRINT/QUEUE=queue-name device-name:[README]file-name.PS For example: $ PRINT/QUEUE=VAX_ANSI DKA400:[README]CDMASTER_INDEX.TXT $ PRINT/QUEUE=VAX_POST DKA400:[README]USER_GUIDE.PS 2-6 OpenVMS VAX Online Documentation Library 3 _________________________________________________________________ OpenVMS Alpha Online Documentation Library This chapter describes how to use the OpenVMS Alpha Online Documentation Library CD-ROMs. 3.1 Required Environment To read online documentation, you must have the following environment: o OpenVMS Alpha Version 1.5 or higher operating system. o Bookreader software. Bookreader is packaged with DECwindows Motif, which is part of the OpenVMS Alpha operating system environment. o A bitmap DECwindows display (a workstation or a personal computer using PATHWORKS software). o A CD-ROM reader. Alpha hardware systems are shipped with a CD-ROM reader. 3.2 Mounting and Controlling Access to a CD-ROM To access the files on an OpenVMS Alpha Software Product Library CD-ROM, mount the CD-ROM using the following procedure: 1. Find the appropriate volume label on the face of the CD-ROM. 2. Load the CD-ROM into a protective caddy. 3. Insert the caddy into the drive. 4. Log in to the system manager's account (SYSTEM). 5. Mount the CD-ROM by entering the MOUNT command in the following format: MOUNT device-name: volume-label OpenVMS Alpha Online Documentation Library 3-1 OpenVMS Alpha Online Documentation Library 3.2 Mounting and Controlling Access to a CD-ROM For example: $ MOUNT DKA400: AXPDOCJAN941 3.3 Enabling Access to Online Documentation Online documentation is made accessible either through individual product licenses, which must be registered and loaded, or through the use of the BOOKBROWSER.COM command procedure. If a software product is registered by means of a Product Authorization Key (PAK), you do not need to enable the online documentation; the product's online documentation is already accessible. If a software product is not registered (no PAK has been installed), execute BOOKBROWSER.COM as described in Section 3.3.1 to access the product's online documentation. Online documentation is provided as is and is not covered by other Digital warranties. 3.3.1 Executing BOOKBROWSER.COM The BOOKBROWSER.COM command procedure registers the Bookbrowser PAK on your system and loads the appropriate information into your system's software license database. Executing BOOKBROWSER.COM provides you with access to all documents contained on this CD-ROM at no additional cost. To execute BOOKBROWSER.COM, complete the following procedure: 1. Mount the CD-ROM containing the online documentation you want to read (see Section 3.2). 2. Execute BOOKBROWSER.COM by entering a DCL command in the following format: @device-name:[DECW$BOOK]BOOKBROWSER.COM where: device-name is the name of the device on which you have mounted the CD-ROM. For example: $ @DKA400:[DECW$BOOK]BOOKBROWSER.COM 3-2 OpenVMS Alpha Online Documentation Library OpenVMS Alpha Online Documentation Library 3.3 Enabling Access to Online Documentation 3.3.2 Providing Clusterwide Access to Online Documentation Once you have run BOOKBROWSER.COM, you can provide clusterwide access to the online documentation CD-ROMs in one of two ways: o Reboot the cluster o Invoke the OpenVMS System Management Utility (SYSMAN) Both methods load the Bookbrowser PAK into the clusterwide license database, but SYSMAN does this without requiring you to reboot the cluster. To load the Bookbrowser PAK into the clusterwide license database, complete the following procedure: 1. Log in to the SYSTEM account. 2. Enter the following commands: $ RUN SYS$SYSTEM:SYSMAN SYSMAN> SET ENVIRONMENT/CLUSTER SYSMAN> DO LICENSE LOAD BOOKBROWSER SYSMAN> EXIT The Bookbrowser PAK is loaded into the clusterwide license database. 3.4 Reading Books on the CD-ROM This section describes how to read books on the OpenVMS Alpha Online Documentation Library CD-ROMs. 3.4.1 Redefining DECW$BOOK During installation, the DECwindows software automatically creates a library directory for Bookreader on your system disk. The DECwindows software also defines the logical name DECW$BOOK to refer to this directory. When you invoke Bookreader, it reads the library file in the directory defined by DECW$BOOK. To read Bookreader files on the OpenVMS Alpha Online Documentation Library CD-ROMs, you must redefine the DECW$BOOK logical name to refer to the directory [DECW$BOOK] on the CD-ROMs. OpenVMS Alpha Online Documentation Library 3-3 OpenVMS Alpha Online Documentation Library 3.4 Reading Books on the CD-ROM Use a command in the following format to redefine the DECW$BOOK logical name to refer to the [DECW$BOOK] directory on the CD-ROM: DEFINE/SYSTEM DECW$BOOK device-name:[DECW$BOOK] where: device-name is the name of the device where the Online Documentation Library CD-ROM is mounted. For example: $ DEFINE/SYSTEM DECW$BOOK DKA400:[DECW$BOOK] 3.4.2 Defining DECW$BOOKSHELF You can also define the DECW$BOOKSHELF logical name to direct Bookreader to a file on the CD-ROM that contains another structured library. To define the DECW$BOOKSHELF logical name, use a command in one of the following formats. Substitute the name of the device where you have mounted the Online Documentation Library CD-ROM for device-name. Also, be sure the file name contains the semicolon (;) as shown. o To display a library in which documentation is organized into categories: DEFINE/SYSTEM DECW$BOOKSHELF device-name:[DECW$BOOK]LIBRARY.DECW$BOOKSHELF; For example: $ DEFINE/SYSTEM DECW$BOOKSHELF DKA400:[DECW$BOOK]LIBRARY.DECW$BOOKSHELF; o To display a library in which documentation is organized alphabetically: DEFINE/SYSTEM DECW$BOOKSHELF device-name:[DECW$BOOK]DMASTER.DECW$BOOKSHELF; For example: $ DEFINE/SYSTEM DECW$BOOKSHELF DKA400:[DECW$BOOK]DMASTER.DECW$BOOKSHELF; If you do not define DECW$BOOKSHELF, Bookreader displays the default library defined by DECW$BOOK. 3-4 OpenVMS Alpha Online Documentation Library OpenVMS Alpha Online Documentation Library 3.4 Reading Books on the CD-ROM 3.4.3 Accessing CD-ROMs Simultaneously To access books on multiple CD-ROMs, you must define DECW$BOOK to point to multiple devices and define DECW$BOOKSHELF to point to the library structure of your choice. Because all bookshelf files are on all CD-ROMs, you can define DECW$BOOKSHELF to point to the LIBRARY.DECW$BOOKSHELF on CD-ROM 1. To access books on multiple CD-ROMs: 1. Define DECW$BOOK using a command in the following format: DEFINE/SYSTEM DECW$BOOK device-name1:[DECW$BOOK],device-name2:[DECW$BOOK],- _device-name3:[DECW$BOOK] For example: $ DEFINE/SYSTEM DECW$BOOK DKA200:[DECW$BOOK],DKA300:[DECW$BOOK],- _$ DKA400:[DECW$BOOK] 2. Define DECW$BOOKSHELF, using a command in the following format. Make sure the file name contains the semicolon as shown. DEFINE/SYSTEM DECW$BOOKSHELF device-name1:[DECW$BOOK]LIBRARY.DECW$BOOKSHELF; For example: $ DEFINE/SYSTEM DECW$BOOKSHELF DKA400:[DECW$BOOK]LIBRARY.DECW$BOOKSHELF; 3. If you invoked Bookreader before you defined the logical names, exit from Bookreader and invoke it again. 3.4.4 Making a CD-ROM the Default Library To define a CD-ROM as the default library, add a command line defining DECW$BOOK to your startup command procedure located in SYS$MANAGER. Add a line in the following format: DEFINE/SYSTEM DECW$BOOK device-name:[DECW$BOOK] For example, the following command line establishes the CD-ROM mounted on DKA400 as the library from which books will be read each time you start up the system: $ DEFINE/SYSTEM DECW$BOOK DKA400:[DECW$BOOK] OpenVMS Alpha Online Documentation Library 3-5 OpenVMS Alpha Online Documentation Library 3.4 Reading Books on the CD-ROM 3.4.5 Running Bookreader To run Bookreader, choose Bookreader from the Applications menu on your Session Manager menu. If you are not familiar with Bookreader, see Section 1.2 for some introductory instructions on its use. 3.5 Printing a Listing of Products The following files are available in the [README] directory on the first CD-ROM: o CDMASTER_INDEX.PS (.TXT) A printable version of the OpenVMS Alpha Online Documentation Library Master Index, which provides a listing of all the products in this release o USER_GUIDE.PS (.TXT) A printable version of the Online Documentation Library CD-ROM User's Guide (this guide) To print a hardcopy listing (in ASCII or PostScript format) of either of these files, enter a command in one of the following formats: PRINT/QUEUE=queue-name device-name:[README]file-name.TXT PRINT/QUEUE=queue-name device-name:[README]file-name.PS For example: $ PRINT/QUEUE=VAX_ANSI DKA400:[README]CDMASTER_INDEX.TXT $ PRINT/QUEUE=AXP_POST DKA400:[README]USER_GUIDE.PS 3-6 OpenVMS Alpha Online Documentation Library 4 _________________________________________________________________ Digital UNIX Online Documentation Library This chapter describes how to use the Digital UNIX Online Documentation Library CD-ROMs. 4.1 Required Environment To read online documentation, you must have the following environment: o Bookreader software. Bookreader is packaged with DECwindows Motif, which is part of the Digital UNIX operating system environment. o A bitmap DECwindows display (a workstation, or a personal computer using PATHWORKS software). o A CD-ROM reader. Alpha hardware systems are shipped with a CD-ROM reader. 4.2 Mounting and Controlling Access to a CD-ROM To access the files on a Digital UNIX Software Product Library CD-ROM, mount the CD-ROM using the following procedure: 1. Load the CD-ROM into a protective caddy. 2. Insert the caddy into the drive. 3. Log in as root or become superuser: % su Password: 4. If you do not know the device name for the CD-ROM drive, use the following command to find it. # file /dev/rrz*c Digital UNIX Online Documentation Library 4-1 Digital UNIX Online Documentation Library 4.2 Mounting and Controlling Access to a CD-ROM The file command returns output similar to that shown in the following example. Note that the entry for the disc drive includes the words RRD42 disk. /dev/rrz1c: character special (8/1740) SCSI #1 RRD42 disk #12 (SCSI ID #1) /dev/rrz2c: character special (8/2050) SCSI #0 RRD42 disk #16 (SCSI ID #2) /dev/rrz3c: character special (8/3074) SCSI #0 RZ25 disk #24 (SCSI ID #3) /dev/rrz4c: character special (8/4098) SCSI #0 RRD42 disk #32 (SCSI ID #4) /dev/rrz8c: character special (8/16386) SCSI #1 RZ56 disk #64 (SCSI ID #0) 5. Create a directory that will be the mount point for the CD-ROM, using a command in the following format: mkdir /mount-point For example: # mkdir /cdrom If you are going to mount multiple CD-ROMs, create multiple mount points using the mkdir command. 6. Mount the CD-ROM using the -dr or -r option to indicate that the CD-ROM is read-only. o Use the -dr command if you are using a version of the operating system lower than Version 1.3. o Use the -r option if your operating system is Version 1.3 or higher. Use a command in the following format: mount -dr /dev/rzunit-numberc /mount-point where: unit-number is the unit number of your disc drive and mount-point is the mount point you have just created. In the following examples, /cdrom is the mount point for a single CD-ROM, while /cdrom-disc1 and /cdrom-disc2 are mount points for multiple CD-ROMs. o For a single CD-ROM, use a command similar to the following: # mount -dr /dev/rz2c /cdrom 4-2 Digital UNIX Online Documentation Library Digital UNIX Online Documentation Library 4.2 Mounting and Controlling Access to a CD-ROM o For multiple CD-ROMs, use commands similar to the following: # mount -dr /dev/rz1c /cdrom-disc1 # mount -dr /dev/rz2c /cdrom-disc2 7. To dismount a CD-ROM, use a command in one of the following formats: # umount /dev/rz4c or # /sbin/umount /dev/rz4c 8. To ensure that a CD-ROM is remounted in the event that your system crashes or is rebooted, follow these steps: a. Using the text editor of your choice, open the file /sbin/bcheckrc and search for the following section: # # mount local (non-nfs) filesystems # echo 'Mounting local filesystems' /sbin/mount -a -v -t nonfs b. To ensure that your CD-ROM will be mounted at system startup, add the following lines after the mount local section, replacing device_number with the actual device number of your disc drive, and mount_point with the directory on which you mounted the CD-ROM. # # mount CD # echo 'Mounting CDROM' /sbin/mount -dr /dev/rzdevice-numberc /mount-point The system will mount the CD-ROM on the mount point you specify on every reboot. Digital UNIX Online Documentation Library 4-3 Digital UNIX Online Documentation Library 4.3 Enabling Access to Online Documentation 4.3 Enabling Access to Online Documentation Online documentation is made accessible either through individual product licenses, which must be registered and loaded, or through the use of the bookbrowser shell script. If a software product is registered by means of a Product Authorization Key (PAK), you do not need to enable the online documentation; the product's online documentation is already accessible. If a software product is not registered (no PAK has been installed), run the the bookbrowser script described in Section 4.3.1 to access the product's online documentation. Online documentation is provided as is and is not covered by other Digital warranties. 4.3.1 Registering Bookbrowser The bookbrowser shell script registers the BOOKBROWSER PAK on your system and loads the appropriate information into your system's software license database. Running bookbrowser provides you with access to all the documents on the CD-ROMs at no additional cost. To register and load the BOOKBROWSER PAK, complete the following procedure: 1. Log in as root or become superuser. 2. Mount the first CD-ROM, which contains bookbrowser (see Section 4.2). 3. Run the bookbrowser script by entering a command in the following format: /mount-point/decw_book/bookbrowser where: mount-point is the directory where the CD-ROM is mounted. For example: # /cdrom/decw_book/bookbrowser 4-4 Digital UNIX Online Documentation Library Digital UNIX Online Documentation Library 4.4 Reading Books on the CD-ROMs 4.4 Reading Books on the CD-ROMs This section describes how to read books on the Digital UNIX Online Documentation Library CD-ROMs. 4.4.1 Specifying Bookreader Libraries When you first run Bookreader, a Library window appears on your screen, displaying the top-level Bookreader library. This library is displayed by the environment variables DECW_BOOK and DECW_BOOKSHELF, which point to a default bookshelf. DECW_BOOK specifies the search path for book and bookshelf files. If DECW_BOOK is not set, Bookreader looks for book and bookshelf files in /usr/lib/dxbook. DECW_BOOKSHELF specifies the bookshelf file to be read by the Bookreader. If DECW_BOOKSHELF is not set, Bookreader looks for a bookshelf file named library.decw_bookshelf. These defaults are equivalent to issuing the following command: # dxbook /usr/lib/dxbook/decw_book/library.decw_bookshelf You can override these defaults in two ways: o When you start Bookreader, you can specify the path name and bookshelf file explicitly, using the bookshelf argument on the command line. To specify a library using the command line, enter command in the following to format: dxbook /mount-point/decw_book/shelf-name where: mount-point is the directory where the library is mounted and shelf-name is the name of the bookshelf. For example, the following command tells Bookreader to open the bookshelf newbooks.decw_bookshelf in the cdrom directory: # dxbook /cdrom/decw_book/newbooks.decw_bookshelf Digital UNIX Online Documentation Library 4-5 Digital UNIX Online Documentation Library 4.4 Reading Books on the CD-ROMs o The environment variables allow you to have Bookreader recognize additional books or bookshelf files by specifying more than one path name. For example, you can have the default bookshelf and books in /usr/lib/dxbook and another bookshelf with its books in /cdrom. You set DECW_BOOK to specify both path names. For example: # setenv DECW_BOOK "/usr/lib/dxbook /cdrom" The titles from both directories appear in the Library window when you run Bookreader. 4.4.2 Accessing Bookreader Documentation from a Server To make the Bookreader documentation on the CD-ROM accessible from a server, you must export the Bookreader files to a workstation running DEC OSF/1 Version 1.3 or higher. The following steps assume that the server is set up to export files using Network File System (NFS). For further information, refer to the nfssetup reference page of the Digital UNIX manual, Network Configuration. To export the Bookreader files to a workstation, follow these steps. On the server system: 1. Log in as root or become superuser. 2. Ensure that the CD-ROM is mounted (see Section 4.2). This example assumes that the server system has mounted the CD-ROM on the directory /cdrom. 3. Using the text editor of your choice, place an entry in the /etc/exports file for the /cdrom directory and make sure that you specify the -ro option for a read-only export, as follows: /cdrom -ro On the client system: 1. Log in as root or become superuser. 2. Run nfssetup and import the /cdrom directory from the server as a read-only file system. 4-6 Digital UNIX Online Documentation Library Digital UNIX Online Documentation Library 4.4 Reading Books on the CD-ROMs 3. When nfssetup is done, mount the /cdrom directory by entering the following command: # mount /cdrom 4.4.3 Running Bookreader To run Bookreader, do one of the following: o Choose Bookreader from the Applications menu on your Session Manager menu. o Enter the following command from the shell prompt: # dxbook & If you are not familiar with Bookreader, see Section 1.2 for introductory instructions on its use. 4.5 Printing a Listing of Products The following files are available in the /readme directory on the first CD-ROM: o cdmaster_index.ps (.txt) A printable version of the Digital UNIX Online Documentation Library Master Index, which provides a listing of all the products in this release o user_guide.ps (.txt) A printable version of the Online Documentation Library CD-ROM User's Guide (this guide) To print a hardcopy listing (in ASCII or PostScript format) of either of these files, enter a command in one of the following formats: lpr -Pqueue-name /mount-point/readme/file-name.txt lpr -Pqueue-name /mount-point/readme/file-name.ps For example: % lpr -Punix_ansi /cdrom/readme/cdmaster_index.txt % lpr -Punix_post /cdrom/readme/user_guide.ps Digital UNIX Online Documentation Library 4-7 5 _________________________________________________________________ ULTRIX Online Documentation Library This chapter describes how to use the ULTRIX Online Documentation Library CD-ROMs. 5.1 Required Environment To read online documentation, you must have the following environment: o Bookreader software. Bookreader is packaged with DECwindows on ULTRIX, which is installed as part of ULTRIX Workstation Software (UWS). o A workstation with a VAX family or RISC-based processor and bitmap display. You can use a standalone workstation or a workstation being served from a file server. o A CD-ROM reader. 5.2 Mounting and Controlling Access to a CD-ROM To access the files on an ULTRIX Software Product Library CD-ROM, mount the CD-ROM using the following procedure: 1. Load the CD-ROM into a protective caddy. 2. Insert the caddy into the drive. 3. Log in as root or become superuser: % su Password: 4. If you do not know the device name for the disc drive, use the following command to find it: # file /dev/rrz*c ULTRIX Online Documentation Library 5-1 ULTRIX Online Documentation Library 5.2 Mounting and Controlling Access to a CD-ROM The file command returns output similar to that shown in the following example. Note that the entry for the disc drive includes the words RRD42 disk. /dev/rrz1c: character special (8/1740) SCSI #1 RRD42 disk #12 (SCSI ID #1) /dev/rrz2c: character special (8/2050) SCSI #0 RRD42 disk #16 (SCSI ID #2) /dev/rrz3c: character special (8/3074) SCSI #0 RZ25 disk #24 (SCSI ID #3) /dev/rrz4c: character special (8/4098) SCSI #0 RRD42 disk #32 (SCSI ID #4) /dev/rrz8c: character special (8/16386) SCSI #1 RZ56 disk #64 (SCSI ID #0) 5. Create a directory that will be the mount point for the CD-ROM, using a command in the following format: mkdir /mount-point For example: # mkdir /cdrom If you are going to mount multiple CD-ROMs, create multiple mount points using the mkdir command. 6. Mount the CD-ROM using the -r option to indicate that the CD-ROM is read-only; use a command in the following format: mount -r /dev/rzunit-numberc /mount-point where: unit-number is the unit number of your disc drive and mount-point is the mount point you have just created. In the following examples, /cdrom is the mount point for a single CD-ROM, while /cdrom-disc1 and /cdrom-disc2 are mount points for multiple CD-ROMs. o For a single CD-ROM, use a command similar to the following: # mount -r /dev/rz2c /cdrom o For multiple CD-ROMs, use commands similar to the following: # mount -r /dev/rz1c /cdrom-disc1 # mount -r /dev/rz2c /cdrom-disc2 5-2 ULTRIX Online Documentation Library ULTRIX Online Documentation Library 5.2 Mounting and Controlling Access to a CD-ROM 7. To dismount a CD-ROM, use a command similar to one of the following: # umount /cdrom or # /etc/umount /dev/rz4c 8. To ensure that the CD-ROM is remounted if your system crashes or is rebooted, open the /etc/fstab file. Using the text editor of your choice, add a line to this file containing the following information. See the file /usr/include/fstab.h for a description of each field. spec:file:type:freq:passno:name:opts For example: /dev/rz4c:/cdrom:ro:0:0:ufs:: The system will now mount the CD-ROM on /cdrom on every reboot. 5.3 Enabling Access to Online Documentation Online documentation is made accessible either through individual product licenses, which must be registered and loaded, or through the use of the bookbrowser shell script. If a software product is registered by means of a Product Authorization Key (PAK), you do not need to enable the online documentation; the product's online documentation is already accessible. If a software product is not registered (no PAK has been installed), run the the bookbrowser script described in Section 5.3.1 to access the product's online documentation. Online documentation is provided as is and is not covered by other Digital warranties. ULTRIX Online Documentation Library 5-3 ULTRIX Online Documentation Library 5.3 Enabling Access to Online Documentation 5.3.1 Registering Bookbrowser The bookbrowser shell script registers the BOOKBROWSER PAK on your system and loads the appropriate information into your system's software license database. Running bookbrowser provides you with access to all the documents on the CD-ROMs at no additional cost. To register and load the BOOKBROWSER PAK, complete the following procedure: 1. Log in as root or become superuser. 2. Mount the first CD-ROM (which contains bookbrowser) (see Section 5.2). 3. Run the bookbrowser script by entering a command in the following format: /mount-point/decw_book/bookbrowser where: mount-point is the directory where the CD-ROM is mounted. For example: # /cdrom/decw_book/bookbrowser 5.4 Reading Books on the CD-ROMs This section describes how to read books on the ULTRIX Online Documentation Library CD-ROMs. 5.4.1 Specifying Bookreader Libraries When you first run Bookreader, a Library window appears on your screen, displaying the top-level Bookreader library. This library is displayed by the environment variables DECW_BOOK and DECW_BOOKSHELF, which point to a default bookshelf. DECW_BOOK specifies the search path for book and bookshelf files. If DECW_BOOK is not set, Bookreader looks for book and bookshelf files in /usr/lib/dxbook. DECW_BOOKSHELF specifies the bookshelf file to be read by the Bookreader. If DECW_BOOKSHELF is not set, Bookreader looks for a bookshelf file named library.decw_bookshelf. 5-4 ULTRIX Online Documentation Library ULTRIX Online Documentation Library 5.4 Reading Books on the CD-ROMs These defaults are equivalent to issuing the following command: # dxbook /usr/lib/dxbook/decw_book/library.decw_bookshelf You can override these defaults in two ways: o When you start Bookreader, you can specify the path name and bookshelf file explicitly, using the bookshelf argument on the command line. To specify a library using the command line, enter command in the following to format: dxbook /mount-point/decw_book/shelf-name where: mount-point is the directory where the library is mounted and shelf-name is the name of the bookshelf. For example, the following command tells Bookreader to open the bookshelf newbooks.decw_bookshelf in the cdrom directory: # dxbook /cdrom/decw_book/newbooks.decw_bookshelf o The environment variables allow you to have Bookreader recognize additional books or bookshelf files by specifying more than one path name. For example, you can have the default bookshelf and books in /usr/lib/dxbook and another bookshelf with its books in /cdrom. You set DECW_BOOK to specify both path names. - If you are using the C shell, place a command in the following format in .login or .cshrc: setenv DECW_BOOK "/mount-point1/decw_book mount-point2/decw_book" For example: setenv DECW_BOOK "/usr/lib/dxbook/decw_book /cdrom/decw_book" - If you are using the Bourne shell or System V shell, place commands in the following format in .profile: DECW_BOOK="/mount-point1/decw_book mount-point2/decw_book" export DECW_BOOK ULTRIX Online Documentation Library 5-5 ULTRIX Online Documentation Library 5.4 Reading Books on the CD-ROMs For example: DECW_BOOK="/usr/lib/dxbook/decw_book /cdrom/decw_book" export DECW_BOOK The titles from both directories appear in the Library window when you run Bookreader. 5.4.2 Accessing Bookreader Documentation from a Server To make the Bookreader documentation on the CD-ROM accessible from a server, you must export the Bookreader files to a workstation running either ULTRIX Version 4.2 (or higher) or DEC OSF/1 Version 1.3 or higher. The following steps assume that the server is set up to export files using Network File System (NFS). For further information, refer to the nfssetup(8) reference page of the Digital UNIX manual, Network Configuration. To export the Bookreader files to a workstation, follow these steps. On the server system: 1. Log in as root or become superuser. 2. Ensure that the CD-ROM is mounted (see Section 5.2). This example assumes that the server system has mounted the CD-ROM on the directory /cdrom. 3. Using the text editor of your choice, place an entry in the /etc/exports file for the /cdrom directory and make sure that you specify the -ro option for a read-only export, as follows: /cdrom -ro On the client system: 1. Log in as root or become superuser. 2. Run nfssetup and import the /cdrom directory from the server as a read-only file system. 3. When nfssetup is done, mount the /cdrom directory by entering the following command: # mount /cdrom 5-6 ULTRIX Online Documentation Library ULTRIX Online Documentation Library 5.4 Reading Books on the CD-ROMs 5.4.3 Running Bookreader To run Bookreader, do one of the following: o Choose Bookreader from the Applications menu on your Session Manager menu. o Enter the following command from the shell prompt: # dxbook & If you are not familiar with Bookreader, see Section 1.2 for introductory instructions on its use. 5.5 Printing a Listing of Products The following files are available in the /readme directory on the first CD-ROM: o cdmaster_index.ps (.txt) A printable version of the ULTRIX Online Documentation Library Master Index, which provides a listing of all the products in this release o user_guide.ps (.txt) A printable version of the Online Documentation Library CD-ROM User's Guide (this guide) To print a hardcopy listing (in ASCII or PostScript format) of either of these files, enter a command in one of the following formats: lpr -Pqueue-name /mount-point/readme/file-name.txt lpr -Pqueue-name /mount-point/readme/file-name.ps For example: % lpr -Pult_ansi /cdrom/readme/cdmaster_index.txt % lpr -Pult_post /cdrom/readme/user_guide.ps ULTRIX Online Documentation Library 5-7 _________________________________________________________________ Index A______________________________ C______________________________ Access CD-ROMs clusterwide controlling access on OpenVMS Alpha, 3-3 on Digital UNIX, 4-1 on OpenVMS VAX, 2-3 on OpenVMS Alpha, 3-1 enabling on OpenVMS VAX, 2-1 on Digital UNIX, 4-4 on ULTRIX, 5-1 on OpenVMS Alpha, 3-2 handling, 1-1 on OpenVMS VAX, 2-2 mounting on ULTRIX, 5-3 on Digital UNIX, 4-1 simultaneous on OpenVMS Alpha, 3-1 on OpenVMS Alpha, 3-5 on OpenVMS VAX, 2-1 on OpenVMS VAX, 2-5 on ULTRIX, 5-1 B CDs _______________________________ See CD-ROMs Bookbrowser PAK Compact discs registering See CD-ROMs on OpenVMS Alpha, 3-2 on OpenVMS VAX, 2-2 D bookbrowser shell script _______________________________ registering DECW$BOOK on Digital UNIX, 4-4 redefining on ULTRIX, 5-4 on OpenVMS Alpha, 3-3 BOOKBROWSER.COM on OpenVMS VAX, 2-3 on OpenVMS Alpha, 3-2 DECW$BOOKSHELF on OpenVMS VAX, 2-2 redefining Bookreader on OpenVMS Alpha, 3-4 libraries on OpenVMS VAX, 2-4 on Digital UNIX, 4-5 DECW_BOOK on OpenVMS Alpha, 3-3 redefining on ULTRIX, 5-4 on Digital UNIX, 4-5 OpenVMS VAX, 2-3 on ULTRIX, 5-5 using, 1-2 Index-1 DECW_BOOKSHELF Mounting CD-ROMs redefining on Digital UNIX, 4-1 on Digital UNIX, 4-5 on OpenVMS Alpha, 3-1 on ULTRIX, 5-5 on OpenVMS VAX, 2-1 Documentation on ULTRIX, 5-1 ordering, vi MUPs ordering, vi E______________________________ ECOs O______________________________ ordering, vi Ordering Engineering Change Orders documentation, vi See ECOs ECOs and MUPs, vi products, vi H______________________________ P Hardware required _______________________________ on Digital UNIX, 4-1 Printing on OpenVMS Alpha, 3-1 Digital UNIX Master Index, on OpenVMS VAX, 2-1 4-7 on ULTRIX, 5-1 OpenVMS Alpha Master Index, 3-6 I______________________________ OpenVMS VAX Master Index, Internet account 2-6 for providing feedback, vi ULTRIX Master Index, 5-7 L S______________________________ _______________________________ Software required Library on Digital UNIX, 4-1 default on OpenVMS Alpha, 3-1 on Digital UNIX, 4-5 on OpenVMS VAX, 2-1 on OpenVMS Alpha, 3-3, on ULTRIX, 5-1 3-5 SYSMAN utility on OpenVMS VAX, 2-3, 2-5 on OpenVMS Alpha, 3-3 on ULTRIX, 5-4 on OpenVMS VAX, 2-3 M______________________________ V______________________________ Mandatory updates VAXcluster See MUPs online documentation access, Master index 2-3, 3-3 on Digital UNIX, 4-7 on OpenVMS Alpha, 3-6 on OpenVMS VAX, 2-6 on ULTRIX, 5-7 Index-2