man-Befehle: Handbuchseiten im Terminal lesen

man (von „manual") zeigt die Handbuchseiten (Manual Pages) von Linux- und Unix-Befehlen an. Es ist die wichtigste eingebaute Dokumentation im Terminal: Fast jeder Befehl, jede Systemfunktion und jedes Dateiformat hat eine eigene man-Seite mit Aufruf, Optionen und Beispielen.

Erste Schritte

man ls
man crontab

Das öffnet die Handbuchseite des jeweiligen Befehls. Zum Blättern gelten dieselben Tasten wie im Pager less (Leertaste: Seite weiter, q: beenden, /Muster: suchen), denn man verwendet intern meist less als Anzeige.

Aufbau einer man-Seite

Typische Abschnitte einer Handbuchseite:

  • NAME: Name und Kurzbeschreibung
  • SYNOPSIS: Aufrufsyntax
  • DESCRIPTION: ausführliche Beschreibung
  • OPTIONS: alle Optionen im Detail
  • EXAMPLES: Beispiele
  • SEE ALSO: verwandte Seiten

Sektionen

man 5 crontab    # Dateiformat crontab (nicht der Befehl)
man -f ls        # Kurzbeschreibung (whatis)
man -k backup    # alle Seiten durchsuchen, die "backup" enthalten (apropos)

Die man-Seiten sind in nummerierte Sektionen aufgeteilt:

  • 1: Benutzerbefehle (ls, cp)
  • 2: Systemaufrufe (Kernel-Funktionen)
  • 3: Bibliotheksfunktionen (z.B. C-Standardbibliothek)
  • 5: Dateiformate (/etc/passwd, crontab)
  • 7: Verschiedenes (Konventionen, Protokolle)
  • 8: Systemadministration (mount, useradd)

Gibt es einen Befehl und ein Dateiformat mit demselben Namen, wählt die Zahl vor dem Namen die gewünschte Sektion.

Suchen

man -k webserver      # findet passende Seiten
apropos firewall      # gleiches Kommando wie man -k
man -w ssh            # zeigt nur den Pfad zur Seite (z.B. /usr/share/man/man1/ssh.1.gz)

man -k (auch apropos) durchsucht die Kurzbeschreibungen aller installierten Handbuchseiten — ideal, wenn man den genauen Befehlsnamen nicht kennt.

Wichtig zu wissen

  • Schnelle Kurzhilfe liefert meist auch --help, z.B. ls --help; man ist aber ausführlicher.
  • Beispiele für typische Befehle: mount, chmod/chown, find haben detaillierte Handbuchseiten.
  • Wo die Handbuchseiten auf der Platte liegen, zeigt man -w — ein typischer Pfad ist /usr/share/man.
  • Zum Nachschlagen in Dateien ist grep der passende Partner: man ls | grep -i sort.

Verwandte Grundlagen: less (Pager hinter man), more (klassischer Pager), Bash und die Shell.