Manpage

Aus Mikiwiki
Wechseln zu: Navigation, Suche

Die Manpage (manual page; dt. etwa "Handbuchseite") enthält jeweils die möglichen Optionen eines Shell-Befehls, Informationen zu C-Funktionen und andere nützliche Dokumente. Sie stehen in einem der durch "$MANPATH" bezeichneten Pfade (meist "/usr/share/man") und können mit dem Manbrowser man angesehen werden. In "$MANPATH" können individuelle Einstellungen festgelegt werden (z. B. "export MANPATH=$MANPATH:/usr/local/man"). Die Handbücher liegen im Format "roff" vor.

Zum Ansehen und Durchsuchen der Handbücher werden die Befehle man, apropos und whatis verwendet. Einen guten Überblick über die Handbücher bietet Konqueror in Zusammenhang mit dem entsprechenden Kioslave, der mit Hilfe der URI man:/ aufgerufen wird.

Die Handbücher sind meist nur vorhanden, wenn die entsprechende software auf dem System installiert ist. Bei Bedarf können bestehende Handbücher abgeändert werden oder eigene Handbücher in den man-Pfad gestellt werden (z. B. nach "/usr/share/man/man1").

Die Handbücher sind in verschiedene Themenabschnitte [engl. section] unterteilt. Diese Aufteilung ist nicht auf allen UNIX-Systemen gleich.

Beschreibung Beispiele
1 Shellbefehle und Anwendungen (1M Sysadmin-Befehle) ls, chown und more sowie Konqueror, Nautilus oder Openoffice
2 Systemaufrufe [system calls] (werden vom Kernel ausgeführt) "accept()", "_sysctl" und "chown()"
3 Funktionen von Bibliotheken Perl, X11, Openssl
4 spezielle Dateien (z. B. "man null" für Informationen zu "/dev/null") Gerätedateien wie "isdnctrl", "nv" (X.org-Nvidia-Treiber) sowie "hd" und "sd" (IDE- und SCSI-Platten)
5 Dateiformate und Konventionen "hosts" (für "/etc/hosts"), "fstab" (für "/etc/fstab"), "passwd" (für "/etc/passwd") und "xorg.conf" (Konfigurationsdatei für X.org)
6 Spiele und Demos Frozen-Bubble und Pingus
7 Makropakete und Konventionen Debconf (Debian-Konfigurationstool), Bastille (Sicherheit), "iso_8859_15" (Zeichensatz-Kodierung) und "gimpprint-*" (GIMP-Print)
8 Befehle zur Systemverwaltung Adduser, Alsaconf und Tune2fs
9 Kernelroutinen
n Tcl/Tk-Befehle

Der Inhalt der Handbücher gliedert sich nach folgendem Muster. Die Abschnitte NAME, SYNOPSIS, DESCRIPTION und OPTIONS sind in fast allen Handbüchern anzutreffen. Zusätzlich können weitere Kategorien vorkommen.

Kategorie Beschreibung
NAME Befehlsname und Kurzbeschreibung
SYNOPSIS Syntax des Befehls (alle möglichen Formen)
AVAILABILITY Paketzugehörigkeit
DESCRIPTION Genaue Beschreibung des Befehls.
OPTIONS Beschreibung aller Optionen.
EXAMPLES Beispiele zur Anwendung.
ENVIRONMENT Variablen, die den Befehl beeinflussen.
FILES Dateien, die der Befehl benützt.
DIAGNOSTIC Fehlercodes.
SEE ALSO Verweise auf verwandete man pages.
NOTES Hinweise zum Gebrauch, Einsatz.
BUGS
AUTHOR Autor(en)