Manpage
Inhaltsverzeichnis
Manpage
Manpage steht für "manual page", also eine Handbuchseite. Auf UNIX-Systemen ist das die primäre Quelle für Dokumentation. Viele Leute erwarten, dass jemand, der eine Frage zu einem UNIX-Programm hat, zuerst die entsprechende Manpage liest. (Zuwiderhandlungen werden dann oft mit RTFM beantwortet.)
In Manpages ist Information (sofern sie darin vorhanden ist) oft schneller auffindbar und fast immer zuverlässiger als z. B. bei Google.
Manpages im Fakultätsnetz
Das Programm man
zeigt die Manpages an. Der Befehl
man man
zeigt die Hilfe zu man
an. Für das eigentliche Anzeigen verwendet man
normalerweise das Programm less
(siehe man less
), das sich mit q
beenden lässt. Setzt man die Umgebungsvariable PAGER
, so wird man
den Wert von PAGER
als Anzeigeprogramm verwenden. Beispiel:
PAGER=lynx man man
zeigt die Manpage zu man
im Textbrowser lynx an.
Alternativ kann auch Konqueror benutzt werden - einfach in der Adressleiste man:programm
Die Ausgabe ist optisch der des KDE-Help-Systems sehr ähnlich.
Die foo(x)
-Konvention
Oft wird auf ein UNIX-Programm foo
verwiesen als foo(x)
. x
ist dann meistens die Sektionsnummer, in der die Manpage zu dem Programm zu finden ist.
Manpages sind in Sektionen organisiert. Die genaue Liste dieser Sektionen variiert von System zu System, aber fast überall gibt es die folgenden:
Sektionsnummer | Themengebiet |
---|---|
1 | Programme |
2 | Systemfunktionen |
3 | Bibliotheksfunktionen |
5 | Konfigurationsdateien |
7 | Datenformate |
8 | Programme, für die man erhöhte Zugriffsrechte braucht |
In den meisten dieser Sektionen gibt es intro
-Seiten, die einen Überblick über die Sektion geben.
Will man nun die Manpage aus Sektion x
zu foo
lesen, dann lautet der entsprechende Aufruf
man -s x foo
Gibt man keine Sektion an, dann sucht man
nacheinander in jeder Sektion nach einer Manpage zu foo
, bis eine gefunden wird.
Verwandte nützliche Programme
whatis(1)
Eine Antwort auf die Frage "Was macht Programm foo
?" bekommt man durch Benutzung von whatis(1)
oft eine schnelle Antwort. Beispiel:
whatis man
liefert
man man (1) - find and display reference manual pages man man (5) - macros to format Reference Manual pages
apropos(1)
apropos(1)
findet Manpages (und damit Verweise zu passenden Programmen) zu einem Stichwort. Beispiel:
apropos 'logged in'
liefert
rusers rusers (1) - who is logged in on remote machines rwho rwho (1) - who is logged in on local machines users users (1b) - display a compact list of users logged in