Manpages

Manpages
Manpages sind Manuals, also Handbücher die zu vielen Programmen, Kommandos und Funktionen Dokumentationen beinhalten. Manpages allgemein Bei den meisten Distributionen werden die Manpages standardmäßig mitinstalliert. Manpages sind normale mit gz komprimierte Textdateien, die mit bestimmten Tags formatiert werden, um später vom sogenannten Manualbrowser (meist man oder xman) formatiert angezeigt zu werden. Das lesen von Manpages ist unerlässlich im Umgang mit Linux. Man sollte immer zuerst die Manpages, die FAQ's und README's lesen, bevor man sich mit einer Frage an jemand anders wendet. Unter http://www.infodrom.org/projects /manpages-de/ ist ein Projekt zu finden, das sich damit beschäftigt die meist englischsprachigen Manpages zu übersetzen. Sections Die Manpages sind inhaltlich in verschiedene Gebiete/Abschnitte (Sections) aufgeteilt. Die Aufteilung sieht laut einem Auszug aus der Manpage des Manualbrowsers man folgendermaßen aus: 1 Ausführbare Programme oder Shellbefehle 2 Systemaufrufe (Kernelfunktionen) 3 Bibliotheksaufrufe (Funktionen in System-Bibliotheken) 4 Spezielle Dateien (gewöhnlich in /dev) 5 Dateiformate und Konventionen, z. B. /etc/passwd 6 Spiele 7 Makropakete und Konventionen, z. B. man(7), groff(7) 8 Systemadministrationsbefehle (in der Regel nur für root) 9 Kernelroutinen [Nicht Standard] n neu [veraltet] l lokal [veraltet] p öffentlich [veraltet] o alt [veraltet] Näheres siehe `man man` Beispiele Da manche Befehle (wie z.B. die Funktion printf) auf mehrere Manpages zutreffen kann ist es wichtig zu wissen, wie man die Manpage einer bestimmten Section anzeigt. Ein user@sonne> man printf zeigt z.B. meist zuerst die Manpage der Section 1, nämlich den Befehl printf in zusammenhang mit der Shell. Mit einem user@sonne> man 3 printf kann man sich die Manpage der Section 3 anzeigen lassen, in diesem Falle den Bibliotheksaufruf printf. Die Section 3 ist besonders für Programmierer wichtig, hier gibt es massenhaft Dokumentationen zu den Bibliotheksaufrufen wie open, write, close, fopen, ... Mit einem user@sonne> man -a printf kann man sich alle Manpages zu printf anzeigen lassen. Installierte Manpages anzeigen die Umgebungsvariable $MANPATH (wenn sie gesetzt ist) enthält den/die Pfad/e, an dem die Manualpages zu finden sind (getrennt durch ein ':'). mit user@sonne> find `echo $MANPATH \| tr ':' ' '` -type f -print kann man sich diese nacheinander ausgeben lassen. Und wer es noch komfortabler mag: user@sonne> man -k "" \| sort \| less Gibt eine sortierte Liste mit Beschreibungen der installierten Manpages aus. (Diese beiden Tipps stammen jeweils von Morus Walter und Hendrik Sattler und waren Antworten auf ein Posting im Usenet).
Autor: Baitronic

Manpages sind Manuals, also Handbücher die zu vielen Programmen, Kommandos und Funktionen Dokumentationen beinhalten.

Manpages allgemein

Bei den meisten Distributionen werden die Manpages standardmäßig mitinstalliert. Manpages sind normale mit gz komprimierte Textdateien, die mit bestimmten Tags formatiert werden, um später vom sogenannten Manualbrowser (meist man oder xman) formatiert angezeigt zu werden.
Das lesen von Manpages ist unerlässlich im Umgang mit Linux. Man sollte immer zuerst die Manpages, die FAQ's und README's lesen, bevor man sich mit einer Frage an jemand anders wendet. Unter http://www.infodrom.org/projects /manpages-de/ ist ein Projekt zu finden, das sich damit beschäftigt die meist englischsprachigen Manpages zu übersetzen.

Sections

Die Manpages sind inhaltlich in verschiedene Gebiete/Abschnitte (Sections) aufgeteilt. Die Aufteilung sieht laut einem Auszug aus der Manpage des Manualbrowsers man folgendermaßen aus:

1   Ausführbare Programme oder Shellbefehle
2   Systemaufrufe (Kernelfunktionen)
3   Bibliotheksaufrufe (Funktionen in System-Bibliotheken)
4   Spezielle Dateien (gewöhnlich in /dev)
5   Dateiformate und Konventionen, z. B. /etc/passwd
6   Spiele
7   Makropakete und Konventionen, z. B. man(7), groff(7)
8   Systemadministrationsbefehle (in der Regel nur für root)
9   Kernelroutinen [Nicht Standard]
n   neu [veraltet]
l   lokal [veraltet]
p   öffentlich [veraltet]
o   alt [veraltet]

Näheres siehe man man

Beispiele

Da manche Befehle (wie z.B. die Funktion printf) auf mehrere Manpages zutreffen kann ist es wichtig zu wissen, wie man die Manpage einer bestimmten Section anzeigt. Ein

user@sonne> man printf

zeigt z.B. meist zuerst die Manpage der Section 1, nämlich den Befehl printf in zusammenhang mit der Shell.
Mit einem

user@sonne> man 3 printf

kann man sich die Manpage der Section 3 anzeigen lassen, in diesem Falle den Bibliotheksaufruf printf. Die Section 3 ist besonders für Programmierer wichtig, hier gibt es massenhaft Dokumentationen zu den Bibliotheksaufrufen wie open, write, close, fopen, ...
Mit einem

user@sonne> man -a printf

kann man sich alle Manpages zu printf anzeigen lassen.

Installierte Manpages anzeigen

die Umgebungsvariable $MANPATH (wenn sie gesetzt ist) enthält den/die Pfad/e, an dem die Manualpages zu finden sind (getrennt durch ein ':'). mit

user@sonne> find `echo $MANPATH | tr ':' ' '` -type f -print

kann man sich diese nacheinander ausgeben lassen.
Und wer es noch komfortabler mag:

user@sonne> man -k "" | sort | less

Gibt eine sortierte Liste mit Beschreibungen der installierten Manpages aus. (Diese beiden Tipps stammen jeweils von Morus Walter und Hendrik Sattler und waren Antworten auf ein Posting im Usenet).

Autor: Baitronic