![]() | Name | Last modified | Size | Description |
---|---|---|---|---|
![]() | Parent Directory | - | ||
![]() | components/ | 2000-01-21 06:45 | - | |
![]() | Copyright | 2000-01-21 06:17 | 4.8K | |
![]() | installer | 2000-01-21 06:35 | 5.1K | |
![]() | ab2cd | 2000-01-21 06:42 | 67K | |
Copyright 2000 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, California 94303 U.S.A. All rights reserved.
Copyright 2000 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, Californie 94303 Etats-Unis. Tous droits réservés.
The Solaris 8 Admin Pack Documentation CD includes the AnswerBook2TM documentation server software and the Admin Pack online documentation. The Admin Pack 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, install the AnswerBook2 server software and view its online Help.
The Solaris 8 Admin Pack Documentation CD includes the following:
A point-and-click installation utility (installer
) that you can use to install AnswerBook2 server software and document collections. See Installing the AnswerBook2 Software.
A script, ab2cd
, that you can use to run the AnswerBook2
server directly from the CD. See
Reading Documentation Directly from the CD.
Directories that contain the AnswerBook2 server software for installation on a
SPARC-based system (/
cdrom-mount-point/sparc/Product/
) or an Intel-based system
(/
cdrom-mount-point/i386/Product/
). See Using pkgadd to Install AnswerBook2 Server Software.
A directory that contains online documentation in AnswerBook2 format (/
cdrom-mount-point/common/Product/
). See
Using pkgadd to Install Book Collections.
Your system requirements depend on what you want to do:
To run an AnswerBook2 server on your system
You must be running either the Solaris 2.5.1, Solaris 2.6, Solaris 7, or Solaris 8 operating environment on either a SPARCstationTM 2 system or higher (minimum SPARCstation 5 system recommended) or an Intel-based personal computer. In addition, you need to have approximately 35 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 instructions on installing the software, see Installing the AnswerBook2 Software.
To read documentation directly from the CD
If you are operating in a non-networked environment (standalone) or you only occasionally view the online documentation, you can run the AnswerBook2 server directly from the Solaris 8 Admin Pack Documentation CD. To do this, you must be running either the Solaris 2.5.1, Solaris 2.6, Solaris 7, or Solaris 8 operating environment on either a SPARCstation 2 system or higher (minimum SPARCstation 5 system recommended) or an Intel-based personal computer. A documentation server run from the CD is slower than one installed on your system. Do not use this approach if you expect other users to access this documentation server. For instructions, see Reading Documentation Directly 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 typing the appropriate URL (for example, http://imaserver:8888
) from any HTML 3.2-compliant web browser.
You can also view all released Solaris documentation at the
http://docs.sun.com site.
The Documentation CD includes a point-and-click interface called "installer" that
you can use to install server software and documentation collections or you can
use standard utilities, such as pkgadd
(See Using pkgadd to Install the AnswerBook2 Software).
To install the AnswerBook2 server software and document collections using the installer (Web Start utility), perform the following steps:
Insert the Solaris 8 Admin Pack Documentation CD into the CD-ROM drive.
The Volume Manager should mount the CD automatically.
Double-click the installer
icon and follow the
instructions on the screens.
If you are running CDE (Common Desktop Environment) and you see an Action:Run window that has Options and Argument fields, click OK.
This closes the window.
If you are not already logged in as superuser on the system, type the system's root password when prompted.
Select Default Install (documentation server software and all document collections on the CD) or Custom Install (selected items), then click Next to continue.
Default Install installs the documentation server software and all document collections on the CD. Custom Install enables you to select to install the documentation server software and specific collections (see the table of document collections). For information on adding book collections from other locations, see Adding Book Collections to the AnswerBook2 Server's Database.
You can follow the progress of the installation through the status bar.
Upon completion of the installation, a script automatically starts the server software. To verify the server has started, use one of the following methods:
Launch an HTML 3.2-compliant web browser, such as Netscape NavigatorTM, and
go to the http://localhost:8888
URL.
You should see an AnswerBook2 Library page with at least one document collection (the AnswerBook2 Help Collection), depending on the collections you installed.
Look for the server process using the following command:
# ps -eaf | grep dwhttpd
If the server is not running, type the following command as superuser:
# /usr/lib/ab2/bin/ab2admin -o start
When the installer is done, your server starts up using default configuration information. For information about changing your server's configuration, see the following:
To change standard server configuration information, such as the port number,
use either the AnswerBook2 Administration page (accessible through the
http://localhost:8888/ab2/@Ab2Admin
site) or the
/usr/lib/ab2/bin/ab2admin
command line interface. For more
information about administering your AnswerBook2 server, see Installing
and Administering an AnswerBook2 Server from the AnswerBook2 viewer
or look at the ab2admin
man page (% man ab2admin
).
If you already run an httpd server, such as Sun WebServerTM, 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" either in Installing and Administering an AnswerBook2 Server from the AnswerBook2 viewer.
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 commands, 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 Installing
and Administering an AnswerBook2 Server from the AnswerBook2 viewer.
To install the AnswerBook2 server software using the pkgadd
utility, perform the following steps:
Log in as superuser on the documentation server machine.
Shut down existing AnswerBook2 server software and remove packages.
If an AnswerBook2 server is running on this machine, use the following command to shut down the server:
# /usr/lib/ab2/bin/ab2admin -o stop
To remove existing AnswerBook2 server software, use the following command:
# pkgrm SUNWab2r SUNWab2s SUNWab2u
You do not need to remove existing document collections. The new server software will read them.
Insert the Solaris 8 Admin Pack Documentation CD into your CD-ROM drive.
The Volume Manager should mount the CD automatically.
Go to the location of the documentation server packages.
For example, you might type a command similar to the following to go to the location on a CD of the server software packages for a SPARCstation system:
# cd /cdrom-mount-point/sparc/Product/
where cdrom-mount-point is the mount-point, including volume name, for the CD-ROM device.
Launch the installation utility.
For example, type:
# pkgadd -d .
Select these server software packages to install.
SUNWab2r
(0.40 Megabytes)--Installs in root partition and
provides configuration and start-up files. Do not relocate this package.
SUNWab2s
(1.36 Megabytes)--Provides shared files for performing
document processing. Do not relocate this package.
SUNWab2u
(33.85 Megabytes)--Provides executable and back-end
processing files for server and administration functions.
Respond to prompts about superuser permissions when needed.
Install the document collections.
For more information, see Using pkgadd to Install Book Collections.
Upon completion of the installation, a script automatically starts the server software. To verify the server has started, use one of the following methods:
Launch an HTML 3.2-compliant web browser, such as Netscape Navigator, and go to the http://localhost:8888
site.
You should see an AnswerBook2 Library page with at least one document collection (the AnswerBook2 Help Collection), depending on the collections you installed.
Look for the server process using the following command:
# ps -eaf | grep dwhttpd
If the server is not running, type the following command as superuser:
# /usr/lib/ab2/bin/ab2admin -o start
When the installation scripts are done, your server starts up using default configuration information. For information about changing your server's configuration, see the following:
To change standard server configuration information, such as the port number,
use either the AnswerBook2 Administration page (accessible through the
http://localhost:8888/ab2/@Ab2Admin
URL) or the
/usr/lib/ab2/bin/ab2admin
command line interface. For more
information about administering your AnswerBook2 server, see
Installing and Administering an AnswerBook2 Server from the
AnswerBook2 viewer or look at the ab2admin
man page (% man ab2admin
).
If you already run an httpd server, such as Sun WebServer, 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 Installing and Administering an AnswerBook2 Server from the AnswerBook2 viewer.
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 commands, 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 Installing
and Administering an AnswerBook2 Server from the AnswerBook2 viewer.
To install document collection packages onto your server from the Solaris 8 Admin Pack Documentation CD:
Log in as superuser on the documentation server machine.
Insert the Solaris 8 Admin Pack Documentation CD into your CD-ROM drive.
The Volume Manager should mount the CD automatically.
Go to the location of the document collection packages.
For example, you might type a command similar to the following to go to the location on a CD of the document collection packages:
# cd /cdrom-mount-point/common/Product/
where cdrom-mount-point is the mount-point, including volume name, for the CD-ROM device.
Launch the installation utility.
For example, type:
# pkgadd -d .
Select from the following collections, listed by package name.
Package | Collection Title |
SUNWabau
|
Sun Enterprise Authentication Mechanism Collection |
SUNWpppab
|
Solstice PPP 3.0.1 Collection |
SUNWinsu
|
Solaris 8 Admin Pack Collection |
The document collection packages included on this CD include a post-install script that adds the collections to the server's database and restarts the server. For information about adding other document collections to the server's database, see Adding Book Collections to the AnswerBook2 Server's Database.
When you install the AnswerBook2 server software, it looks for document collections that are installed on your system. If you install document collections from other locations (such as other Sun product CDs or Sun web sites), the installation process might not automatically add them to the server's database. If you need to add document collections to your server's database (assuming the collections have been installed through some installation utility):
To have the AnswerBook2 server add all collections that are installed on your
system to its database, use the
/usr/lib/ab2/bin/ab2admin -o scan
command.
This function is part of the standard AnswerBook2 server software installation
process and works only for document collection packages installed on the
server's system.
To add a specific document collection to the AnswerBook2 server's database, use the following command:
# /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).
To serve document collections located on some other system, use the
/usr/lib/ab2/bin/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# /usr/lib/ab2/bin/ab2admin -o add_coll -d /net/other/books/SUNWdtad/collinfo
To run an AnswerBook2 server directly from the CD, perform the following steps:
Insert the Solaris 8 Admin Pack Documentation CD into the CD-ROM drive.
Change the directory to the top level of the CD-ROM volume.
Among other things, this directory contains the executable script
ab2cd
.
Run the following command (or double-click the ab2cd
icon):
# ./ab2cd
This command causes an AnswerBook2 server process to start running on your system, using the AnswerBook2 software and document collections included on the CD.
To view the documentation, launch any HTML 3.2-compliant web browser and go to the following URL:
http://server:port
where server is the name of the machine to which the CD is attached and port is the port on which the server is running and defaults to 8888.
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 document collections installed on this system and add them to its database.
To stop running the server from the CD, run the following command:
# /cdrom-mount-point/ab2cd stop
where cdrom-mount-point is the mount-point, including volume name, for the CD-ROM device.
For more information about the ab2cd
command, see the
ab2cd
man page that installs with the
Solaris 8 operating environment.
The AnswerBook2 Server running from the CD attempts to run 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.
At this point, you can do one of two things:
Start the ab2cd
server on a different port.
Use the following command:
% ab2cd -p port
where port is the port number on which to run the ab2cd
server.
Shut down the existing server.
Use the following command:
# /usr/lib/ab2/bin/ab2admin -o stop
The ab2cd
utility is a "read-only" AnswerBook2 documentation server. You cannot "administer" an AnswerBook2 server that is running from the CD.
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.
This section identifies known problems getting up and running with the AnswerBook2 server or the ab2cd utility. For complete AnswerBook2 troubleshooting information, see the "Solving AnswerBook2 Problems" in Installing and Administering an AnswerBook2 Server from the AnswerBook2 viewer.
If you see this... | Respond this way... |
---|---|
Library Page shows only a subset of available collections. | If you installed collections, and only some users see them, remind the users to redefine their Personal Library Preferences. |
Library Page shows only the AnswerBook2 Help Collection. | The AnswerBook2 Server comes with Help by default. You have to install other collections and add them to the server's database. For more information, see Using pkgadd to Install Book Collections and Adding Book Collections to the AnswerBook2 Server's Database. |
Library Page displays only the navigation bar and no document collections. | Verify that the collection template file (/usr/lib/ab2/dweb/data/config/ab2_collections.template) does not contain empty or duplicate entries. If the errors persist, you may have to reinstall the server software as described in Using pkgadd to Install AnswerBook2 Server Software. |
A search for locally-installed document collections does not find document collections that are installed on a local mount point. | Verify that the directory into which the collections are installed has read access set for others . |
Error message: AnswerBook2 server software not found at path %s. | You gave an incorrect path name to the ab2cd command or gave it no path, but were not in its current directory. |
Error message: Missing required options. | You used the ab2cd command with invalid options. See the ab2cd man page for details about the ab2cd command options. |
Error message: Error opening /cdrom/sol_8_doc@Ab2PrintProcess: Read-only file system. | You tried to print from an ab2cd-based server and accepted the default path for saving a file. Either change your browser settings or type in a different path. For information on changing browser settings to support printing from an AnswerBook2 server, see "Changing Printing Options" in the AnswerBook2 Help. |