Was ist eine Man-Page?

Eine Man-Page ist eine Hilfe- oder Dokumentationsseite, die mit dem Kommando man auf Unix-verwandten Betriebssystemen angezeigt wird.

Der  Unterschied zu den Kurzdokumentationen von Programmen beim Aufruf ohne Parameter ist, dass die weit umfangreicher und genauer sein kann.

Zudem ist sie nicht darauf beschränkt, nur ausführbare Programme zu dokumentieren.

Alle diese Seiten zusammen werden Man-Pages genannt und sind oft im Verzeichnis /usr/share/man abgelegt, wobei der Ort frei ist und auch mehrere Sammlungen von Dokumentationen möglich sind. Der bevorzugte Pfad kann in der Umgebungsvariable MANPATH hinterlegt werden.

Der Aufruf

man name

ruft die Dokumentation von name ab und stellt sie dar.

Zwar sind weder der Aufbau und Inhalt einer solchen Man-Page noch die Struktur der Dokumentationsverzeichnisse genormt und erzwungen, doch sind sie meist gleichartig, so dass man sich schnell zurecht findet.

Kapitel

Die Man-Pages sind in Kapitel (auch: Bereiche, Abschnitte) unterteilt, nach der Art der dokumentierten Entität. Üblich ist:

  1. Anwender-Kommandos und Hintergrunddienste (User Commands and Daemons)
  2. Systemaufrufe und -dienste (System Calls and Kernel Services)
  3. Unterprogramme und Bibliotheken (Subroutines)
  4. Hardware- und Geräteinformationen (Special Files, Device Drivers and Hardware)
  5. Konfigurationsdateien (Configuration Files)
  6. Spiele (Games)
  7. Verschiedenes (Miscellaneous Commands)
  8. Verwaltung (Administrative Commands and Daemons)

Die meisten Einträge sind bereits eindeutig über ihren Namen abrufbar, so dass keine weitere Angabe notwendig ist. Vereinzelt wir ein Name mehrfach genutzt.

Zur Unterscheidung wird das Kapitel beim Namen genannt, z.B. jail(2) und jail(8) oder syslogd(1) und syslogd(8). Eine andere Darstellung nutzt den Punkt, z.B. jail.2 und jail.8.

Beim Abruf mit man kann das Kapitel spezifiziert oder auch alle Dokumente abgerufen werden.

Aufbau einer Man-Page

Art und Reihenfolge der enthaltenen Informationen kann zwar variieren, folgt aber meist dem gewohnten Muster:Die präsentierten Ein Man-Page Der Aufbau einer Man-Page ist

  1. NAME: Name des Programms gefolgt von einer einzeiligen Kurzbeschreibung.
  2. SYNOPSIS: Für Programme wird hier eine vollständige Liste der Parameter und Optionen beschrieben.
  3. DESCRIPTION: Eine Beschreibung der Funktionsweise des Befehls oder der Funktion.
  4. OPTIONS / FLAGS: Eine – üblicherweise alphabetisch sortierte – Liste der Optionen und ihrer zulässigen Argumente.
  5. USAGE : (optional) Eine Anleitung für den Einsatz des Programms.
  6. EXIT STATUS: Beschreibung möglicher Rückgabewerte und deren Bedeutung.
  7. EXAMPLES: (optional) Einige Beispiele für die Benutzung.
  8. FILES: (optional) Dateien, die für die Funktion oder das Programm relevant sind.
  9. SEE ALSO: Eine Liste ähnlicher oder verwandter Befehle oder Funktionen.

Sonstiges

Neben “man” arbeiten weitere Kommandos auf den Dokumentationsseiten. Zu nennen sind hier besonders “whatis” und “apropos”, die u.a. auch eine Übersicht mit den einzeiligen Kurzbeschreibungen (samt Kapitel) erzeugen können.

Dieser Beitrag wurde unter Computer abgelegt und mit verschlagwortet. Setze ein Lesezeichen auf den Permalink.

Leave a Reply

Your email address will not be published. Required fields are marked *

*

*

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>