8    Using Online Documentation

The online documentation set is available in both Hypertext Markup Language (HTML) and Portable Document Format (PDF) versions.

• You can use the Netscape Navigator^® application to view HTML or PDF versions of the documentation. This version of the operating system is shipped with Netscape Communicator 4.5, which includes Netscape Navigator. The Netscape software subset is installed automatically if the installation process detects graphics capability on your system.

  After installing the operating system, you can invoke Netscape through the CDE front panel or from the command line in a terminal emulator window. Detailed help for Netscape is available through the Help menu.

• You can use the Adobe^® Acrobat^® Reader application to view PDF versions of the documentation.

  After installing the operating system, you can invoke Acrobat Reader either as a Netscape helper application or from the command line in a terminal emulator window. Detailed help for Acrobat Reader is available through the Help menu.

  Refer to the Adobe Acrobat Reader Online Guide for information about setting up Netscape Navigator to view PDF files. You can access this document from the Acrobat Reader Help menu.

Caution

You must configure the ISO 9660 Compact Disc File System (CDFS) kernel option and reboot your system before you can mount the online documentation set on your CD-ROM drive. Refer to Section 5.20 and the doconfig(8) reference page for information about configuring kernel options.

The goal of this chapter is to provide the information necessary for you to perform the user actions shown in Table 8-1.

Table 8-1:  Summary of User Actions

8.1    Mounting the Documentation Set CD-ROM

To mount the operating system documentation CD-ROM so that you can view the online documentation set with Netscape Navigator or Acrobat Reader, follow these steps:

1. Log in as root or use the su command to gain root privileges.

2. Verify the existence of the directory /usr/share/doclib/online. If it does not exist, create it with the following command:

   
# mkdir -p /usr/share/doclib/online
   

3. Insert the Volume 1 of the documentation CD-ROM in your system's CD-ROM drive.

   If you do not know the system device name of your CD-ROM drive, log in as root or use the su command to gain root privileges, and enter the following command:

   # file /dev/rrz*c | grep RRD
   /dev/rrz4c: character special (8/4098) SCSI #0 RRD44 disk #32 (SCSI ID #4)
   

   In this example, the CD-ROM device is RRD44 on device /dev/rz4c. If you have more than one RRD device connected to your system, determine the device where you will mount the CD-ROM.

   Note

   You must have root privileges to get this information with the file command.

   Standard device names begin with rz for the block special file and rrz for the raw (character) special file. The result of the file command displays the raw device name, but you must specify the block special file when mounting the CD-ROM device. In this example, the displayed device name is /dev/rrz4c, but you will use /dev/rz4c.

4. Use the mount command to mount the CDE document set.

   Caution

   The result of the command in the previous step displays the raw device name (rrz*), but you must specify the block special file (rz*) when you mount the CD-ROM device.

   For example, if your CD-ROM device is rz4c, you would use this command to mount the CD-ROM on /usr/share/doclib/online:

   
# mount -r -t cdfs -o rrip /dev/rz4c /usr/share/doclib/online
   

8.2    Viewing Online Documents with Netscape

To view the online documentation set with Netscape Navigator, follow these steps:

1. Mount the operating system documentation CD-ROM as described in Section 8.1.

2. Start Netscape Navigator by using one of the following methods:

   • From the CDE desktop:

     1. Click on the arrow above the Text Editor icon on the CDE Front Panel to display the Personal Applications subpanel.

     2. Click on the Netscape icon.

   • From a terminal emulator window, enter the following command to run Netscape Navigator in the background:

     
$ /usr/bin/X11/netscape &
     

     Refer to the netscape(1) reference page for additional information.

3. Click on the Home icon button to access the default home page at /usr/doc/netscape/Digital_UNIX.html. This page includes links to other documentation, including a local copy of the Netscape Navigator Online Handbook that you can access from the Other documentation link.

4. Select the operating system Documentation link to go to the operating system Documentation page.

5. Select one of the available document categories to see a list of those documents, including links to HTML and PDF versions.

Proceed to Section 8.4 to install Acrobat Reader. The Adobe Acrobat Reader Online Guide, available from the Acrobat Reader Help menu, provides information about setting up Netscape Navigator to view PDF files.

8.3    Netscape Application Integration

The following information is provided to help you when you use Netscape applications on this operating system:

• A sample resource defaults file for Netscape Communicator can be found at /usr/doc/netscape/Netscape.ad. Comments within this file indicate possible settings for each resource. This file is provided for informational purposes and need not be installed.

• The file /usr/bin/X11/netscape is actually a shell script that performs the following actions:

  • Creates a Communicator user configuration directory if $HOME/.netscape does not already exist. If you have a file or directory in $HOME called .netscape, it is highly recommended that you rename it prior to running this version. If you do not, there is a possibility that you could lose data contained in this directory such as old preferences, bookmarks, and cookies.

  • Copies the Navigator preferences file from /usr/doc/netscape/default-netscape-preferences to $HOME/.netscape/preferences.js if it does not already exist in the $HOME directory.

  • Sets the MOZILLA_HOME environment variable to point to the Communicator installation directory /usr/lib/netscape. The Communicator Java^TM class files, nethelp files, plugins, registry, and others are all installed under this directory. See the /usr/lib/netscape/README file for more information on MOZILLA_HOME and other environment variables.

  • Invokes the actual Communicator binary at /usr/bin/X11/real-netscape.

  This information may be important to know if you should download newer copies of Navigator from other sources (for example, the Netscape web site) and install the files from those kits over the links in $HOME/.netscape. If you want to use the previous version, you need to remove these files so that the /usr/bin/X11/netscape script is able to recreate the symbolic links listed above that point to the older versions of these files.

  Also, if you choose to run a version of Navigator directly (that is, not through the /usr/bin/X11/netscape script), you should first set the value of the LD_LIBRARY_PATH environment variable to /usr/lib/netscape to ensure the proper functioning of Java applets.

8.4    Installing Acrobat Reader

The PDF versions of the online documents are best viewed by using Acrobat Reader as a Netscape Navigator helper application. This section tells you how to install Acrobat Reader on your system.

To install Acrobat Reader on your system, follow these steps:

1. Log in as root or use the su command to gain root privileges.

2. Mount the operating system documentation CD-ROM as described in Section 8.1.

3. Change directory to /usr/share/doclib/online/ACROREAD/DIG_UNIX. The 00README.TXT file explains how to uncompress the ACROREAD.Z installation file.

4. Enter the following command to uncompress the installation file:

   
% uncompress -c ACROREAD.Z > /tmp/acroread_osf_301.tar
   

5. Change directory to /tmp:

   
% cd /tmp
   

6. Enter the following command to unpack the installation files:

   
% tar xf /tmp/acroread_osf_301.tar
   

   Detailed instructions in the INSTGUID.TXT file explain how to run the INSTALL script.

7. Enter the following command to run the Acrobat Reader installation script:

   % ./INSTALL
   

8. After you read the license agreement, enter accept to accept the license terms and continue.

9. Select an installation directory for Acrobat Reader. The default is /usr/local/Acrobat3.

   Caution

   Acrobat Reader requires 1 Mb of free disk space. Ensure that the file system where you install Acrobat Reader has sufficient space for the application.

   If necessary you are prompted to allow the installation script to create the installation directory.

10. The application installation completes and you see the command line prompt.

The Adobe Acrobat Reader Online Guide, available from the Acrobat Reader Help menu, provides information about setting up Netscape Navigator to view PDF files.

8.5    Viewing Online Documents with Acrobat

The PDF versions of the online documents are best viewed by using Acrobat Reader as a Netscape Navigator helper application. You can, however, view them directly with Acrobat Reader. You should review the 00README.TXT file in the ACRO_DUX and ACRO_SUP subdirectories under the /usr/share/doclib/online/DOCS directory. These files map file names to document names so that you can locate specific documents.

To view the online documentation set with Acrobat Reader, follow these steps:

1. Mount the documentation CD-ROM as described in Section 8.1.

2. Install Acrobat Reader as described in Section 8.4.

3. From a terminal emulator window, enter the following command to run Acrobat Reader in the background:

   $ /usr/local/Acrobat3/bin/acroread &
   

   Refer to the Adobe Acrobat Reader Online Guide, available from the Help menu, for information on how to use Acrobat Reader.

4. Select Open... from the File menu. This displays the Open dialog box, where you can select a PDF file.

   The PDF documents reside under the DOCS directory on the documentation CD-ROM.

   • The ACRO_DUX subdirectory includes the base operating system documentation set.

   • The ACRO_SUP subdirectory includes the supplementary documentation set.

   The 00README.TXT file in both subdirectories maps file names to document names so that you can locate specific documents.

   Note

   You cannot use Acrobat Reader to view text files.

Refer to Section 8.6 for instructions on copying online documentation to your system.

8.6    Copying Online Documentation to Disk

Instead of reading the online documentation set from the CD-ROM, you can copy the documentation files to a disk on your system. Copying the document files to a disk eliminates the need to keep the CD-ROM permanently mounted. The entire set of online documentation files consumes about 135 Mb of disk space.

Follow these procedures to copy the documentation files to a disk on your system. Use the same directories shown in the examples so you will not have to modify library bookshelf files.

1. Log in as root or use the su command to become superuser.

2. Ensure that the Volume 1 of the Documentation CD-ROM is mounted on /mnt. Refer to Appendix B if you do not know how to mount the CD-ROM.

3. Enter commands similar to the following examples to copy the online documents from the CD-ROM to the appropriate subdirectories in the /usr/share/doclib/online/DOCS directory. This example illustrates the process with the CD-ROM mounted on the directory /mnt.

   • To copy the online documentation set HTML files, enter the following:

     
# cd /mnt/DOCS/HTML
# tar chpvf - . |\
    (cd /usr/share/doclib/online/DOCS/HTML;tar xvpf -)
     

     The online documentation set HTML files take up about 155 Mb of disk space.

   • To copy the base operating system online documentation set PDF files, enter the following:

     # cd /mnt/DOCS/ACRO_DUX
# tar chpvf - . |\
    (cd /usr/share/doclib/online/DOCS/ACRO_DUX;tar xvpf -)
     

     The base operating system online documentation set PDF files take up about 35 Mb of disk space.

   • To copy the supplemental online documentation set PDF files, enter the following:

     # cd /mnt/DOCS/ACRO_SUP
# tar chpvf - . |\
    (cd /usr/share/doclib/online/DOCS/ACRO_SUP;tar xvpf -)
     

     The supplemental online documentation set PDF files take up about 15 Mb of disk space.

   Note

   The backslashes ( \ ) in the previous examples are for line continuation; you need not enter them.

4. Unmount the CD-ROM using a command similar to the following:

   # umount /dev/rz4c
   

   Refer to Appendix B if you do not know how to unmount a CD-ROM.

Follow the instructions in Section 8.2 to start Netscape Navigator or Section 8.5 to start Acrobat Reader.