imported>SchlurcherBot: Bot: http → https

2025-07-09T15:39:47Z

Bot: http → https

Neue Seite

[[Datei:Man 2.5.2 de.png|mini|Manpage zu ''man'']]
[[Datei:Rxvt.png|mini|Manpage zu ''[[rxvt]]'']]
[[Datei:Man-xterm.png|mini|Manpage zu ''[[xterm]]'']]

'''Manpages''' (nach dem [[Unix-Kommando]] <code>man</code>, was für {{enS|''manual''}} „[[Handbuch]]“ steht) sind eine Sammlung von Hilfe- und Dokumentationsseiten unter [[Unix]] und verwandten [[Betriebssystem]]en. Sie werden mit den Kommandos <code>man</code> und <code>[[Whatis (Unix)|whatis]]</code> durchsucht sowie ausgegeben. Zur schnellen Durchmusterung wird ein eigener Index, die sogenannte Whatis-Datenbank, angelegt. Manpages werden unter Zuhilfenahme des speziell konzipierten [[Makro|Macro]]-Pakets <code>man</code> mit dem Unix-Systemwerkzeug <code>[[troff]]</code> erzeugt.

== Aufbau ==
=== Gliederung, ''Sections'' ===
Manpages sind in weiten Teilen ausdrücklich nicht durch den [[Portable Operating System Interface|POSIX]]-Standard (IEEE Std 1003.1) standardisiert, sondern die Standardisierung erfolgte lediglich für das absolut notwendige Minimum.<ref name="posix">{{Internetquelle |url=https://pubs.opengroup.org/onlinepubs/009695399/utilities/man.html |titel=man-Spezifikation der Open Group |sprache=en |zugriff=2013-04-17}}</ref> 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#POSIX|Locale C]]):
* (1) User [[Unix-Kommandos|Commands]] and [[Daemon]]s („Anwender-Kommandos und Hintergrunddienste“)
* (2) [[Systemaufruf|System Calls]] and [[Kernel (Betriebssystem)|Kernel]] Services („Systemaufrufe und -dienste“)
* (3) Subroutines („Unterprogramme“)
* (4) Special Files, [[Gerätetreiber|Device Drivers]] and [[Hardware]] („Geräte“)
* (5) [[Konfigurationsdatei|Configuration Files]] („Konfigurationsdateien“)
* (6) [[Computerspiel|Games]] („Spiele“)
* (7) Miscellaneous Commands („Verschiedenes“)
* (8) Administrative Commands and Daemons („Verwaltung“)

So verweist die [[Notation]] <code>jail(8)</code><ref>[https://www.freebsd.org/cgi/man.cgi?jail%288%29 freebsd.org]</ref> auf die Handbuchseite des [[FreeBSD]] Systemverwaltungs-[[Unix-Kommando|Kommando]] ''[[Chroot#Sicherheitsfeature oder nicht?|jail]]'', wohingegen die Notation <code>jail(2)</code><ref>[https://www.freebsd.org/cgi/man.cgi?jail%282%29 freebsd.org]</ref> auf die Handbuchseite des FreeBSD [[Systemaufruf]]s ''jail'' hindeutet.<ref>Die Nummer in Klammern hinter dem Namen des [[Unix-Kommandos|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.</ref>

=== Aufbau einzelner Manpages ===
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-Distribution]]en erstellt worden sind (so schreibt das [[Debian]]-Projekt vor, dass alle Programme eine Manpage haben sollten); vielfach sind dies allerdings nur Kurzbeschreibungen, manchmal veraltet, meist nur in [[Englische Sprache|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:

'''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 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.

== Handhabung ==
{{Siehe auch|Man (Unix)}} {{siehe auch|Whatis (Unix)}}

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 <code>man</code> keine Abschnittsnummer angegeben, so wird der erste gefundene Abschnitt angezeigt.

Die Manpages liegen als Einzeldokumente standardgemäß unter <code>/usr/share/man</code><ref name="fhs">{{Internetquelle |url=https://www.pathname.com/fhs/pub/fhs-2.3.html#USRSHAREMANMANUALPAGES |titel=File System Hierarchy Standard (FHS) |sprache=en |zugriff=2013-04-17}}</ref>, und zwar in einer festgelegten [[Directory]]-Hierarchie, die ''Locale'' (lokalsprachliche Übersetzungen der grundsätzlich in Englisch verfassten Dokumente), ''Section'' etc. abbildet.<ref name="fhs" /> Von den meisten Implementierungen von <code>man</code> wird zwar auch die Environment-Variable <code>MANPATH</code> verstanden, aber deren Verwendung ist durch den POSIX-Standard ausdrücklich nicht gedeckt.<ref name="posix" />

Mit dem Kommando [[Apropos (Unix)|apropos]], das oft ein [[Wrapper (Software)|Wrapper]] oder Alias für <code>man -k</code> 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 <code>man</code> dann als Argument übergeben kann.

== Weblinks ==
* {{Internetquelle |url=https://www.bell-labs.com/usr/dmr/www/1stEdman.html |titel=Unix Programmer’s Manual |zugriff=2017-09-10 |autor=[[Ken Thompson]], [[Dennis Ritchie]]|datum=1971-11-03 |sprache=en |hrsg=Lucent Technologies |kommentar=die erste Ausgabe des Unix Programmer’s Manual vom 3. November 1971 ist hier als Scan, Postscript- und PDF-Dateiformat verfügbar}}
* [[Berkeley Software Distribution|BSD]]: {{man|1|man|bsd}}
* [[GNU]]: {{man|1|man|gnu}}
* [[POSIX]]: {{man||man|posix}}
* weitere [http://www.polarhome.com/service/man/ man pages] für andere Betriebssysteme wie [[AIX]], [[HP-UX]], [[IRIX]], [[Minix (Betriebssystem)|Minix]], …, [[Xenix]]

== Einzelnachweise ==
<references />

[[Kategorie:Unix-Betriebssystemkomponente]]
[[Kategorie:Technische Dokumentation]]

Manpage - Versionsgeschichte

imported>SchlurcherBot: Bot: http → https