Was ist der man-Befehl?
man ist das System-Anzeigeprogramm für die Handbuchseiten (Manual Pages) unter Linux. Jedes an man übergebene Argument ist normalerweise der Name eines Programms oder einer Funktion. Es wird die passende Manpage aus den verfügbaren Sektionen angezeigt.
Sektionen der Manpages
Manpages sind in neun Sektionen unterteilt:
- (1) Ausführbare Programme und Shell-Befehle
- (2) Systemaufrufe (Kernelfunktionen)
- (3) Bibliotheksfunktionen
- (4) Spezielle Dateien (z.B. Device-Files)
- (5) Dateiformate und Konfigurationsdateien
- (6) Spiele
- (7) Verschiedenes und Konventionen
- (8) Systemverwaltungsbefehle (SysAdmin)
- (9) Kernel-Debugging (selten)
Ohne Angaben durchsucht man die Sektionen in einer vorgegebenen Reihenfolge und zeigt nur die erste gefundene Seite an. Die Angabe zur Sektion sieht man in der linken oberen Ecke:
LS(1)
BEZEICHNUNG
ls - Verzeichnisinhalte auflisten
....
Indexierung mit mandb und Suche
Alle Manpages werden in einem Index verwaltet, der mit dem Befehl mandb erzeugt oder aktualisiert wird. Damit können suchende Befehle wie man -k oder apropos den Index nach Schlüsselwörtern durchsuchen. Ein weitere kompakter Befehl ist whatis und gibt nur den Titel (in der Regel eine Kurzbeschreibung der Funktion) der Man-Page aus.
Navigieren in Manpages
Die Navigation der Manpages entstspricht der des less-Pagers.
j: zeilenweise nach untenk: zeilenweise nach obenf: eine Seite vorwärts blätternb: eine Seite vorwärts blätterng: zum SeitenanfangG: zum Seitenende/Begriff: Suchfunktion nach unten starten?Begriff: Suchfunktion nach oben startenn: nächster SuchtrefferN: vorheriger Suchtrefferh: Aufrufen der Hilfe (Übersicht der Befehle vom less-Pager)q: Manpage verlassen
Wichtige Manpage-Abschnitte
- NAME: Kurzbeschreibung
- SYNOPSIS: Befehlsaufruf und Optionen
- DESCRIPTION: ausführliche Beschreibung
- OPTIONS: alle Schalter und Parameter
- EXAMPLES: Anwendungsbeispiele
- SEE ALSO: verwandte Befehle
Verzeichnisse für Man-Pages und erweiterte Dokumentationen
Die Verzeichnisse in denen die Man-Pages aufbewahrt werden kann man mit dem Befehl manpath herausgefunden werden. In der Regel ist es /usr/share/man.
Erweiterte Dokumentation zu den installierten Programmen findet man in dem Verzeichnis /user/share/doc. Hier sind für die jeweiligen Programme Order mit weiteren Infos angelegt die mit mit Pagern wir less eingesehen werden können.
Beispiele
# Finden der Verzeichnisse für Manpages
manpath
# Aktualisieren der Man-Pages-Datenbank
mandb
# Suche nach Titel/Kurzbeschreibung
whatis programm
man -f programm
# Suche nach Stichwörtern in allen Manpages (vergleichbar mit `apropos`)
man -k Begriff
apropos Begriff
# Öffnen einer Man-Page
man programm
# Öffnen einer Man-Page in einer spezifischen Sektion
man 8 programm
# zeigt an, ob Manpages für einen Befehl vorhanden sind
man -f programm
#zeigt alle verfügbaren Manpages zu einem Thema nacheinander an
man -a programm
# Filtern nach Sektionen, in diesem Fall #8: SysAdmin Kommandos
man -k Begriff | grep 8
Fazit
Der man-Befehl ist somit ein zentraler Bestandteil der Linux-Dokumentation direkt im Terminal und hilft, nicht nur Befehle, sondern auch Konfigurationsdateien und Systemfunktionen umfassend zu verstehen und zu bedienen(see the generated image above).