Manpage

Manpages (Abkürzung für Manual Page, deutsch: Handbuch-Seite) sind Hilfe- und Dokumentationsseiten unter UNIX und verwandten Betriebssystemen.

Die Manpage zu man

Die Manpage zu rxvt

Die Manpage zu xterm

Aufbau

Manpages sind durch POSIX standardisiert und waren unter UNIX ursprünglich in acht Bereiche unterteilt. Mittlerweile werden die folgenden Abschnitte als Standard angesehen:

• Abschnitt 1: Nutzerbefehle und Kommandos
  • Abschnitt 1m: Systemverwaltung
• Abschnitt 2: Systemaufrufe
• Abschnitt 3: Subroutinen und Bibliotheksaufrufe
  • Abschnitt 3pm: Perl-Module
  • Abschnitt 3tcl: Tcl-Module (stattdessen oft auch in Abschnitt n)
• Abschnitt 4: Dateiformate (BSD: Treiber- und Netzwerk-Schnittstellen)
• Abschnitt 5: Header, Tabellen und Makropakete (BSD: Dateiformate)
• Abschnitt 6: Spiele und Demosoftware
• Abschnitt 7: Treiber- und Netzwerk-Schnittstellen (BSD: Header, Tabellen und Makropakete)
• Abschnitt 8: BSD: Systemverwaltung
• Abschnitt 9: Kernel-interne Schnittstellen
• Abschnitt n: Neu (wird z.B. von Tcl/Tk verwendet)

Handhabung

Auf Manpages wird gewöhnlich in der Form programmname(1) verwiesen, wobei statt „1“ die Nummer des obengenannten Abschnitts stehen kann, also z. B. bash(1) oder bash(3). Für die meisten Programme gibt es nur einen Abschnitt. Wird beim Aufruf von man keine Abschnittsnummer angegeben, so wird der erste Abschnitt angezeigt.

Bei älteren Implementierungen des man-Kommandos konnte die Abschnittsnummer einfach als Ziffer vor dem gesuchten Namen angegeben werden. Neuere Versionen benötigen dafür die Option -s, da es inzwischen teilweise Unterabschnitte gibt, die mehrere Buchstaben an die Abschnittsnummer anhängen und dadurch anderenfalls eine Mehrdeutigkeit entstünde.

Die einzige durch POSIX standardisierte Option ist -k.

man Befehl – gibt die Manpage zu Befehl aus, zum Beispiel:

• man ls – gibt die Erklärung für den Befehl ls aus (die Reihenfolge der Suche nach Abschnitten erfolgt nach einer internen Liste)
• man -s 5 Intro – gibt die Manpage zu Intro im Abschnitt 5 aus
• man -k Suchbegriff – gibt die Übersichtszeilen der Manpages aus, in denen der Suchbegriff vorkommt.
• man man – gibt die Manpage zum Kommando man aus
• man -t manpage – erzeugt eine Manpage im Troff-Format. Was mit dem Ergebnis passiert ist Implementierungsabhängig.

In den meisten Distributionen gibt die Manpage den inhalt an den pager (more bzw less) weiter, sofern vom Benutzer nichts anderes angegeben ist.

• man ls | grep -B 5 color – durchsucht die manpage des kommandos ls nach dem Wort "color", und gibt die entsprechenden Stellen aus.

Die richtige Manpage zu einem Thema sowie den Abschnitt kann man mit dem Unix-Kommando apropos finden. Manpages werden üblicherweise mit Troff in verschiedene Ausgabeformate gewandelt (Text, PostScript).

Alternativen

• Howto-Seiten
• Helpseiten
• Info-Seiten
• KDE Hilfeseiten
• Stichwortsuche im Internet (mit der bevorzugten Suchmaschine/Suchmethode)

Weblinks

• K. Thompson; D. M. Ritchie (3. November 1971): Unix Programmer's Manual (Englisch). Lucent Technologies. Abgerufen am 18. Oktober 2011. „The first edition of the Unix Programmer's Manual, dated November 3, 1971, is available here in image, Postscript, and PDF format. Return with us to the golden days of yesteryear!“
• man(1) – Linux-Manpage (Englisch)
• Online Manpages Free-BSD (englisch, deutsch)
• Linux man pages (englisch)
• Downloadmöglichkeit auf kernel.org