Downloading, Installing, and Viewing ChorusOS Online Documentation

To retrieve the product documentation and software to install on your network, you may choose one of two methods:

• Install the ChorusOS 5.0 products and documentation directly from the ChorusOS 5.0 CD.

• Retrieve and install the ChorusOS 5.0 products and documentation via a web distribution:

  1. First, download files from your account provided by Sun Microsystems. To access the account, you need a machine with direct access to the Internet. You also need the URL, login name, and password your Sun customer service representative gave you.

  2. Then, install the ChorusOS 5.0 products and documentation from the directory containing the downloaded files.

     ---

     Note -

     Ensure that you have enough free disk space to download the files. Guidelines to calculate the amount of disk space you will need for the downloaded files are provided with the README file.

     ---

With the Sun Embedded Workshop 5.0 delivery, each ChorusOS 5.0 product for a given target processor family contains the ChorusOS 5.0 documentation set. In other words, for each platform, full documentation is included in the corresponding binary ChorusOS product.

Directory Conventions

The following table describes the directory conventions used in this book.

Installing ChorusOS Products and Documentation

Depending on how you accessed the Sun Embedded Workshop delivery, the installation steps will be different:

CD distribution

• Open the CD-ROM file manager window and double-click on the icon of the Sun Embedded Worshop graphical installer.

• The Sun Embedded Workshop graphical installer (based on the Solaris Web Start Wizards^TM API) appears.

• Follow the instructions to install a selected ChorusOS 5.0 product and the ChorusOS 5.0 documentation.

Web distribution

Follow the instructions given in the download_dir/README.html README file.

• First, extract the delivery with download_dir/part_number/extract.sh

  where part_number identifies the ChorusOS 5.0 marketing part number of the product or add-on that you are downloading.

• The Sun Embedded Workshop graphical installer (based on the Solaris Web Start Wizards API) appears.

• Follow the installer instructions to install a selected ChorusOS 5.0 product and the ChorusOS 5.0 documentation.

The Sun Embedded Workshop graphical installer allows you to install, among other things, the following on your system, in install_dir:

• Documentation in PDF format (all books, including Reference Manuals).

• Documentation in HTML format (all books, including Reference Manuals) .

• Documentation in online manual page format (manual pages only).

Appendix A, Documentation Installation Layout gives a map of the installed documentation files in install_dir.

The Sun Embedded Workshop graphical installer alone does not allow you to view the AnswerBook2 ChorusOS documentation collections. You will need to install the AnswerBook2 server product. See Section "Installing and Viewing ChorusOS Online AnswerBook2 Documentation", for more information.

Viewing ChorusOS Online PDF Documentation

To view the ChorusOS 5.0 PDF documents, go to the install_dir/chorus-doc/pdf directory (see Appendix A, Documentation Installation Layout: Documentation Installation Layout).

Select and open a PDF file for a book.

You may need to install the free Adobe® Acrobat® Reader from http://www.adobe.com/products/acrobat.

ChorusOS 5.0 books in PDF format can easily be printed with Adobe Acrobat Reader.

Viewing ChorusOS Online HTML Documentation

To view the ChorusOS 5.0 HTML documents, go to the install_dir/chorus-doc/html directory (see Appendix A, Documentation Installation Layout: Documentation Installation Layout).

Select and open an HTML file for a book in a web browser.

Viewing ChorusOS Online Man Pages

If you have installed the online manual documentation on a SPARC/Solaris machine, update your MANPATH variable to include install_dir/chorus-doc/man, in order to access online manual pages using the man command.

Installing and Viewing ChorusOS Online AnswerBook2 Documentation

An AnswerBook2 documentation collection is a set of documents that you can view using a web browser. Users can share AnswerBook2 collections across a network through a web browser-based interface. You can use the AnswerBook2 system as you would any library: you can browse, search, bookmark, and print the information.

To use the AnswerBook2 delivery of the ChorusOS 5.0 documentation, you will need:

• An AnswerBook2 server running on SPARC/Solaris.

  ---

  Note -

  The Solaris 8 Documentation CD includes the AnswerBook2 server software. For information about how to get started using the AnswerBook2 product and how to install AnswerBook2 documentation, see the file README_en.html on the Solaris 8 Documentation CD.

  ---

• 20 MB free disk space.

See the document Installing and Administering an AnswerBook2 Server on http://www.oracle.com/technetwork/indexes/documentation/index.html for a more complete description of the AnswerBook2 documentation installation process.

The following AnswerBook2 packages containing the ChorusOS documentation collections in AnswerBook2 format are available with the ChorusOS 5.0 documentation delivery:

SUNWewdab

ChorusOS 5.0 Application Developer Collection

SUNWewfab

ChorusOS 5.0 Reference Target Collection

SUNWewiab

ChorusOS 5.0 Installation Collection

SUNWewmab

ChorusOS 5.0 Reference Manual Collection

SUNWewyab

ChorusOS 5.0 System Administrator Collection

After downloading the ChorusOS 5.0 products via a web distribution you will find an archive chorus-answerbooks.zip in the download_dir directory.

Extract the AnswerBook2 documentation packages:

$ cd extract_dir
$ sh download_dir/part_number/extract.sh -only

The AnswerBook2 packages are now under extract_dir/part_number/chorus-answerbooks/pkgs.

Log in to the system on which the AnswerBook2 server is located and become root:

$ rlogin ab2_server 
$ su - 
Password: root_password

Use the pkgadd utility to install the AnswerBook2 packages on the system.

$ pkgadd -d extract_dir/part_number/chorus-answerbooks/pkgs all

If you want to select an AnswerBook2 package to install, name the package instead of using 'all'. For example to install the ChorusOS 5.0 Installation Collection in AnswerBook2 format, use:

$ pkgadd -d extract_dir/part_number/chorus-answerbooks/pkgs SUNWewiab

Each AnswerBook2 package includes a post-installation script that adds the collection to the server's database and restarts the server. At this point, the AnswerBook2 collections should be visible through your web browser at http://ab2_server:8888, where ab2_server is the hostname of the system on which you installed the documentation collections.

The AnswerBook2 product allows you to view and print a variety of information, including AnswerBook2 collections and older "AnswerBooks" (previously accessed through the AnswerBook^TM script).

You may also view all released ChorusOS documentation at http://www.oracle.com/technetwork/indexes/documentation/index.html.

Uninstalling ChorusOS Product Documentation

If you want to uninstall the documentation installed with a ChorusOS 5.0 product, go to your installation directory:

$ cd install_dir
$ sh doc-uninstaller
Solaris Web Start uninstaller 
To use this uninstaller you will need to be the system's root user. 

Please enter this system's root user password 
Password: root_password
$ sh doc-uninstaller
Do you want to uninstall Documentation for processor_family?
y

Follow the instructions on the screen as the Sun Embedded Workshop graphical uninstaller prompts you for further information.

The Sun Embedded Workshop graphical uninstaller does not allow you to uninstall AnswerBook2 packages. To this purpose, use the pkgrm(1M) utility.