Installieren und Verwalten eines AnswerBook2-Servers

Anhang A `ab2admin(1M)` Hilfeseite

ab2admin(1M)

Name

ab2admin- Befehlszeilenoberfläche für AnswerBook2-Verwaltung

SYNOPSIS

/usr/lib/ab2/bin/ab2admin

-h

Befehl

-o

Befehl

Argumente

DESCRIPTION

Bei dem Befehl ab2admin handelt es sich um eine Befehlszeilenoberfläche zur Verwaltung der AnswerBook2-Dokumentationen auf einem festgelegten AnswerBook2-Server. Mit dem Befehl können Sie AnswerBook1- und AnswerBook2-Dokumentationen auf einem Server installieren und deinstallieren; Sie können nach lokal installierten Dokumentationen suchen und die Serverdatenbank aktualisieren. Darüber hinaus können Sie eine Liste der Dokumentationen und Bücher erstellen.

ab2admin-Funktionen zur Serververwaltung umfassen folgendes: Anhalten des Servers, Starten des Servers, Neustarten des Servers, Aktivieren bzw. Deaktivieren der Server-Protokolldateien und Rotieren der Protokolldateien. Der Server kann mit Verweisen auf Bücher konfiguriert werden, die sich auf anderen AnswerBook2-Servern befinden.

ab2admin kann außerdem zur Steuerung des Serverzugriffs durch Hinzufügen von Benutzern zu oder Löschen von Benutzern vom Pool der Verwaltungsbenutzer verwendet werden. Die Zugriffssteuerung kann aktiviert oder deaktiviert werden.

Mit ab2admin kann eine Verbindung zu einem beliebigen AnswerBook2-Server (lokal oder entfernt) hergestellt werden. Bestimmte Funktionen (z.B. stop, start und restart) gelten nur für den lokalen AnswerBook2-Server. Wenn der AnswerBook2-Server paßwortgeschützt ist, sind zum Öffnen einer Verwaltungsaufgabe eine Benutzer-ID und ein Paßwort erforderlich.

Um ab2admin interaktiv auszuführen, geben Sie von der Befehlszeile ab2admin ein und anschließend die Befehle, zu deren Eingabe Sie aufgefordert werden. Der Befehl kann auch komplett anhand der Option -o von der Befehlszeile ausgeführt werden.

OPTIONS

Folgende Optionen werden unterstützt:

-h [ Befehl ]: Anzeige der Hilfe und spezieller Hilfe zu einem Befehl.
-o Teilbefehl[ Argumente]: Die unterstützten Teilbefehle sind nachstehend aufgeführt.

Teilbefehle

Folgende Teilbefehle der Option -o werden unterstützt:

access_off [ - mServer] [ -p Server_Anschlußnummer]: Deaktivierung der Protokolldatei für den Serverzugriff.
access_on [ -m Server ] [ -p Server_Anschlußnummer]: Aktivierung der Protokolldatei für den Serverzugriff.
add_admin -u Benutzer_id[ -m Server ] [ -p Server_Anschlußnummer]: Hinzufügen eines Benutzers zur autorisierten Liste der Serververwalter.
add_coll -d Pfad [ -m Server ] [ -p Server_Anschlußnummer]: Hinzufügen von AnswerBook1- oder AnswerBook2-Dokumentationen zu der angegebenen AnswerBook2-Serverdatenbank.
add_server -M alternativer_Server -P alternative_Server_Anschlußnummer [ -m Server ] [ -p Server_Anschlußnummer]: Hinzufügen eines alternativen Servers zum angegebenen Server.
auth_off [ -m Server ] [ -p Server_Anschlußnummer]: Deaktivierung der Überprüfung der Serververwaltung.
auth_on [ -m Server ] [ -p Server_Anschlußnummer]: Aktivierung der Überprüfung der Serververwaltung.
autostart_no [ -m Server ] [ -p Server_Anschlußnummer]: AnswerBook2-Server wird nicht automatisch gestartet, wenn das System (neu) gebootet wird.
autostart_yes [ -m Server ] [ -p Server_Anschlußnummer]: AnswerBook2-Server wird automatisch gestartet, wenn das System (neu) gebootet wird.
browser [ -m Server ] [ -p Server_Anschlußnummer]: Starten eines Web-Browsers, um auf die Seiten von AnswerBook2-Verwaltung zuzugreifen.
change_password -u Verwaltungs_ID[ -m Server ] [ -p Server_Anschlußnummer]: Paßwort des autorisierten Verwalters wird geändert.
del_admin -u Benutzer_id[ -m Server ] [ -p Server_Anschlußnummer]: Löschen eines Benutzers aus der Liste der autorisierten Serververwalter.
del_coll -t Titel_Dokumentation [ -m Server ] [ -p Server_Anschlußnummer]: AnswerBook1- oder AnswerBook2-Dokumentationen werden aus der angegebenen Serverdatenbank entfernt.
del_server -M alternativer_Server -P alternative_Server_Anschlußnummer [ -m Server ] [ -p Server_Anschlußnummer]: Alternativer Server wird von der Liste der Server entfernt, die dem angegebenen Server bekannt sind.
error_off [ -m Server ] [ -p Server_Anschlußnummer]: Deaktivierung der Protokolldatei für Serverfehler.
error_on [ -m Server ] [ -p Server_Anschlußnummer]: Aktivierung der Protokolldatei für Serverfehler.
help [ Befehl]: Auflistung sämtlicher Informationen zu einem bestimmten Befehl oder zu allen Befehlen.
list [ -m Server ] [ -p Server_Anschlußnummer]: Auflistung der auf dem angegebenen Server verfügbaren AnswerBook1- und AnswerBook2-Dokumentationen. Diese Liste umfaßt die Bücher, die in den Dokumentationsreihen enthalten sind.
list_server [ -m Server ] [ -p Server_Anschlußnummer]: Auflistung sämtlicher alternativer Server, die für den angegebenen Server definiert sind.
menu: Anzeige einer zusammengefaßten Liste der Befehlsoptionen.
modify_server_name -s neuer_Servername [ -m Server ] [ -p Server_Anschlußnummer]: Servername wird geändert.
modify_server_port -a neue_Server_Anschlußnummer [ -m Server ] [ -pServer_Anschlußnummer]: Server-Anschlußnummer wird geändert.
restart: Lokaler AnswerBook2-Server wird neu gestartet. Root-Zugriff erforderlich.
rotate_access [ -m Server ] [ -p Server_Anschlußnummer]: Protokolldatei für Serverzugriff wird gespeichert und zurückgesetzt.
rotate_error [ -m Server ] [ -p Server_Anschlußnummer]: Protokolldatei für Serverfehler wird gespeichert und zurückgesetzt.
scan [ -m Server ] [ -p Server_Anschlußnummer]: Suche nach lokal installierten Dokumentationen (AnswerBook1 oder AnswerBook2) und Aktualisierung der Dokumentationen in der angegebenen Serverdatenbank.
start: Lokaler AnswerBook2-Server wird gestartet. Root-Zugriff erforderlich.
start -D: Lokaler AnswerBook2-Server wird im Fehlersuchmodus gestartet. Root-Zugriff erforderlich.
stop: Lokaler AnswerBook2-Server wird angehalten. Root-Zugriff erforderlich.
view_access [ -m Server ] [ -p Server_Anschlußnummer]: Anzeige des Inhalts der Protokolldatei für Serverzugriff.
view_config [ -m Server ] [ -p Server_Anschlußnummer]: Anzeige der Konfigurationseinstellungen des Servers.
view_error [ -m Server ] [ -p Server_Anschlußnummer]: Anzeige des Inhalts der Protokolldatei für Serverfehler.

VERWENDUNG

quit: Interaktiven Modus verlassen.
q: Interaktiven Modus verlassen.
bye: Interaktiven Modus verlassen.
exit: Interaktiven Modus verlassen.
? [Befehl]: Hilfe im interaktiven Modus erhalten.
h [Befehl]: Hilfe im interaktiven Modus erhalten.

EXAMPLES

Beispiel 1 Auflistung der auf einem Server verfügbaren AnswerBook2-Dokumentationen

So listen Sie die auf einem Server mit der Bezeichnung foo.com verfügbaren Dokumentationen auf, und zwar anhand der Anschlußnummer 8888:

example% ab2admin -o list -m foo.com -p 8888

Beispiel 2 Verwendung des interaktiven Modus zum Auflisten der Dokumentationen

So verwenden Sie ab2admin im interaktiven Modus für die oben beschriebenen Vorgänge:

example% ab2admin
>> list -m foo.com -p 8888

Beispiel 3 Installation einer AnswerBook2-Dokumentationsreihe

So installieren Sie eine AnswerBook2-Dokumentationsreihe mit Hilfe des Dienstprogramms pkgadd:

example# pkgadd -dPaketverzeichnis/ SUNWabsdk

Die Verzeichnisstruktur für die Dokumentationsreihe wird (standardmäßig) in das System und das Verzeichnis /opt/answerbooks/ kopiert.

Beispiel 4 Installation einer nicht auf die Serverdatenbank aktualisierten AnswerBook2-Dokumentationsreihe

So installieren Sie eine AnswerBook2-Dokumentation, die im System eingeführt wurde (anhand von pkgadd), jedoch nicht auf die Serverdatenbank aktualisiert wurde:

example# ab2admin -o add_coll -d
/opt/answerbooks/german/solaris_2.6/SUNWabsdk

(Hinweis: -d Pfad muß die Datei collinfo (für eine AnswerBook2-Dokumentation) oder die Datei ab_cardcatalog (für eine AnswerBook1-Dokumentation) beinhalten.

Beispiel 5 Überprüfen der Definition einer AnswerBook1-Dokumentationsreihe

So überprüfen Sie, wie eine AnswerBook1-Dokumentationsreihe definiert ist:

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

Beispiel 6 Überprüfen der Definition einer AnswerBook2-Dokumentationsreihe

So überprüfen Sie, wie eine AnswerBook2-Dokumentationsreihe definiert ist:

example% cat/opt/answerbooks/german/solaris_2.6/SUNabsd/collinfo
dwCollections {
  coll.45.4 dwCollection
}
dwSetParam coll.45.4 {
  location /opt/answerbooks/german/solaris_2.6/SUNWabsdk
  title "Solaris 2.6 Software Developer AnswerBook Vol 1"
  type EbtCollection
}

FILES

/var/log/ab2/catalog/local.socat: Katalogdatei
/var/log/ab2/catalog/remote.socat: Katalogdatei
/var/log/ab2/catalog/delegate.socat: Katalogdatei
/var/log/ab2/catalog/libcat.socat: Katalogdatei
/var/log/ab2/logs/access_8888.log: Standardmäßige Zugriffsprotokolldatei
/var/log/ab2/logs/errors_8888.log: Standardmäßige Fehlerprotokolldatei
/usr/lib/ab2/dweb/data/config/ab2_collections.template: Datenbank für AnswerBook2-Dokumentationen
/var/log/ab2/catalog/ab1_cardcatalog: Datenbank für AnswerBook1-Dokumentationen
/usr/lib/ab2/dweb/data/config/admin_passwd: Datei mit Benutzername:Paßwort

ATTRIBUTES

Siehe Attribute(5) für eine Erläuterung folgender Attribute:

ATTRIBUTTYP	ATTRIBUTWERT
Verfügbarkeit	`SUNWab2u`

Anhang A ab2admin(1M) Hilfeseite