About ChorusOS 5.0 Documentation

Map of the Installed 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:

install_dir

/opt/SUNWconn/SEW/5.0-processor_family

where processor_family can be:

UltraSPARC
x86
PowerPC
MPC8xx

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:

`/opt/SUNWconn/SEW/5.0-processor_family/`
	`README.html`
	`RELEASE.html`
	`chorus-doc/`
		`html/`	ChorusOS 5.0 documentation in HTML format
			`dhtml/`	Books of the Application Developer Documentation Collection in HTML format
			`fhtml/`	Books of the Target Family Documentation Collection in HTML format
			`ihtml/`	Books of the Installation Documentation Collection in HTML format
			`mhtml/`	ChorusOS 5.0 man pages and [A-Z] index in HTML format
			`yhtml/`	Books of the System Administrator Documentation Collection in HTML format
		`pdf/`	ChorusOS 5.0 documentation in PDF format
			`dpdf/`	Books of the Application Developer Documentation Collection in PDF format
			`fpdf/`	Books of the Target Family Documentation Collection in PDF format
			`ipdf/`	Books of the Installation Documentation Collection in PDF format
			`mpdf/`	Books of the Reference Manual Documentation Collection in PDF format
			`ypdf/`	Books of the System Administrator Documentation Collection in PDF format
		`man/`	ChorusOS 5.0 man pages in SGML format
	`chorus-family/` [This directory contains the software product installed files; `family` can be one of the following, depending on the target processor family for the installed product: `usparc`, `x86`, `powerpc`, `mpc8xx`. It does not contain any ChorusOS documentation file.]
	`doc-uninstaller`
	`SEW-uninstaller` [For uninstalling the software products (not the documentation).]

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.

ChorusOS 5.0 Installation Collection

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
About ChorusOS 5.0 Documentation	`COSABOUT.pdf`	`COSABOUT/BOOK.htm`
ChorusOS 5.0 Installation and Getting Started Guide	`COSINSTALL.pdf`	`COSINSTALL/BOOK.htm`
ChorusOS 5.0 Transition Guide	`COSTRANS.pdf`	`COSTRANS/BOOK.htm`

ChorusOS 5.0 Application Developer Collection

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
ChorusOS 5.0 Features and Architecture Overview	`COSDESPERF.pdf`	`COSDESPERF/BOOK.htm`
ChorusOS 5.0 Application Developer's Guide	`COSAPPDEV.pdf`	`COSAPPDEV/BOOK.htm`
ChorusOS 5.0 Debugging Guide	`COSGDBSUP.pdf`	`COSGDBSUP/BOOK.htm`

ChorusOS 5.0 System Administrator Collection

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
ChorusOS 5.0 System Administrator's Guide	`COSSYSADMIN.pdf`	`COSSYSADMIN/BOOK.htm`
ChorusOS 5.0 Source Delivery Guide	`COSSRCDELIV.pdf`	`COSSRCDELIV/BOOK.htm`

ChorusOS 5.0 Target Platform Collection

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
ChorusOS 5.0 Board Support Package Developer's Guide	`COSBSPDEV.pdf`	`COSBSPDEV/BOOK.htm`
ChorusOS 5.0 Target Family Guide (SPARC Platform Edition)	`COSRTDSPARC.pdf`	`COSRTDSPARC/BOOK.htm`
ChorusOS 5.0 Target Family Guide (Intel Platform Edition)	`COSRTDINTEL.pdf`	`COSRTDINTEL/BOOK.htm`
ChorusOS 5.0 Target Family Guide (PowerPC Platform Edition)	`COSRTDPPC.pdf`	`COSRTDPPC/BOOK.htm`
ChorusOS 5.0 Target Family Guide (MPC8xx Platform Edition)	`COSRTD8XX.pdf`	`COSRTD8XX/BOOK.htm`

ChorusOS 5.0 Reference Manual Collection

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
man pages section 1CC: User Utilities	`COSREFMAN1CC.pdf`
man pages section 1M: System Management Utilities	`COSREFMAN1M.pdf`
man pages section 2DL: Data Link Services	`COSREFMAN2DL.pdf`
man pages section 2K: Kernel Services	`COSREFMAN2K.pdf`
man pages section 2MON: Monitoring Services	`COSREFMAN2MON.pdf`
man pages section 2POSIX: POSIX System Calls	`COSREFMAN2POSIX.pdf`
man pages section 2RESTART: Hot Restart and Persistent Memory Services	`COSREFMAN2RSTART.pdf`
man pages section 3EXT: ChorusOS Extensions	`COSREFMAN3EXT.pdf`
man pages section 3FTPD: FTP Daemon Services	`COSREFMAN3FTPD.pdf`
man pages section 3LDAP: LDAP Library	`COSREFMAN3LDAP.pdf`
man pages section 3M: Mathematical Libraries	`COSREFMAN3M.pdf`
man pages section 3POSIX: POSIX Library Functions	`COSREFMAN3POSIX.pdf`
man pages section 3RPC: RPC Services	`COSREFMAN3RPC.pdf`
man pages section 3STDC: Standard C Library Functions	`COSREFMAN3STDC.pdf`
man pages section 3TELD:Telnet Services	`COSREFMAN3TELD.pdf`
man pages section 4CC: Files	`COSREFMAN4CC.pdf`
man pages section 5FEA: ChorusOS Features and APIs	`COSREFMAN5FEA.pdf`
man pages section 7P: Protocols	`COSREFMAN7P.pdf`
man pages section 7S: Services	`COSREFMAN7S.pdf`
man pages section 9DDI: Device Driver Interfaces	`COSREFMAN9DDI.pdf`
man pages section 9DKI: Driver to Kernel Interface	`COSREFMAN9DKI.pdf`
man pages section 9DRV: Driver Implementations	`COSREFMAN9DRV.pdf`

ChorusOS 5.0 ChorusOS Man Pages and [A-Z] Index

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.