manpages.info - online man pages   

SunOS man pages : ab2admin (1)

Maintenance Commands                                 ab2admin(1M)

NAME

ab2admin - command-line interface for AnswerBook2 adminis- tration

SYNOPSIS

/usr/lib/ab2/bin/ab2admin [ -h [ command ] ] [ - o command [ arguments ] ]

DESCRIPTION

The ab2admin command is a command-line interface for admin- istering AnswerBook2 collections and documents on a speci- fied AnswerBook2 server. The command can install and unin- stall 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 res- tart) 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 com- mand line and then enter commands as prompted. It can also be executed entirely from the command line using the -o option.

OPTIONS

The following options are supported: -h [command] Displays help and specified help on a command. -o sub-command [ arguments] The supported sub-commands are listed below. Sub-commands The following sub-commands to the -o option are supported: access_off [ -m server ] [ -p server_port_number ] SunOS 5.8 Last change: 25 Mar 1999 1 Maintenance Commands ab2admin(1M) Disables the server access log file. access_on [ -m server ] [ -p server_port_number ] Enables the server access log file. add_admin -u user_id [ -m server ] [ - p server_port_number ] Adds a user to the authorized list of server administrators. add_coll -d path [ -m server ] [ -p server_port_number ]" 6 Adds AnswerBook1 or AnswerBook2 collections to the specified AnswerBook2 server database. alternate_server_port_number add_server - M alternate_server -P [ -m server ] [ -p server_port_number ] Adds an alternate server to the specified server. auth_off [ -m server ] [ -p server_port_number ] Disables server administration verification. auth_on [ -m server ] [ -p server_port_number ] Enables server administration verification. autostart_no [ -m server ] [ -p server_port_number ] Stops AnswerBook2 server from starting automati- cally when system is (re)booted. autostart_yes [ -m server ] [ -p server_port_number ] Causes AnswerBook2 server to start automatically when system is (re)booted. browser [ -m server ] [ -p server_port_number ] Launches a web browser for accessing AnswerBook2 Administration pages. server_port_number ] change_password -u admin_id [ - m server ] [ -p Changes authorized administrator's password. del_admin -u user_id [ -m server ] [ - p server_port_number ] Deletes a user from the list of authorized server administrators. server_port_number ] del_coll -t collection_title [ - m server ] [ -p SunOS 5.8 Last change: 25 Mar 1999 2 Maintenance Commands ab2admin(1M) Removes AnswerBook1 or AnswerBook2 collections from the specified server's database. alternate_server_port_number del_server - M alternate_server -P [ -m server ] [ -p server_port_number ] Deletes alternate server from list of servers known to the specified server. error_off [ -m server ] [ -p server_port_number ] Disables the server error log file. error_on [ -m server ] [ -p server_port_number ] Enables the server error log file. help [ command] Lists all information about a particular command or all commands. list [ -m server ] [ -p server_port_number ] Lists AnswerBook1 and AnswerBook2 collections available on the specified server. The listing includes the books contained within collections. list_server [ -m server ] [ -p server_port_number ] Lists all alternate servers defined for the specified server. menu Displays a condensed list of command options. server_port_number ] modify_server_name -s new_server_name [ - m server ] [ -p Modifies the server's name. modify_server_port -a new_server_port_number [ - m server ] [ -p server_port_number ] Modifies the server's port number. restart Restarts local AnswerBook2 server. Requires root access. rotate_access [ -m server ] [ -p server_port_number ] Saves and resets the server access log file. rotate_error [ -m server ] [ -p server_port_number ] Saves and resets the server error log file. SunOS 5.8 Last change: 25 Mar 1999 3 Maintenance Commands ab2admin(1M) scan [ -m server ] [ -p server_port_number ] Scans for locally installed collections (Answer- Book1 or AnswerBook2) and updates the collections on the specified server's database. start Starts local AnswerBook2 server. Requires root access. start -D Starts local AnswerBook2 server in debug mode. Requires root access. stop Stops local AnswerBook2 server. Requires root access. view_access [ -m server ] [ -p server_port_number ] Views the contents of the server access log file. view_config [ -m server ] [ -p server_port_number ] Views the configuration settings of the server. view_error [ -m server ] [ -p server_port_number ] Views the contents of the server error log file.

USAGE

quit Exit interactive mode. q Exit interactive mode. bye Exit interactive mode. exit Exit interactive mode. ? [command] Get help in interactive mode. h [command] Get help in interactive mode.

EXAMPLES

Example 1: Listing AnswerBook2 collections available on a server To list the collections available on a server named foo.com, using port number 8888: example% ab2admin -o list -m foo.com -p 8888 Example 2: Using interactive mode to list collections SunOS 5.8 Last change: 25 Mar 1999 4 Maintenance Commands ab2admin(1M) To use ab2admin in interactive mode for the same operation as shown above: example% ab2admin >> list -m foo.com -p 8888 Example 3: Installing an AnswerBook2 collection To install an AnswerBook2 collection using the pkgadd util- ity: example# pkgadd -d package_directory/ SUNWabsdk The collection directory structure will be copied into the system (by default) to /opt/answerbooks/ Example 4: Installing an AnswerBook2 collection not updated to server database To install an AnswerBook2 collection that has been intro- duced 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). Example 5: Inspecting the definition of an AnswerBook1 col- lection 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 Example 6: Inspecting the definition of an AnswerBook2 col- lection 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 } SunOS 5.8 Last change: 25 Mar 1999 5 Maintenance Commands ab2admin(1M)

FILES

/var/log/ab2/catalog/local.socat Catalog file /var/log/ab2/catalog/remote.socat Catalog file /var/log/ab2/catalog/delegate.socat Catalog file /var/log/ab2/catalog/libcat.socat Catalog file /var/log/ab2/logs/access_8888.log Default access log file /var/log/ab2/logs/errors_8888.log Default error log file /usr/lib/ab2/dweb/data/config/ab2_collections.template AnswerBook2 collection database /var/log/ab2/catalog/ab1_cardcatalog AnswerBook1 collection database /usr/lib/ab2/dweb/data/config/admin_passwd File containing username:password

ATTRIBUTES

See attributes(5) for a discussion of the following attri- butes: ____________________________________________________________ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | |_____________________________|_____________________________| | Availability | SUNWab2u | |_____________________________|_____________________________|

SEE ALSO

attributes(5) SunOS 5.8 Last change: 25 Mar 1999 6