Manpage: Unterschied zwischen den Versionen

Aktuelle Version vom 6. November 2024, 12:26 Uhr

topic - Beschreibung

Beschreibung

Manpages

nach dem Unix-Kommando man
Handbuch
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

Aufbau eine Manpage

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:

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.

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]

Anwendungen

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^[5], und zwar in einer festgelegten Directory-Hierarchie, die Locale (lokalsprachliche Übersetzungen der grundsätzlich in Englisch verfassten Dokumente), Section etc. abbildet.^[5] 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]

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.

Siehe auch

man
whatis

Manpage

Sicherheit

Dokumentation

RFC

Man-Page

man

Info-Pages

Links

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

Antwort1

Testfrage 2

Antwort2

Testfrage 3

Antwort3

Testfrage 4

Antwort4

Testfrage 5

Antwort5

↑ ^1,0 ^1,1
↑ 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.
↑ ^5,0 ^5,1

[posix-1] 1,0 ^1,1

[2] reebsd.org

[3] reebsd.org

[4] 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.

[fhs-5] 5,0 ^5,1

[1]

[2]

[3]

[4]

[5]

@@ Zeile 1: / Zeile 1: @@
-'''topic''' - Kurzbeschreibung
+'''topic''' - Beschreibung
 == Beschreibung ==
 [[Datei:Man 2.5.2 de.png|mini|Manpage zu ''man'']]
@@ Zeile 5: / Zeile 5: @@
 [[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.
+'''Manpages'''
+* nach dem [[Unix-Kommando]] <code>man</code>
+* Handbuch
+* 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.
 == Installation ==
-== Syntax ==
-=== Optionen ===
+== Aufbau eine Manpage ==
-=== Parameter ===
+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 Beschreibungen, manchmal veraltet, meist nur in [[Englische Sprache|englischer Sprache]] verfügbar, darüber hinaus werden sie nicht bei jedem System mitgeliefert.
-=== Umgebungsvariablen ===
-=== Exit-Status ===
+Typischerweise ist eine Manpage in folgende Bereiche unterteilt, eingeklammerte Abschnitte sind optional:
+'''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.
+=== 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=http://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>
 == Anwendungen ==
-=== Fehlerbehebung ===
+Auf Manpages in bestimmten Sektionen wird gewöhnlich in der Form <span style="font-family:monospace;">Eintragstitel(''N'')</span> verwiesen, wobei ''N'' die Nummer des jeweiligen Abschnitts ist, etwa <span style="font-family:monospace;">syslogd(1)</span> oder <span style="font-family:monospace;">syslogd(8)</span>. 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.
-== Konfiguration ==
-=== Dateien ===
+Die Manpages liegen als Einzeldokumente standardgemäß unter <code>/usr/share/man</code><ref name="fhs">{{Internetquelle |url=http://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 <span style="font-family:monospace;">[[Apropos (Unix)|apropos]]</span>, 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.
 == Siehe auch ==
-=== Unterseiten ===
+# [[man]]
-{{Special:PrefixIndex/{{BASEPAGENAME}}}}
+# [[whatis]]
+{{Special:PrefixIndex/Manpage}}
 === Sicherheit ===
 === Dokumentation ===
 ==== RFC ====
-==== Man-Pages ====
+==== Man-Page ====
+# [[man]]
 ==== Info-Pages ====
 === Links ===
-==== Einzelnachweise ====
-<references />
 ==== Projekt ====
 ==== Weblinks ====
@@ Zeile 58: / Zeile 114: @@
 ''Testfrage 5''
 <div class="mw-collapsible-content">'''Antwort5'''</div>
-</div>
+</div></noinclude>
-</noinclude>
+[[Kategorie:Linux/Dokumentation]]
-= Wikipedia =
-== 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=http://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 <span style="font-family:monospace;">Eintragstitel(''N'')</span> verwiesen, wobei ''N'' die Nummer des jeweiligen Abschnitts ist, etwa <span style="font-family:monospace;">syslogd(1)</span> oder <span style="font-family:monospace;">syslogd(8)</span>. 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=http://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 <span style="font-family:monospace;">[[Apropos (Unix)|apropos]]</span>, 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.