Befehl "catman"

Online bearbeiten

Zweck

Erstellt die cat-Dateien für das Handbuch.

Syntax

Catman [ -n | -p | -w ] [ -M Pfad ] [ Abschnitt ... ]

Beschreibung

Der Befehl catman erstellt die vorformatierten Versionen des Onlinehandbuchs aus den Eingabedateien des Befehls nroff. Der Befehl catman untersucht jede Handbuchseite und erstellt die Seiten neu, deren vorformatierte Versionen fehlen oder veraltet sind. Wenn Änderungen vorgenommen werden, erstellt der Befehl catman die whatis-Befehlsdatenbank erneut.

Flags

Element Beschreibung
-M Pfad Aktualisiert Handbuchseiten, die sich in den mit der Variablen Pfad angegebenen Verzeichnissen befinden (standardmäßig das Verzeichnis /usr/share/man). Die Variable Pfad wird in Form einer durch Doppelpunkten (:) getrennten Liste von Verzeichnisnamen angegeben. Beispiel:
'/usr/local/man:/usr/share/man'

Wenn die Umgebungsvariable MANPATH gesetzt ist, wird deren Wert als Standardpfad verwendet. Angenommen, die Quellendatei des Befehls nroff enthält eine Zeile wie die folgende:

' .so manx/yyy.x'

In diesem Fall wird im Verzeichnis catx ein symbolischer Link zur entsprechenden vorformatierten Handbuchseite erstellt. Dies ermöglicht eine einfache Verteilung der vorformatierten Handbuchseiten an eine Gruppe zugehöriger Maschinen mit dem Befehl rdist.

Die Quellen des Befehls nroff müssen nicht an alle Maschinen verteilt werden, wodurch der entsprechende Speicherplatz eingespart wird.

Angenommen, in einem lokalen Netz mit fünf Maschinen (genannt mach1 bis mach5) enthält mach3 die Quellen des Befehls nroff für die Handbuchseiten. Jede Nacht wird auf mach3 der Befehl catman mit dem Dämon cron und später der Befehl rdist mit einer distfile-Datei ausgeführt wird, die folgendermaßen aussieht:

MANSLAVES = (mach1 mach2 mach4 mach5)
MANUALS = (/usr/share/man/cat[1-8no] /usr/share/man/whatis)
${MANUALS}    ->    ${MANSLAVES}
install -R;
notify root;
-N Verhindert die Erstellung der whatis-Befehlsdatenbank.
-p Gibt die Namen der Handbuchseiten aus, die neu erstellt oder aktualisiert werden müssen, ohne sie neu zu erstellen oder zu aktualisieren.
-w Liest die Berkeley Software Distribution (BSD) -Handbuchseiten in /usr/share/man/cat?/*.* und /usr/share/man/man?/*.* und liest dann die Hypertextinformationsbasen und erstellt die Datenbank /usr/share/man/whatis .

Tipp: Wenn die EN_US-Basisdokumentationsdateigruppe auf dem System installiert ist, setzen Sie ilocale auf en_US, um eine vollständige whatis-Datenbank zu erstellen.

Beispiele

Geben Sie Folgendes ein, um nur die Handbuchabschnitte 1, 2 und 3 zu aktualisieren:

catman 123

Dateien

Element Beschreibung
/usr/lbin/getNAME Enthält den Befehl zum Erstellen der whatis-Datenbank.
/usr/share/man Gibt die Standardverzeichnisposition für die Handbücher an.
/usr/share/man/man?/*.* Enthält die unformatierten (Eingabe für den Befehl nroff) Handbuchabschnitte.
/usr/share/man/cat?/*.* Enthält vorformatierte Handbuchseiten.
/usr/share/man/whatis Enthält die whatis-Befehlsdatenbank.
/usr/lbin/mkwhatis Enthält das Befehlsscript zum Erstellen der whatis-Befehlsdatenbank.