Manpages: Unterschied zwischen den Versionen

Aktuelle Version vom 13. Februar 2025, 17:18 Uhr

Manpages - Systemhandbücher

Beschreibung

Manpages

Sammlung von Hilfe- und Dokumentationsseiten unter Unix und verwandten Betriebssystemen

Sie werden mit den Kommandos man und whatis durchsucht sowie ausgegeben

Index

Zur schnellen Durchmusterung wird ein eigener Index, die Whatis-Datenbank, angelegt

Erstellung

Manpages werden mit dem Macro-Pakets man mit dem Unix-Systemwerkzeug troff erzeugt

Sektionen

Gliederung, Sections

Sektion	Beschreibung
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) auf die Handbuchseite des FreeBSD Systemverwaltungs-Kommando jail, wohingegen die Notation jail(2) auf die Handbuchseite des FreeBSD Systemaufrufs jail hindeutet

Aufbau einer Manpage

Bereiche

Bereich	Beschreibung
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

Siehe auch

whatis

Dokumentation

Man-Page

man

Info-Pages

Links

Weblinks

@@ Zeile 12: / Zeile 12: @@
 ; Erstellung
 Manpages werden mit dem [[Makro|Macro]]-Pakets <code>[[man]]</code> mit dem Unix-Systemwerkzeug <code>[[troff]]</code> erzeugt
-== Aufbau einer 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-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
-; Bereiche
-Typischerweise ist eine Manpage in folgende Bereiche unterteilt (eingeklammerte Abschnitte sind optional)
-{| class="wikitable options"
-! Sektion !! Beschreibung
-|-
-| 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
-|}
 == Sektionen ==
 ; 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.
-* 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
-; Beispiel
 {| class="wikitable options col1center"
 ! Sektion !! Beschreibung
@@ Zeile 69: / Zeile 35: @@
 |}
-So verweist die [[Notation]] <code>jail(8)</code> auf die Handbuchseite des [[FreeBSD]] Systemverwaltungs-[[Unix-Kommando|Kommando]] ''[[Chroot#Sicherheitsfeature oder nicht?|jail]]'', wohingegen die Notation <code>jail(2)</code> auf die Handbuchseite des FreeBSD [[Systemaufruf]]s ''jail'' hindeutet.
+So verweist die [[Notation]] <code>jail(8)</code> auf die Handbuchseite des [[FreeBSD]] Systemverwaltungs-[[Unix-Kommando|Kommando]] ''[[Chroot#Sicherheitsfeature oder nicht?|jail]]'', wohingegen die Notation <code>jail(2)</code> auf die Handbuchseite des FreeBSD [[Systemaufruf]]s ''jail'' hindeutet
-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.
+== Aufbau einer Manpage ==
+; Bereiche
+{| class="wikitable options"
+! Bereich !! Beschreibung
+|-
+| 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
+|}
 == Siehe auch ==