Namn | SYNOPSIS | DESCRIPTION | OPTIONS | USAGE | EXAMPLES | FILES | ATTRIBUTES | SEE ALSO
The ab2admin command is a command-line interface for administering AnswerBook2 collections and documents on a specified AnswerBook2 server. The command can install and uninstall AnswerBook1 and AnswerBook2 collections to a server, scan for locally installed collections and update the server database, and obtain a listing of collections and books.
ab2admin server management functions include: stopping the server, starting the server, restarting the server, turning the server log files on or off, and rotating the log files. The server can be configured to resolve links to books located on other AnswerBook2 servers.
ab2admin can also be used to control server access by adding users to or deleting users from the pool of administrative users. The access control can be enabled or disabled.
ab2admin can connect to any AnswerBook2 server (local or remote). Certain functions (such as stop, start, and restart) apply only to the local AnswerBook2 server. If the AnswerBook2 server is protected by a password, then a user ID and password are required to initiate an administration task.
To run ab2admin interactively, type ab2admin from the command line and then enter commands as prompted. It can also be executed entirely from the command line using the -o option.
The following options are supported:
Displays help and specified help on a command.
The supported sub-commands are listed below.
The following sub-commands to the -o option are supported:
Disables the server access log file.
Enables the server access log file.
Adds a user to the authorized list of server administrators.
Adds AnswerBook1 or AnswerBook2 collections to the specified AnswerBook2 server database.
Adds an alternate server to the specified server.
Disables server administration verification.
Enables server administration verification.
Stops AnswerBook2 server from starting automatically when system is (re)booted.
Causes AnswerBook2 server to start automatically when system is (re)booted.
Launches a web browser for accessing AnswerBook2 Administration pages.
Changes authorized administrator's password.
Deletes a user from the list of authorized server administrators.
Removes AnswerBook1 or AnswerBook2 collections from the specified server's database.
Deletes alternate server from list of servers known to the specified server.
Disables the server error log file.
Enables the server error log file.
Lists all information about a particular command or all commands.
Lists AnswerBook1 and AnswerBook2 collections available on the specified server. The listing includes the books contained within collections.
Lists all alternate servers defined for the specified server.
Displays a condensed list of command options.
Modifies the server's name.
Modifies the server's port number.
Restarts local AnswerBook2 server. Requires root access.
Saves and resets the server access log file.
Saves and resets the server error log file.
Scans for locally installed collections (AnswerBook1 or AnswerBook2) and updates the collections on the specified server's database.
Starts local AnswerBook2 server. Requires root access.
Starts local AnswerBook2 server in debug mode. Requires root access.
Stops local AnswerBook2 server. Requires root access.
Views the contents of the server access log file.
Views the configuration settings of the server.
Views the contents of the server error log file.
Exit interactive mode.
Exit interactive mode.
Exit interactive mode.
Exit interactive mode.
Get help in interactive mode.
Get help in interactive mode.
To list the collections available on a server named foo.com, using port number 8888:
example% ab2admin -o list -m foo.com -p 8888 |
To use ab2admin in interactive mode for the same operation as shown above:
example% ab2admin >> list -m foo.com -p 8888 |
To install an AnswerBook2 collection using the pkgadd utility:
example# pkgadd -d package_directory /SUNWabsdk |
The collection directory structure will be copied into the system (by default) to /opt/answerbooks/
To install an AnswerBook2 collection that has been introduced to the system (via pkgadd) but did not get updated to the server database:
example# ab2admin -o add_coll -d /opt/answerbooks/english/solaris_2.6/SUNWabsdk |
(Note: -d path must include the collinfo file (for an AnswerBook2 collection) or the ab_cardcatalog file (for an AnswerBook1 collection).
To inspect how an AnswerBook1 collection is defined:
example% cat /opt/SUNWans/ab_cardcatalog :id=SUNWab_10_4: \ :version=: \ :title=Solaris XGL 3.1 AnswerBook: \ :tocpath=/net/elirium.Eng/export/answerbook/Solaris_2.4/SUNWAxg/toc: \ :pspath=/net/elirium.Eng/export/answerbook/Solaris_2.4/SUNWAxg/ps: \ :indexpath=/net/elirium.Eng/export/answerbook/Solaris_2.4/SUNWAxg/inde |
To inspect how an AnswerBook2 collection is defined:
example% cat/opt/answerbooks/english/solaris_2.6/SUNabsd/collinfo dwCollections { coll.45.4 dwCollection } dwSetParam coll.45.4 { location /opt/answerbooks/english/solaris_2.6/SUNWabsdk title "Solaris 2.6 Software Developer AnswerBook Vol 1" type EbtCollection } |
Catalog file
Catalog file
Catalog file
Catalog file
Default access log file
Default error log file
AnswerBook2 collection database
AnswerBook1 collection database
File containing username:password
See attributes(5) for a discussion of the following attributes:
ATTRIBUTE TYPE | ATTRIBUTE VALUE |
---|---|
Availability | SUNWab2u |
Namn | SYNOPSIS | DESCRIPTION | OPTIONS | USAGE | EXAMPLES | FILES | ATTRIBUTES | SEE ALSO