Solaris Documentation CD
Important Information

Edited for IFH by Ray Ballisti

Overview Of Documentation CD	What Is On The CD?
What Do I Need to Install?	Installing The AnswerBook2 Server
Installing Book Collections onto The AnswerBook2 Server	Using Web Start to Install Server Software And Document Collections
Running An AnswerBook2 Server from The CD

Overview Of Documentation CD

The Solaris 7 Documentation CD includes the AnswerBook2 documentation server software and the Solaris 7 online documentation. The Solaris 7 online documentation is viewable through an AnswerBook2 documentation server and any HTML 3.2-compliant web browser. Beginning with the Solaris 2.6 release, the AnswerBook2 product replaces the AnswerBook product from previous Solaris product releases. For more information about the AnswerBook2 product, see Accessing Online Documentation in the Solaris 7 Installation Library or install the AnswerBook2 server software and view its online Help.

What Is On The CD?

The Solaris 7 Documentation CD includes the following directories:

/cdrom/sol_7_doc/

Top-level directory contains an installation utility (installer), the README files, and a script, ab2cd, that you can use to run the AnswerBook2 server directly from the CD. For more information, see Running An AnswerBook2 Server from The CD.
/cdrom/sol_7_doc/Solaris_2.7_Doc/sparc/Product/

Contains the AnswerBook2 server software for installation on a SPARC-based system. For information on installing the server software, see Installing The AnswerBook2 Server.
/cdrom/sol_7_doc/Solaris_2.7_Doc/i386/Product/

Contains the AnswerBook2 server software for installation on an Intel-based system. For information on installing the server software, see Installing The AnswerBook2 Server.
/cdrom/sol_7_doc/Solaris_2.7_Doc/common/Product/

Contains online documentation in AnswerBook2 format. For more information on installing the document collections, see Installing Book Collections onto The AnswerBook2 Server.

What Do I Need to Install?

To install an AnswerBook2 server onto your system...

To install the documentation server, you must be running the Solaris 7 operating environment on either a SPARCstation 2 or higher (minimum SPARCstation 5 recommended) or an Intel-based personal computer. In addition, you need to have approximately 30 Megabytes of hard disk space available for the server software plus some amount of space for all the books (up to 600 Megabytes recommended for document collections). For detailed information about installing the AnswerBook2 server, see Installing The AnswerBook2 Server. For detailed instructions on installing document collections, see Installing Book Collections onto The AnswerBook2 Server.
To run an AnswerBook2 server directly from the CD...

If you are operating in a non-networked environment (stand-alone) or you only occasionally view the online documentation, you can run the AnswerBook2 server directly from the Solaris 7 Documentation CD. To do this, you must be running the Solaris 2.6 or 7 operating environment on either a SPARCstation 2 or higher (minimum SPARCstation 5 recommended) or an Intel-based personal computer. Be aware that a documentation server run from the CD is slower than a documentation server installed on your system. Do not use this approach if you expect other users to access this documentation server. For instructions, see Running An AnswerBook2 Server from The CD.
To view online documentation...

If the AnswerBook2 server is installed on another system and you know the host name for that system, you can view the documentation by entering the appropriate URL (for example, http://imaserver:8888/). You can also view all released Solaris documentation at the URL: http://docs.sun.com/

Installing The AnswerBook2 Server

You can use standard utilities, such as pkgadd, or the Web Start utility, which uses a a point-and-click interface, to install server software and document collections. This section and Installing Book Collections onto The AnswerBook2 Server, describe how to install using standard utilities. For information on Web Start, see Using Web Start to Install Server Software And Document Collections.

Note: Do not relocate the AnswerBook2 server software. If you do, some administrative functions might not perform as expected.

To install the AnswerBook2 server software using the pkgadd or swmtool utilities, perform the following steps:

Log in as super-user on the documentation server machine.
```
	% su -
```
Insert the Solaris Documentation CD into your CD-ROM drive. The Volume Manager should mount the CD automatically.
Change your directory to the location of the documentation server packages.

For example, you might enter a command similar to the following to go to the location of the server software packages for a SPARC server:
```
	# cd cdrom/sol_7_doc/Solaris_2.7_Doc/sparc/Product/
```
Where cdrom is the mount-point for the CD-ROM device and sol_7_doc is the name of the CD-ROM volume.
Launch the installation utility. For example:
```
	# pkgadd -d .
```
Select the following server software packages to install:
- SUNWab2r (0.25 Megabytes)--Installs in root partition and provides configuration and start-up files.
- SUNWab2s (1.00 Megabytes)--Provides shared files for performing document processing.
- SUNWab2u (26.00 Megabytes)--Provides executable and back-end processing files for server and administration functions.
Start up the server, if needed.

Installing the packages should cause the server to start up on the default port of 8888. If it does not start, use the following command:
```
	# /usr/lib/ab2/bin/ab2admin -o start
```
Install the document collections. For more information, see Installing Book Collections onto The AnswerBook2 Server.
If you already run an httpd server on your system and you prefer to run the AnswerBook2 server as a CGI process on that server, you can do so. You must install the standard AnswerBook2 server software first, then change several configuration files and create soft links to run the server as a CGI process. For more information, see the section Running the AnswerBook2 Documentation Server as a CGI Process in either the module Accessing Online Documentation in the Solaris 7 Installation Library or in the AnswerBook2 online Help.
If you want other users to automatically find your document server through Federated Naming Service (FNS), you need to have FNS running and register the server. You can use standard FNS command, such as fnbind, to do this or you can use the registration utility provided with the AnswerBook2 server software.

To register your server using the registration utility, type:
```
	# /usr/lib/ab2/bin/ab2regsvr server_url
```
Where server_url is the fully qualified URL for your server (for example, http://imaserver.eng.sun.com:8888/). For more information about registering your server through FNS, see the section Registering Your Documentation Server in either the module Accessing Online Documentation in the Solaris 7 Installation Library or in the AnswerBook2 online Help.

Installing Book Collections onto The AnswerBook2 Server

Your documentation server cannot do its job if no documents are installed for it to serve. You can install collections from the Solaris 7 Documentation CD or from other locations, such as existing document collections or collections located on other Sun CDs.

To install document collection packages onto your server from the Solaris 7 Documentation CD:

Log in as super-user on the documentation server machine.
```
	% su -
```
Insert the Solaris 7 Documentation CD into your CD-ROM drive. The Volume Manager should mount the CD automatically.
Change your directory to the location of the document collection packages:
```
	# cd cdrom/sol_7_doc/Solaris_2.7_Doc/common/Product/
```
Where cdrom is the mount-point for the CD-ROM device and sol_7_doc is the name of the CD-ROM volume.
Launch the installation utility. For example:
```
	# pkgadd -d .
```

Select from the following collections, listed by package name:

Package	Collection Title	Book Titles
SUNWaadm	Solaris 7 System Administrator Collection	Binary Compatibility Guide Font Administrator User's Guide Mail Administration Guide NFS Administration Guide NIS+ Transition Guide Solaris 1.x to 2.x Transition Guide Solaris Common Messages and Troubleshooting Guide Solaris Naming Administration Guide Solaris Naming Setup and Configuration Guide Solstice Enterprise Agents 1.0 User Guide SunSHIELD Basic Security Module Guide System Administration Guide, Volume I System Administration Guide, Volume II TCP/IP and Data Communications Administration Guide
SUNWabsdk	Solaris 7 Software Developer Collection	Application Packaging Developer's Guide Asian Application Developer's Guide Federated Naming Service Programming Guide Java on Solaris Developer's Guide Linker and Libraries Guide Multithreaded Programming Guide ONC+ Developer's Guide Programming Utilities Guide Solaris 7 64-bit Developer's Guide Solaris Internationalization Guide For Developers Source Compatibility Guide STREAMS Programming Guide System Interface Guide ToolTalk User's Guide Transport Interfaces Programming Guide WebNFS Developer's Guide
SUNWabe	Solaris 7 User Collection	About Solaris 7 Documentation Open Windows Advanced User's Guide Open Windows User's Guide Solaris Common Desktop Environment: Advanced User's and System Administrator's Guide Solaris Common Desktop Environment: User's Guide Solaris Common Desktop Environment: User's Transition Guide Using Power Management
SUNWaman	Solaris 7 Reference Manual Collection	man Pages(1): User Commands man Pages(1M): System Administration Commands man Pages(2): System Calls man Pages(3): Library Routines man Pages(4): File Formats man Pages(5): Headers, Tables and Macros man Pages(6): Demos man Pages(7): Device and Network Interfaces man Pages(9E): DDI and DKI Driver Entry Points man Pages(9F): DDI and DKI Kernal Functions man Pages(9S): DDI and DKI Data Structures
SUNWinab	Solaris 7 Installation Collection	Solaris 7 (Intel Platform Edition) Device Configuration Guide Solaris 7 (Intel Platform Edition) Hardware Compatibility List Solaris 7 (Intel Platform Edition) Installation Library Solaris 7 (SPARC Platform Edition) Installation Library Solaris Advanced Installation Guide
SUNWopen	OpenBoot Collection	OpenBoot 2.x Command Reference Manual OpenBoot 2.x Quick Reference OpenBoot 3.x Command Reference Manual OpenBoot 3.x Quick Reference
SUNWakcs	KCMS AnswerBook	KCMS Application Developer's Guide KCMS Calibrator Tool Loadable Interface Guide KCMS Test Suite User's Guide
SUNWdtad	Solaris Common Desktop Environment Developer AnswerBook	Solaris Common Desktop Environment: Programmer's Guide Solaris Common Desktop Environment: Motif Transition Guide Common Desktop Environment: Programmer's Overview Common Desktop Environment: Style Guide and Certification Checklist Common Desktop Environment: Application Builder User's Guide Common Desktop Environment: Help System Author's and Programmer's Guide Common Desktop Environment: ToolTalk Messaging Overview Common Desktop Environment: Internationalization Programmer's Guide Common Desktop Environment: Desktop KornShell User's Guide Common Desktop Environment: Product Glossary
SUNWAxg	Solaris XGL 3.3 AnswerBook (Display PostScript)	XGL Reference Manual XGL Programmer's Guide XGL Accelerator Guide for Reference Frame Buffers XGL Architecture Guide XGL Device Pipeline Porting Guide XGL Test Suite User's Guide Getting Started Writing XGL Device Handlers
SUNWdedta	Solaris Benutzer AnswerBook	Arbeiten mit Power Management Solaris Benutzer Handbuch Solaris Common Desktop Environment: Benutzer Handbuch Solaris Common Desktop Environment: Benutzer Handbuch zum Umstieg Solaris Common Desktop Environment: Benutzerhandbuch für Fortgeschrittene und Systemverwalter Solaris Handbuch für Fortgeschrittene Benutzer
SUNWdeiab	Solaris 7 Installation-Dokumentationsreihe	Solaris 7 (Intel Platform Edition) Device Configuration Guide Solaris 7 (Intel Platform Edition) Hardware Compatibility List Solaris 7 (Intel-Plattform)-Installationsbibliothek Solaris 7 (SPARC-Plattform)-Installationsbibliothek Solaris Advanced Installation Guide
SUNWesdta	Solaris - AnswerBook del usuario	Common Desktop Environment: Guía de transición del usuario Common Desktop Environment: Guía del usuario Common Desktop Environment: Guía del Usuario Avanzado y del Administrador del Sistema Guía avanzada del usuario Guía del usuario Uso de Power Management
SUNWesiab	Solaris 7: Colección de instalación	Solaris 7: Biblioteca de instalación (Edición SPARC) Solaris 7: Biblioteca de instalación (Edición Intel) Solaris 7 (Intel Platform Edition) Device Configuration Guide Solaris 7 (Intel Platform Edition) Hardware Compatibility List Solaris Advanced Installation Guide
SUNWfrdta	Solaris - AnswerBook de l'utilisateur	Bureau CDE Guide de l'administrateur Manuel de l'Utilisateur Expérimenté Solaris Manuel de l'Utilisateur Solaris Solaris CDE - Guide de l'utilisateur Solaris CDE - Guide de transition de l'utilisateur Utilisation de Power Management
SUNWfriab	Collection de manuels d'installation Solaris 7	Bibliothèque d'installation de Solaris 7 (Edition pour plate-forme Intel) Bibliothèque d'installation de Solaris 7 (Edition pour plate-forme SPARC) Solaris 7 (Intel Platform Edition) Device Configuration Guide Solaris 7 (Intel Platform Edition) Hardware Compatibility List Solaris Advanced Installation Guide
SUNWitdta	Collezione per l'utente di Solaris 7	Documentazione di Solaris 7 Guida alla transizione al CDE Solaris per l'utente Guida avanzata a Solaris Manuale del Common Desktop Environment per utenti esperti e amministratori di sistema Manuale dell'utente del Common Desktop Environment Manuale utente di Solaris Uso di Power Management
SUNWitiab	Collezione per l'installazione di Solaris 7	Libreria di installazione di Solaris 7 (Edizione per piattaforma Intel) Libreria di installazione di Solaris 7 (Edizione per piattaforma SPARC) Solaris 7 (Intel Platform Edition) Device Configuration Guide Solaris 7 (Intel Platform Edition) Hardware Compatibility List Solaris Advanced Installation Guide
SUNWsvdta	Solaris AnswerBook för användare	Använda Power Management Användarhandbok för Solaris Avancerad användarhandbok för Solaris Common Desktop Environment: Användarhandbok Common Desktop Environment: Användarhandbok för systemadministratörer Solaris Common Desktop Environment: Användarhandbok för byte av miljö
SUNWsviab	Installationssamling för Solaris 7	Installationsbibliotek för Solaris 7 (Intel-version) Installationsbibliotek för Solaris 7 (SPARC-version) Solaris 7 (Intel Platform Edition) Device Configuration Guide Solaris 7 (Intel Platform Edition) Hardware Compatibility List Solaris Advanced Installation Guide

The document collection packages included on this CD include a post-install script that adds the collections to the server's database and restart the server.

If you install collection packages from any other location, you might need to use the following command to add these collections to the server's database:
```
# /usr/lib/ab2/bin/ab2admin -o add_coll -d path_to_collection
```
Where path_to_collection is the full path to the location of the collinfo file (for AnswerBook2 collections) or the ab_cardcatalog file (for AnswerBook1 collections).

If collection packages are already installed on your system, you use the ab2admin -o scan command to have them automatically found and added to the server's document database. This function only works for locally installed packages.

To serve document collections located on some other system, use the ab2admin -o add_coll command and provide the full path name to the ab_cardcatalog or collinfo file. For example, if the document server is imasrvr and you want it to serve document collections located on the system other, you might use the following command:
```
imasrvr# ab2admin -o add_coll -d /net/other/books/SUNWdtad/collinfo
```

Using Web Start to Install Server Software And Document Collections

To install the AnswerBook2 server software and document collections using the Web Start utility, perform the following steps:

Insert the Solaris 7 Documentation CD into the CD-ROM drive. The Volume Manager should mount the CD automatically.
Double-click on the installer icon and follow the instructions on the screens.
If you are not already logged in as super-user on the system, the Web Start application asks for your root password.
The Web Start utility allows you to install the documentation server software and all document collections on the CD (default install) or to install selected items (custom install).

For a list of document collections included on this CD, see the table of collections. For information on adding book collections from other locations, see Installing Book Collections..., step 6.
Start up the server, if needed.

Installing the packages should cause the server to start up on the default port of 8888. If it does not start, use the following command:
```
# /usr/lib/ab2/bin/ab2admin -o start
```
If you already run an httpd server on your system and you prefer to run the AnswerBook2 server as a CGI process on that server, you can do so. You must install the standard AnswerBook2 server software first, then change several configuration files and create soft links to run the server as a CGI process. For more information, see the section Running the AnswerBook2 Documentation Server as a CGI Process in either the module Accessing Online Documentation in the Solaris 7 Installation Library or in the AnswerBook2 online Help.
If you want other users to automatically find your document server through Federated Naming Service (FNS), you need to have FNS running and register the server. You can use standard FNS command, such as fnbind, to do this or you can use the registration utility provided with the AnswerBook2 server software.

To register your server using the registration utility, type:
```
# /usr/lib/ab2/bin/ab2regsvr server_url
```
Where server_url is the fully qualified URL for your server (for example, http://imaserver.eng.sun.com:8888/). For more information about registering your server through FNS, see the section Registering Your Documentation Server in either the module Accessing Online Documentation in the Solaris Installation Library or in the AnswerBook2 online Help.

Running An AnswerBook2 Server from The CD

To run the server directly from the CD, perform the following steps:

Insert the Solaris Documentation CD into your CD-ROM drive.
Make sure you are logged in as super-user.
```
% su -
```
Change directory to, or bring up file manager and go to, the top level of the CD-ROM volume. This should look similar to:
```
cdrom/sol_7_doc/
```
Where cdrom is the mount-point for the CD-ROM device and sol_7_doc is the name of the CD-ROM volume.

Among other things, this directory contains the executable script ab2cd.
Run the following command:
```
  	# ./ab2cd
```
If you have existing AnswerBook2 documentation collections installed on your server machine and you want the CD-driven server software to recognize those collections, use the following command:
```
	# ./ab2cd -s
```
This causes the CD-driver server software to scan for other collections installed on this system and add them to its database.
You can now access the document server using the following URL:
```
	http://server:8888/
```
Where server is the name of the machine to which the CD is attached.
To stop running the server from the CD, run the following command:
```
	# cdrom/sol_7_doc/ab2cd stop
```
Where cdrom is the mount-point for the CD-ROM device and sol_7_doc is the name of the CD-ROM volume.

Important Notes When Running the AnswerBook2 Server From the CD

The AnswerBook2 Server run from the CD always runs on port 8888. If you already have an AnswerBook2 Server running on your system using the default port (8888), the ab2cd script will display the following message:
```
     A document server is already running on this system as server:8888.
     Please shut down the current server before running the ab2cd command.
```
Use the following command to shut down the existing server:
```
   # /usr/lib/ab2/bin/ab2admin -o stop
```
Always use ab2cd stop to stop the server running from the CD. Do not use /etc/init.d/ab2mgr stop to stop the CD-based server.

The ab2cd stop command stops the AnswerBook2 server process and cleans up all files in the /tmp/.ab2/ and /tmp/ab2cd_config/ directories. The /etc/init.d/ab2mgr stop command stops all server processes, but does not clean up the files in the /tmp/.ab2/ and /tmp/ab2cd_config/ directories.
To run two AnswerBook2 servers (one on your system, one from the CD), keep these rules in mind:
- STARTUP
  - The /etc/init.d/ab2mgr start command always starts the server on your system.
  - The ab2cd command always starts the server from the CD.
- SHUTDOWN
  - Always use the ab2cd stop command to stop the server running from the CD.
  - To stop both servers, first use the ab2cd stop command to stop the server running from the CD, then use either /etc/init.d/ab2mgr stop or /usr/lib/ab2/bin/ab2admin -o stop to stop the server running on your system.

Solaris Documentation CD Important Information

Contents