Manpage
topic - Kurzbeschreibung
Beschreibung
Manpages (nach dem Unix-Kommando man
, was für „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.
Installation
Syntax
Optionen
Parameter
Umgebungsvariablen
Exit-Status
Anwendungen
Vorlage:Siehe auch Vorlage:Siehe auch
Auf Manpages in bestimmten Sektionen 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 Manpages liegen als Einzeldokumente standardgemäß unter /usr/share/man
[1], und zwar in einer festgelegten Directory-Hierarchie, die Locale (lokalsprachliche Übersetzungen der grundsätzlich in Englisch verfassten Dokumente), Section etc. abbildet.[1] 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.[2]
Mit dem Kommando apropos, das oft ein Wrapper oder Alias für man -k
ist, kann man die Whatis-Datenbank nach Stichwörtern durchsuchen. Als Antwort erhält man eine Liste der gefundenen Einträge samt Section-Nummer, die man einem erneuten Aufruf von man
dann als Argument übergeben kann.
Fehlerbehebung
Konfiguration
Dateien
Siehe auch
Unterseiten
Sicherheit
Dokumentation
RFC
Man-Pages
Info-Pages
Links
Einzelnachweise
Projekt
Weblinks
- BSD: Vorlage:Man
- GNU: Vorlage:Man
- POSIX: Vorlage:Man
- weitere man pages für andere Betriebssysteme wie AIX, HP-UX, IRIX, Minix, …, Xenix
Testfragen
Testfrage 1
Testfrage 2
Testfrage 3
Testfrage 4
Testfrage 5
Wikipedia
Aufbau
Gliederung, Sections
Manpages 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 anlehnt.
Beispielhaft hier die Sektionen unter AIX (Titel in Locale C):
- (1) User Commands and Daemons („Anwender-Kommandos und Hintergrunddienste“)
- (2) System Calls and Kernel Services („Systemaufrufe und -dienste“)
- (3) Subroutines („Unterprogramme“)
- (4) Special Files, Device Drivers and Hardware („Geräte“)
- (5) Configuration Files („Konfigurationsdateien“)
- (6) Games („Spiele“)
- (7) Miscellaneous Commands („Verschiedenes“)
- (8) Administrative Commands and Daemons („Verwaltung“)
So verweist die Notation jail(8)
[2] auf die Handbuchseite des FreeBSD Systemverwaltungs-Kommando jail, wohingegen die Notation jail(2)
[3] auf die Handbuchseite des FreeBSD Systemaufrufs jail hindeutet.[4]
- ↑
- ↑ freebsd.org
- ↑ freebsd.org
- ↑ Die Nummer in Klammern hinter dem Namen des Kommandos folgt der Einteilung in zehn FreeBSD Manpage-Sections ("Bereiche"), diese sind: (1) Generelle Kommandos, (2) Systemaufrufe, (3) Subroutinen, (4) Spezialdateien, (5) Dateiformate, (6) Spiele, (7) Makros und Konventionen, (8) Wartungskommandos, (9) Kernelschnittstelle, (n) Neue Kommandos.