Home · Kontakt · Impressum
contents index previous up next
Next: 6.1.2 man Up: 6.1 Lokale Dokumentation Previous: 6.1 Lokale Dokumentation


6.1.1 Das Handbuch: Manual-Pages

Die Manual-Pages, auch oft Man-Pages genannt, sind praktisch das Handbuch zu Linux und den dazugehörigen Tools. Für fast jedes Programm der Shell gibt es eine solche ``Handbuchseite''. Neben Programmen gibt es auch Man-Pages für Konfigurationsdateien, Systemaufrufe u.a. Diese Dokumentationen sind nicht gerade benutzerfreundlich, da sie mehr als Referenz für die Syntax gedacht sind und nicht als Online-Tutorial.

Für die Verwendung der Manual-Pages wird das Tool man (6.1.2) verwendet. Dieses Tool sucht den passenden Hilfetext heraus und stellte ihn durch einen Textbetrachter dar. In den meisten Fällen ist less der Pager.

Die Hilfetexte sind in mehrere Texte aufgeteilt, wie in Tabelle 6.2 zu sehen. Es muß aber nicht unbedingt jeder Abschnitt in dem Text vorkommen.


Tabelle 6.2: Die Abschnitte in den Manual-Pages
Abschnitt Beschreibung
NAME Name und kurze Beschreibung des Kommandos
SYNOPSIS Anwendung und Syntax des Kommandos
DESCRIPTION Beschreibung des Kommandos und seiner Optionen
OPTIONS Liste aller Optionen mit Kurzbeschreibung
SEE ALSO Manual-Pages zu verwandten Inhalten
DIAGNOSTICS Beschreibung von Fehlermeldungen
FILES Liste der Dateien, die von dem Kommando verwendet werden
BUGS Bekannte Probleme
HISTORY Meilensteine der Programmentwicklung
AUTHOR Autor des Programms und Mitarbeiter


Die Handbuchseiten liegen als gezippte ASCII-Code vor, die in einem speziellen Format geschrieben wurden. Das Programm groff kann diese Seiten für die Ausgabe aufbereiten. Die Dateien für die Manual-Pages können in verschiedenen Pfaden liegen. Generell ist dies der Pfad /usr/share/man. Bei älteren Distribution liegen die Hilfetexte im Verzeichnis /usr/man. Die Umgebungsvariable MANPATH enthält die Pfade zu den Hilfetexten. Für die Ermittlung der Verzeichnisse kann auch der Befehl manpath verwendet werden.

tapico@defiant:~ > echo $MANPATH
/usr/local/man:/usr/share/man:/usr/X11R6/man:/opt/gnome/man

In diesen Verzeichnissen existieren mehrere Unterverzeichnisse für die neun ``Kapitel'' der Manual-Pages. Am wichtigsten für Administratoren sind die Kapitel 1, 5 und 8. Eine Übersicht über die Kapitel liefert die Tabelle 6.3. Da einige Themen in mehreren Kapiteln vorkommen können, wird die Kapitelnummer bei Verweisen aufs Handbuch in Klammern hinter das Thema geschrieben. Sie finden also die Informationen zu dem Befehl passwd in der Manual-Page passwd(1) und zu der Datei /etc/passwd in der Manual-Page unter passwd(5). Es können durch Programme aber noch weitere Kapitel hinzugefügt werden, wie Sie es im folgenden Beispiel sehen. Für die SSL-Verschlüsselung gibt es auch ein Passwort-Tool.

enterprise:~ # whatis passwd
passwd (1ssl)        - compute password hashes
passwd (1)           - change user password
passwd (5)           - The password file


Tabelle 6.3: Die neun ``Kapitel'' der Manual-Pages
Verzeichnis Beschreibung
man1 Ausführbare Programm oder Shell-Kommandos für den Benutzer
man2 Systemaufrufe (Kernelfunktionen)
man3 Bibliotheksaufrufe (Funktionen mit Systembibliotheken)
man4 Spezielle Dateien (meistens Gerätedateien in /dev)
man5 Dateiformate und Konfigurationsdateien
man6 Spiele
man7 Diverses, Makropakete, Konventionen, Netzwerkprotokolle
man8 Systemadministrationskommandos
man9 Kernelroutinen (kein Standard)


Neben den normalen Benutzerbefehlen (man1), den Systemverwalterbefehlen (man8) und den Dateiformaten (man5), gibt es noch weitere wichtige Kapitel. So enthält Kapitel 7 auch Informationen über die Implementierung der Netzwerkprotokolle.

enterprise:~ # whatis tcp udp ip arp
tcp (7)              - TCP protocol.
udp (7)              - User Datagram Protocol for IPv4
ip (7)               - Linux IPv4 protocol implementation
ip (8)               - show / manipulate routing, devices, policy routing and tunnels
arp (7)              - Linux ARP kernel module.
arp (8)              - manipulate the system ARP cache

Wenn nun über den Befehl man eine Seite zu einem Thema angefordert wird, wird die erste Seite angezeigt, die gefunden wird. Dabei werden die Kapitel in der Reihenfolge
  1, 8, 2, 3, 4, 5, 6, 7, 9 
durchsucht. Deshalb findet man z. B. bei dem Aufruf von passwd immer das gleichnamige Tool. Um die Beschreibung der Benutzerliste /etc/passwd zu bekommen, muß explizit die Kapitelnummer angegeben werden.


contents index previous up next
Next: 6.1.2 man Up: 6.1 Lokale Dokumentation Previous: 6.1 Lokale Dokumentation
  © 2004 by IT-Dozent Ole Vanhoefer · Zum Seitenanfang