man(5)

NAME
manpath - Format der /etc/manpath.config Datei

BESCHREIBUNG
Die beschriebene Konfigurationsdatei wird von man, mandb und manpath benutzt, um den Benutzer-Manualpfad zur Laufzeit zu bestimmen und um den globale Manualhierarchien die zugehörigen cat-Verzeichnisse zuzuordnen.

FORMAT
Die folgenden Feldtypen werden erkannt:

MANDATORY_MANPATH Manualpfad
    Zeilen dieser Form zeigen die Manualpfade an, die jede automatisch generierte $MANPATH Variable beinhalten sollte.

MANPATH_MAP Pfad Manualpfad
    Zeilen dieser Form wandeln $PATH in die entsprechende $MANPATH Syntax um. $MANPATH wird um die zu Pfade ergänzt, die zu den Pfaden in $PATH korrespondieren. Dies überschreibt nicht die Umgebungsvariable $MANPATH, wenn diese gesetzt ist.

MANDB_MAP Manualpfad [cat-Pfad]
    Zeilen dieser Form geben die Manualpfade an, die als global angesehen werden. Normalerweise beinhalten diese die systemweit lesbaren Manualpfade in /usr. Zum Vorteil des System-Administrators kann jedes Verzeichnis, in das man schreiben kann, als cat-Pfad definiert werden. Um den FSSTND einzuhalten, kann das Schlüsselwort `FSSTND' anstelle eines Verzeichnisses benutzt werden. In diesem Fall verwendet man das zugehörige FSSTND compliante Verzeichnis. Wenn cat-Pfad fehlt, übernimmt cat-Pfad den Wert von Manualpfad. Diese Funktion ist auch mit Nicht- Linux-FSSTND complianten Systemen möglich. Es ist notwendig, alle globalen Manualpfade, einschließlich spezieller Pfade auf anderen Systeme, wie z. B. /usr/man/sun, und alle lokale Pfade, wie /usr/man/de_DE.88591, anzugeben. Für man ist es notwendig, daß diese Pfade existieren, um dort cat-Dateien zu erstellen. Zusätzlich ist es notwendig, daß Manualpfade, die wiederum in anderen Manualpfaden enthalten sind, zuerst aufgezählt werden. Also muß z. B. /usr/man/de_DE.88591 vor /usr/man aufgelistet werden. Wenn cat-Seiten nicht ständig benötigt werden, kann der cat-Pfad entfallen. Dabei ist zu beachten, daß die Verzeichnisse <Manualpfad>/cat* nicht existieren. Um das Erzeugen von cat-Seiten zeitweilig zu unterbinden, kann man das Schreiben in die cat-Verzeichnisse verbieten. Wenn cat-Pfad auf ein ungültiges Verzeichnis wie /dev/null gesetzt wird, hat dies den gleichen Effekt. Dadurch wird aber der Zugriff der Manual-Hilfsprogramme auf die Indexdatenbank dieses Manualpfades verweigert.

HINWEIS
Es ist wichtig, daß diese Regeln genau befolgt werden, damit die Manual-Hilfsprogramme wie gewünscht funktionieren.