catman(1M)                                                       catman(1M)

NAME
     catman - Die "cat"-Dateien für die Online-Manpages erstellen

SYNTAX
     /usr/bin/catman [-v] [-f] [-n] [-m manpathdot] [-u] [-d altmandb]

BESCHREIBUNG
     Das Kommando catman erstellt die vorformatierten Versionen des
     Online-Handbuchs aus den nroff(1M)-Eingabedateien. Jede Online-
     Handbuchseite ("Manpage") wird geprüft, und die Seiten, deren vorfor-
     matierte Versionen fehlen oder veraltet sind, werden neu erstellt.
     Wenn Änderungen vorgenommen werden, erstellt catman die Datenbank
     mandb neu.

OPTIONEN
     -v   Die Option -v aktiviert die Testhilfe.

     -f   Die Option -f erzwingt die Erstellung von cat-Seiten, auch wenn
          die cat-Seite neuer ist.

     -n   Wenn die Option -n gesetzt ist, werden deutsche Umlaute in den
          nroff-Quelldateien durch ae, oe, ue usw. ersetzt.

     -u   Wenn die Option -u gesetzt ist, versucht catman nur, alle mandb-
          Dateien in dem Pfad neu zu erstellen, der von der Umgebungsvaria-
          blen $MANPATH angegeben wird.

     -d   Wenn die Option -d gesetzt ist, versucht catman NICHT, eine
          mandb-Datei in dem Pfad neu zu erstellen, der von der Umgebungs-
          variablen $MANPATH angegeben wird. Das Kommando ermittelt mit
          Hilfe von altmandb die zu erstellenden Dateien sowie die Art und
          Weise ihrer Erstellung (neqn, tbl, ...).

     Welche Verzeichnisse nach Manpages durchsucht werden, wird über die
     Umgebungsvariable $MANPATH oder über ihren Standardwert festgelegt:

          /usr/share/man/mrd:/usr/share/man:/usr/share/man/mrd/$LANG

     Es stehen zwei Methoden für die Suche nach Manpages zur Verfügung. Die
     jeweilige Suchmethode hängt davon ab, ob das oberste Verzeichnis ein
     Verzeichnis .mandb enthält.

     Wenn kein Unterverzeichnis .mandb gefunden wird, wird angenommen, daß
     es sich bei allen Dateien in den mit man beginnenden oder mit man
     endenden Unterverzeichnissen um Manpages handelt.

     Wenn ein Unterverzeichnis .mandb gefunden wird, werden die Manpages
     mit Hilfe von mandb lokalisiert. Wenn kein Unterverzeichnis mandb vor-
     handen ist oder ein Unterverzeichnis gefunden wird, das älter als die
     Änderungszeit von .mandb ist, wird mandb aus allen Dateien in .mandb
     erstellt. Mit Hilfe der Datei mandb werden Manpages lokalisiert.




Seite 1                      Reliant UNIX 5.44               Gedruckt 11/98

catman(1M)                                                       catman(1M)

     Achtung:  Obwohl altmandb ein absoluter Pfad sein kann, müssen die
               darin enthaltenen Pfade relativ zur Position von $MANPATH
               angegeben werden. $MANPATH muß ein Verzeichnis .mandb ent-
               halten, obwohl dessen Inhalt nicht explizit verwendet wird.

     Dieses Kommando verwendet beide cat-Seiten der Manpages. Eine Manpage
     ist eine mit einer Makrogruppe geschriebene nroff-Datei. Eine cat-
     Seite wird durch die Formatierung einer Manpage mit nroff erstellt.

     Eine cat-Seite mit folgendem Format:

          ./catman/somepath/filename.Z

     entspricht einer Manpage mit dem Format:

          ./somepath/filename

     Hierbei ist "." das oberste Suchverzeichnis. Wenn die Option -m
     manpathdot nicht verwendet wird, ist die entsprechende Manpage fol-
     gende:

          manpathdot/somepath/filename

     Standardmäßig werden alle cat-Seiten neu erstellt, die älter als vor-
     hande und entsprechende Manpages sind. Die Option -f erzwingt, daß
     alle cat-Seiten neu erstellt werden, die vorhandenen Manpages entspre-
     chen.

HINWEISE
     catman wertet zum Aufbau der mandb folgende Daten aus dem Kopf der
     nroff-Quelldateien aus: title, section und shortcomment [vgl.
     man(1)]. Zum Beispiel:

          .nr X 2
          .if \nX=0 .ds x} title section "" ""
          .if \nX=1 .ds x} title section ""
          .if \nX=2 .ds x} title section "" "\&"
          .TH \*(x}
          .SH NAME
          title \- shortcomment

UMGEBUNGSVARIABLEN
     MANPATH   Pfad, unter dem die mandb und die vorformatierten Manpages
               gesucht werden. Standard:
               /usr/share/man/mrd:/usr/share/man:/usr/share/man/mrd/$LANG.

     LANG      Umgebungsvariable für die Spracheinstellung. Standard:
               EnUS.ASCII.






Seite 2                      Reliant UNIX 5.44               Gedruckt 11/98

catman(1M)                                                       catman(1M)

     NROFF     Das verwendete Formatierprogramm nroff wird von der Umge-
               bungsvariablen $NROFF angegeben. Wenn $NROFF nicht vorhanden
               oder leer ist, wird /usr/ucb/nroff oder /usr/bin/nroff
               (falls /usr/ucb/nroff nicht vorhanden ist) verwendet.

DATEIEN
     /usr/share/man/mrd
          Standardposition des Manpage-Verzeichnisses

     /usr/share/man/mrd/EnUS.ASCII
          Verzeichnis für die englische mandb und die vorformatierten Man-
          pages

     /usr/share/man/mrd/DeDE.646
          Verzeichnis für die deutsche mandb und die vorformatierten Manpa-
          ges

     /usr/share/man/mrd/$LANG/mandb
          Pfad der kompletten mandb

     /usr/share/man/mrd/$LANG/.mandb
          Verzeichnis der Addon-Manpage-Pakete (werden für die komplette
          mandb benötigt)

     /usr/share/man/mrd/$LANG/catman
          Verzeichnis der vorformatierten und komprimierten Manpages
          (filename.Z)

SIEHE AUCH
     man(1), man(1-ucb), neqn(1M), nroff(1M), tbl(1M), man(5).
























Seite 3                      Reliant UNIX 5.44               Gedruckt 11/98