sun.com | docs.sun.com | How To Buy | My Sun | Worldwide Sites |  |

| Previous Contents Index Next
Appendix B # Installing and Accessing the Documentation The documentation for the Foundation Services is provided as a set of portable document format (PDF) and hypertext markup language (HTML) files. The Foundation Services daemons, configuration files, and API are also described in a collection of man pages. You can install the documentation on the installation server or another system running the Solaris operating system. The `nhinstall` tool installs the man pages on the master-eligible nodes. To install and access the documentation, see the following sections: Installing the Documentation Packages Accessing the Documentation Accessing the Man Pages ## Installing the Documentation Packages The following table shows the documentation packages that are included in the software distribution.
Package Name | Description
--- | ---
`SUNWnhpdf` | Documentation in PDF format
`SUNWnhhtm` | Documentation in HTML format
`SUNWnhman` | Man pages
2. ### To Install the Documentation Packages As superuser, log in to the installation server or another system running the Solaris operating system. Install the documentation packages:
       # pkgadd -d /software-distribution-dir/NetraHAS2.1/Packages/ SUNWnhpdf
       # pkgadd -d /software-distribution-dir/NetraHAS2.1/Packages/ SUNWnhhtm
       # pkgadd -d /software-distribution-dir/NetraHAS2.1/Packages/ SUNWnhman
Where software-distribution-dir is the directory that contains the Foundation Services packages. ## Accessing the Documentation The Foundation Services documentation is installed in the `/opt/SUNWcgha/` directory. The documentation can be accessed by using a web browser to view the `/opt/SUNWcgha/doc/html/index.html` page. The PDF version of the documentation is installed in the `/opt/SUNWcgha/doc/pdf` directory. Access the books in PDF by using the Adobe Acrobat Reader. The HTML version of the books is installed in the `/opt/SUNWcgha/doc/html` directory. Access the documentation in HTML by using a web browser. The following books are installed in the `/opt/SUNWcgha/doc/html` and `/opt/SUNWcgha/doc/pdf` directories respectively.
Book Title | HTML Entry Point | PDF File
--- | --- | ---
Netra High Availability Suite Foundation Services 2.1 6/03 Overview | `NHASFSOVIEW/toc.html` | `NHASFSOVIEW.pdf`
Netra High Availability Suite Foundation Services 2.1 6/03 Glossary | `NHASGLOSS/toc.html` | `NHASGLOSS.pdf`
What's New in Netra High Availability Suite Foundation Services 2.1 6/03 | `NHASWNEW/toc.html` | `NHASWNEW.pdf`
Netra High Availability Suite Foundation Services 2.1 6/03 Quick Start Guide | `NHASFSQS/toc.html` | `NHASFSQS.pdf`
Netra High Availability Suite Foundation Services 2.1 6/03 Hardware Guide | `NHASFSHW/toc.html` | `NHASFSHW.pdf`
Netra High Availability Suite Foundation Services 2.1 6/03 Custom Installation Guide | `NHASFSINST/toc.html` | `NHASFSINST.pdf`
Netra High Availability Suite Foundation Services 2.1 6/03 Cluster Administration Guide | `NHASFSADMIN/toc.html` | `NHASFSADMIN.pdf`
Netra High Availability Suite Foundation Services 2.1 6/03 Troubleshooting Guide | `NHASFSTG/toc.html` | `NHASFSTG.pdf`
Netra High Availability Suite Foundation Services 2.1 6/03 CMM Programming Guide | `NHASFSAPROG/toc.html` | `NHASFSAPROG.pdf`
Netra High Availability Suite Foundation Services 2.1 6/03 NMA Programming Guide | `NHASFSNMAPROG/toc.html` | `NHASFSNMAPROG.pdf`
Netra High Availability Suite Foundation Services 2.1 6/03 Standalone CGTP Guide | `NHASCGTP/toc.html` | `NHASCGTP.pdf`
Netra High Availability Suite Foundation Services 2.1 6/03 Reference Manual | `NHASFSREFMAN/a.html` | `NHASFSREFMAN.pdf`
1. The Netra High Availability Suite Foundation Services 2.1 6/03 README and the Netra High Availability Suite Foundation Services 2.1 6/03 Release Notes are delivered as HTML files. These files are available when you download and extract the Foundation Services software distribution. ## Accessing the Man Pages The man pages are installed in the `/opt/SUNWcgha/man` directory. ### To Access the Man Pages To access the man pages from the command line, add this directory to your `MANPATH` environment variable:
       $ export MANPATH=${MANPATH}:/opt/SUNWcgha/man
2. (Optional) To permanently add the Foundation Services man pages to your `MANPATH` environment variable, add the `/opt/SUNWcgha/man` directory to your `.cshrc` or `.login` file. ### To Access Man Pages on the Master-Eligible Nodes The software package containing the online man pages is automatically installed on the master-eligible nodes when you install by using the `nhinstall` tool. To access the man pages on the master-eligible nodes, you configure the `MANPATH` on each master-eligible node. Include the Solaris operating system man pages and the Foundation Services man pages. As superuser, log in to a master-eligible node. Check the `MANPATH` environment variable:
       # echo $MANPATH

       #
3. Set the `MANPATH` to include the Solaris man pages:
       # export MANPATH=/usr/man
4. Set the `MANPATH` to include the Foundation Services man pages:
       # export MANPATH=${MANPATH}:/opt/SUNWcgha/man
5. Check the `MANPATH` environment variable:
       # echo $MANPATH
       /usr/man:/opt/SUNWcgha/man
       #
Repeat Step 1 through Step 5 on the other master-eligible node. You can now view the man pages on the master-eligible nodes by using the `man` command. For more information, see the `man`(1M) man page.
Previous Contents Index Next

Copyright 1994-2004 Sun Microsystems