Manpage

aus Wikipedia, der freien Enzyklopädie
Wechseln zu: Navigation, Suche
Manpage zu man
Manpage zu rxvt
Manpage zu xterm

man-pages (nach dem Unix-Kommando man, was für manual, dt.: Handbuch steht) sind eine Sammlung von Hilfe- und Dokumentationsseiten unter Unix und verwandten Betriebssystemen. Sie werden mit den Kommandos man und whatis durchsucht sowie ausgegeben. Zur schnellen Durchmusterung wird ein eigener Index, die sogenannte whatis-Datenbank, angelegt. manpages werden unter Zuhilfenahme des speziell konzipierten Macro-Pakets man mit dem Unix-Systemwerkzeug troff erzeugt.

Inhaltsverzeichnis

Aufbau [Bearbeiten]

Gliederung, Sections [Bearbeiten]

man-pages sind in weiten Teilen ausdrücklich nicht durch den POSIX-Standard (IEEE Std 1003.1) standardisiert, sondern die Standardisierung erfolgte lediglich für das absolut notwendige Minimum.[1] Allerdings hat sich eine auf den meisten Unix-Derivaten ähnliche Einteilung in sogenannte Sections (Kapitel, Bereiche) eingebürgert, die sich an die ursprüngliche Einteilung in acht Sections anlehnt.

Beispielhaft hier die Sections unter AIX (Titel in Locale C):

Aufbau einzelner man-pages [Bearbeiten]

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 GNU versucht, man-pages durch in deren Augen bessere Alternativen (Texinfo) zu ergänzen bzw. abzulösen.

Typischerweise ist eine man-page in folgende Bereiche unterteilt, eingeklammerte Abschnitte sind optional:

NAME

Name des Programms gefolgt von einer einzeiligen Kurzbeschreibung.

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 Return Codes 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 Files wird hier auf die entsprechenden Einträge in Section 5.

Handhabung [Bearbeiten]

Auf man-pages in bestimmten Sections wird gewöhnlich in der Form Eintragstitel(N) verwiesen, wobei N die Nummer des jeweiligen Abschnitts ist, etwa syslogd(1) oder syslogd(8). Für die meisten Programme gibt es nur einen Abschnitt. Wird beim Aufruf von man keine Abschnittsnummer angegeben, so wird der erste gefundene Abschnitt angezeigt.

Die man-pages liegen als Einzeldokumente standardgemäß unter /usr/share/man[2], und zwar in einer festgelegten Directory-Hierarchie, die Locale (lokalsprachliche Übersetzungen der grundsätzlich in Englisch verfaßten Dokumente), Section, etc. abbildet[2]. Von den meisten Implementierungen von man wird zwar auch die Environment-Variable MANPATH verstanden, aber deren Verwendung ist durch den POSIX-Standard ausdrücklich nicht gedeckt.[1]

Mittels des Kommandos apropos <Begriff> (einem üblichen Shell-Alias für man -k) kann man die whatis-Datenbank nach Schlagwörtern durchsuchen. Die Rückgabe ist eine Liste von gefundenen Einträgen samt Section-Nummer, die man einem erneuten Aufruf von man dann als Argument übergeben kann.

Einzelnachweise [Bearbeiten]

  1. ↑ a b man-Spezifikation der Open Group. Abgerufen am 17. April 2013 (englisch).
  2. ↑ a b File System Hierarchy Standard (FHS). Abgerufen am 17. April 2013 (englisch).

Weblinks [Bearbeiten]

Von „http://de.wikipedia.org/w/index.php?title=Manpage&oldid=117661582“