Man

Manpages

• Manpages sind ein komfortabel zu benutzendes Hilfesystem und stehen für fast alle Linux-Befehle zur Verfügung
  
• Geben Sie einfach den Befehl man, gefolgt von dem zu erklärenden Befehl, auf der Kommandozeile ein, und schon erhalten Sie eine genaue Beschreibung.

Funktionsweise der Manpages

• Immer wenn Sie eine Manpage aufrufen, konsultiert das Programm man die in der Variablen $MANPATH enthaltenen Verzeichnisse. Hier können mehrere Verzeichnisse auf einmal hinterlegt sein
  
• In nach Sektionen unterteilten Unterverzeichnissenbefinden sich die Dateien der Manpages im komprimierten Zustand
  
• Das Mansystem dekomprimiert die angeforderte Datei und übergibt sie anschließend an einen Pager. Dieser zeigt daraufhin die gewünschte Manpage an.

$MANPATH und die Datei manpath.config

• Wie bereits erwähnt, enthält die Variable $MANPATH Informationen darüber, wo sich die Manpages überhaupt befinden
  
• Genauere Informationen darüber erhalten Sie in der Konfigurationsdatei /etc/manpath.config. Wenn dem System neue Manpages hinzugefügt werden, wird diese Datei normalerweise bei Bedarf auch automatisch aktualisiert
  
• Ein manueller Eingriff ist in der Regel nicht nötig. Um den aktuellen MANPATH zu ermitteln, geben Sie einfach das Kommando manpath ohne Parameter ein. Das Ergebnis sieht dann beispielsweise so aus:

archangel:/ # manpath
/usr/share/man:/usr/local/man:/usr/X11R6/man:/opt/gnome/share/man

• Ein weiterer wichtiger Pfad ist der, in dem das Mansystem seine Temporärdateien ablegt. Wie bereits erwähnt, sind Manpages im Rohformat komprimiert. Deshalb werden sie vor dem Anzeigen in ein temporäres Verzeichnis dekomprimiert
  
• In der Regel handelt es sich hierbei um das Verzeichnis /var/cache/man. Dieses Verzeichnis wird, gestützt durch den Daemon cron, zyklisch von catman bereinigt
  
• Um das Cache-Verzeichnis Ihres Computers ausfindig zu machen, geben Sie das Kommando manpath -c ein:

archangel:/ # manpath -c
/var/cache/man:/var/cache/man/local:/var/cache/man/opt

Die Sektionen des Mansystems

Das Mansystem ist in mehrere Sektionen unterteilt. Diese Sektionen sind folgendermaßen gegliedert:

• ausführbare Programme für Benutzer
• Systemaufrufe (Funktionen, die durch den Kernel unterstützt werden)
• Bibliothekaufrufe (Libraries)
• besondere Dateien (normalerweise in /dev)
• Dateiformate und Konventionen
• Spiele
• Sonstiges (Makro-Pakete und Konventionen)
• administrative Programme (nur für den User root)
• Kernel-Routinen (nicht standardisiert)

Aufbau von Manpages

Der Aufbau einer Manpage ist festgelegt und sollte immer die folgenden Elemente enthalten:

• Name – die Bezeichnung des Elements mit einer kurzen Beschreibung
• Synopsis – eine vollständige Kurzbeschreibung der Syntax
• Description – eine ausführliche Beschreibung des Elements
• Defaults – voreingestellte Parameter
• Overview – ein Überblick über die komplexeren Zusammenhänge
• Options – Optionen und deren Beschreibung
• Return Values – Informationen über eventuelle Rückgabewerte, teilweise auch als Exit-Status bezeichnet
• See also – Verweise auf artverwandte Themen
• Bugs – bekannte Fehler
• Files – Konfigurationsdateien u. Ä.

Es sind noch mehr Elemente denkbar, aber die hier aufgeführten sind die wohl geläufigsten.