Manpages

Manpages - Systemhandbücher

Beschreibung

Sammlung von Hilfe- und Dokumentationsseiten unter Unix und verwandten Betriebssystemen

Zur schnellen Durchmusterung wird ein eigener Index, die Whatis-Datenbank, angelegt

Manpages werden mit dem Macro-Pakets man mit dem Unix-Systemwerkzeug troff erzeugt

Eine ähnlich informelle Konvention wie bei den Kapiteln hat sich auch beim Aufbau der einzelnen Artikel eingebürgert

Stark von dieser Konvention weichen lediglich Systeme ab, die ihre Systemkommandos von der GNU-Initiative beziehen (Linux, FreeBSD etc.), weil das GNU-Projekt versucht, Manpages durch in deren Augen bessere Alternativen (Texinfo) abzulösen
Dennoch existieren Manpages auch für Programme, welche diese Art der Dokumentation nicht mitliefern, da solche für einzelne Linux-Distributionen erstellt worden sind (so schreibt das Debian-Projekt vor, dass alle Programme eine Manpage haben sollten); vielfach sind dies allerdings nur Beschreibungen, manchmal veraltet, meist nur in englischer Sprache verfügbar, darüber hinaus werden sie nicht bei jedem System mitgeliefert

Typischerweise ist eine Manpage in folgende Bereiche unterteilt (eingeklammerte Abschnitte sind optional)

Bereich	Beschreibung
NAME	Name des Programms gefolgt von einer einzeiligen Beschreibung
SYNOPSIS	Für Programme wird hier eine vollständige Liste der Parameter und Optionen beschrieben
DESCRIPTION	Eine Textbeschreibung der Funktionsweise des Befehls oder der Funktion. (Üblicherweise jedoch nicht der Benutzung, siehe unten.)
OPTIONS / FLAGS	Eine üblicherweise alphabetisch sortierte Liste der Optionen und ihrer zulässigen Argumente
(USAGE)	Eine Anleitung für den Einsatz des Programms
EXIT STATUS	Beschreibung möglicher Rückgabewerte und deren Bedeutung
(EXAMPLES)	Einige Beispiele für die Benutzung
(FILES)	Falls bestimmte Dateien (etwa Konfigurationsdateien) an der Funktion des Programms beteiligt sind oder durch die Ausführung desselben betroffen sind, so werden sie hier aufgeführt und ihre Funktion beschrieben
SEE ALSO	Eine Liste ähnlicher oder verwandter Befehle oder Funktionen, bei betroffenen Dateien wird hier auf die entsprechenden Einträge in Section 5 verwiesen