This appendix provides a map of the installed ChorusOS 5.0 documentation files.
The directory conventions defined in Section "Directory Conventions" apply to this appendix.
To illustrate the installation of a given ChorusOS product and documentation, we will use the following value for install_dir:
/opt/SUNWconn/SEW/5.0-processor_family
where processor_family can be:
depending on the ChorusOS product you have installed.
After installing a ChorusOS product and documentation for a given processor family with the Sun Embedded Workshop graphical installer (see Section "Installing ChorusOS Products and Documentation"), the part of the install_dir directory containing the documentation files will be organized as follows:
The following sections give the list and path to all books in each ChorusOS 5.0 documentation collection in PDF and HTML format.
AnswerBook2 collections are not installed in the install_dir directory. See "Installing and Viewing ChorusOS Online AnswerBook2 Documentation", for more information on how to install the Anwerbook2 packages on an AnswerBook server.
The ChorusOS 5.0 Installation Documentation Collection contains documents relevant to installing ChorusOS operating system (hosts, targets, boot services, network connections).
PDF format collection location | HTML format collection location | |
---|---|---|
install_dir/ chorus-doc/pdf/ipdf/ |
install_dir/ chorus-doc/html/ihtml/ |
|
Document title |
PDF book file location |
HTML book file location |
COSABOUT.pdf |
COSABOUT/BOOK.htm |
|
COSINSTALL.pdf |
COSINSTALL/BOOK.htm |
|
COSTRANS.pdf |
COSTRANS/BOOK.htm |
The ChorusOS 5.0 Application Developer Documentation Collection contains documents relevant for application software developers working in the ChorusOS environment.
PDF format collection location | HTML format collection location | |
---|---|---|
install_dir/ chorus-doc/pdf/dpdf/ |
install_dir/ chorus-doc/html/dhtml/ |
|
Document title |
PDF book file location |
HTML book file location |
COSDESPERF.pdf |
COSDESPERF/BOOK.htm |
|
COSAPPDEV.pdf |
COSAPPDEV/BOOK.htm |
|
COSGDBSUP.pdf |
COSGDBSUP/BOOK.htm |
The ChorusOS 5.0 System Administrator Documentation Collection contains documents describing all aspects of ChorusOS system administration.
PDF format collection location | HTML format collection location | |
---|---|---|
install_dir/ chorus-doc/pdf/ypdf/ |
install_dir/ chorus-doc/html/yhtml/ |
|
Document title |
PDF book file location |
HTML book file location |
COSSYSADMIN.pdf |
COSSYSADMIN/BOOK.htm |
|
COSSRCDELIV.pdf |
COSSRCDELIV/BOOK.htm |
The ChorusOS 5.0 Target Platform Documentation Collection contains documents relevant to developers that are porting the ChorusOS 5.0 operating system to different target platforms, or adding device drivers.
PDF format collection location | HTML format collection location | |
---|---|---|
install_dir/ chorus-doc/pdf/fpdf/ |
install_dir/ chorus-doc/html/fhtml/ |
|
Document title |
PDF book file location |
HTML book file location |
COSBSPDEV.pdf |
COSBSPDEV/BOOK.htm |
|
COSRTDSPARC.pdf |
COSRTDSPARC/BOOK.htm |
|
COSRTDINTEL.pdf |
COSRTDINTEL/BOOK.htm |
|
COSRTDPPC.pdf |
COSRTDPPC/BOOK.htm |
|
COSRTD8XX.pdf |
COSRTD8XX/BOOK.htm |
The ChorusOS 5.0 Reference Manual Documentation Collection contains books of ChorusOS 5.0 man pages grouped by man page sections. This collection of books is delivered in PDF only.
The collection of ChorusOS 5.0 man pages is delivered in HTML, with an alphabetic index which provides entry points to the individual ChorusOS man pages (see "ChorusOS 5.0 ChorusOS Man Pages and [A-Z] Index").
PDF format collection location |
|
---|---|
install_dir/chorus-doc/pdf/mpdf/ |
|
ChorusOS 5.0 Man Page Section |
PDF book file location |
COSREFMAN1CC.pdf |
|
COSREFMAN1M.pdf |
|
COSREFMAN2DL.pdf |
|
COSREFMAN2K.pdf |
|
COSREFMAN2MON.pdf |
|
COSREFMAN2POSIX.pdf |
|
man pages section 2RESTART: Hot Restart and Persistent Memory Services |
COSREFMAN2RSTART.pdf |
man pages section 3EXT: ChorusOS Extensions |
COSREFMAN3EXT.pdf |
COSREFMAN3FTPD.pdf |
|
COSREFMAN3LDAP.pdf |
|
COSREFMAN3M.pdf |
|
COSREFMAN3POSIX.pdf |
|
COSREFMAN3RPC.pdf |
|
COSREFMAN3STDC.pdf |
|
COSREFMAN3TELD.pdf |
|
COSREFMAN4CC.pdf |
|
COSREFMAN5FEA.pdf |
|
COSREFMAN7P.pdf |
|
COSREFMAN7S.pdf |
|
COSREFMAN9DDI.pdf |
|
COSREFMAN9DKI.pdf |
|
COSREFMAN9DRV.pdf |
The collection of ChorusOS 5.0 man pages is delivered in HTML, with an alphabetic index which provides entry points to the individual ChorusOS man pages.
The entry to the index file of man pages in HTML format is:
install_dir/chorus-doc/html/mhtml/a.html.