catman(8) Manpage

catman wird benutzt, um einen aktuellen Satz von vorformatierten Manualseiten zu erzeugen, die als cat-Seiten bezeichnet werden. Die cat-Seiten werden wesentlich schneller angezeigt als die unformatierten Manualseiten, benötigen aber zusätzlichen Speicherplatz auf der Festplatte. Die Entscheidung zur Unterstützung von cat-Seiten liegt beim lokalen Administrator, der für diese Seiten passende Verzeichnisse anlegen muß.

Die Optionen für catman geben die Manualseiten und die Abschnitte an, die vorformatiert werden sollen. Im Normalfall werden die Manualseiten verwendet, die in der Manualkonfigurationsdatei beschrieben sind. Normalerweise werden die Abschnitte formatiert, die entweder in der Umgebungsvariable $MANSEC stehen oder fest in man(1) einkompiliert sind, wenn $MANSEC undefiniert ist. Wird catman eine durch Whitespace abgetrennte Liste von Abschnitten übergeben, so werden nur die Manualseiten in den betreffenden Abschnitten bearbeitet.

Um festzustellen, welche Dateien formatiert werden müssen, macht catman Gebrauch von den Indexdatenbanken der jeweiligen Manualseiten.

man(1), manpath(5), mandb(8).

Auf Systemen mit kleinem (~4 kByte) Zwischenspeicher für Argumente von execve(2) kann es nötig sein, daß catman mehrere kleine im Gegensatz zu wenigen großen Batchjobs ausführen muß. In diesem Fall ist es für man möglich, diesen Eintrag (korrekt) aus einer Datenbank zu löschen (vielleicht existiert er in Wirklichkeit gar nicht mehr), der vom aktuellen Aufruf von catman benötigt wird, um die nächste Seite zu bestimmen. Wenn die Indexdatenbank einen Hashtable-Lookup (ndbm, gdbm) benutzt, führt dies zu einem `sich am eigenen Schopf aus dem Sumpf ziehen'. Obgleich dies selten auftritt, führt es dazu, daß catman nicht mehr die weiteren Seiten des Abschnittes bearbeitet.

Hinweis: Linux hat einen Zwischenspeicher von 128 kByte für execve (2) Argumente.

“	As soon as we started programming, we found to our surprise that it wasn't as easy to get programs right as we had thought. Debugging had to be discovered. I can remember the exact instant when I realized that a large part of my life from then on was going to be spent in finding mistakes in my own programs.	”
— Maurice Wilkes

-d, --debug
	Ausgeben von Fehlerinformationen.
-M Pfad, --manpath=Pfad
	Gibt einen alternativen Manualpfad an. Als Default sind dies alle Pfade, die in der Manualkonfigurationsdatei als global deklariert sind. Die Umgebungsvariable $MANPATH wird von catman nicht benutzt.
-h, --help	Zeigt einen Hilfstext an.
-V, --version
	Zeigt Programmversion und Autor an.

/var/catman/.../index.(bt\|db\|dir\|pag)
	Die FSSTND complianten globalen Indexdatenbanken.
/usr/man/.../whatis
	Traditionelle whatis Datenbank.

Manpage — catman

NAME

INHALT

SYNTAX

BESCHREIBUNG

OPTIONEN

DATEIEN

SIEHE AUCH

FEHLER

AUTOR