man-Befehl unter Linux

Hast du schon mal was von RTFM gehört? Es steht für Read The Fucking/Fine Manual.

Genau das machen wir heute: Lies die Dokumentation, bevor du lange ratlos suchst 🔦

Der Befehl man zeigt dir detaillierte Hilfeseiten unter Linux lokal im Terminal an.

Wie bei anderen Befehlen ist auch hier der Name eine Kurzform von dem, was getan wird: Manual (Bedienungsanleitung).

Mit man kannst du alle wichtigen Details zu einem Befehl direkt in den lokalen Manpages finden.

Grundlegende Verwendung

In einer generischen Form sieht der Befehl so aus:

1

man [OPTIONEN] BEFEHL

Damit kannst du zum Beispiel die Hilfeseite von ls aufrufen:

1

man ls

Verlassen kannst du diese Ansicht mit der Taste q.

Installation von `man`

Manchmal ist das man-Kommando auf minimalen Installationen nicht vorinstalliert.

So kannst du alles Nötige besorgen:

1
2
3
4
5
6
7
8


# Debian/Ubuntu:
sudo apt install man-db manpages
# Fedora/Redhat:
sudo dnf install man-db man-pages
# openSuse/SLES:
sudo zypper in man-db man-pages
# Arch Linux:
sudo pacman -S man-db man-pages

Damit stellst du sicher, dass man als Befehl und die zugehörigen Dokumentationen (Manpages) verfügbar sind.

Struktur der Manpages

Manpages sind standardisiert und beinhalten oft folgende Abschnitte:

NAME = Name des Befehls oder Programms und eine kurze Beschreibung
SYNOPSIS = grundlegende Verwendung mit Optionen
DESCRIPTION = ausführliche Erläuterungen
OPTIONS = verfügbare Optionen und deren Funktion
EXAMPLES = Beispiele für die praktische Anwendung
SEE ALSO = Verweise auf verwandte Befehle oder Themen

Wichtige Optionen für `man`

Aber du kannst die Manpage nicht nur mit man BEFEHL aufrufen.

Bei der Abfrage der Hilfe lassen sich verschiedene Optionen einsetzen, die hilfreich sind, um schneller an die gewünschten Informationen zu kommen:

-k SUCHBEGRIFF = sucht in den Manpages nach Stichwörtern
-f BEFEHL = zeigt an, welche Manpages für einen Befehl existieren
-a = durchläuft alle verfügbaren Manpages für ein Thema

Die Verwendung betrachten wir in den praktischen Beispielen.

Die Anzeige der Hilfe erfolgt standardmäßig mit dem Pager less.

Oben haben wir schon gesehen, dass man eine Manpage mit q wieder verlassen kann.

Aber das ist nicht die einzige verwendbare Option. Hier nun eine vollständigere Liste:

Space = nächste Seite
b = vorherige Seite
/SUCHBEGRIFF = vorwärts nach einem Begriff suchen
?SUCHBEGRIFF = rückwärts nach einem Begriff suchen
n springt zum nächsten Treffer
N springt zum vorherigen Treffer
q verlässt die Manpage
h ruft die Hilfe zu Manpages auf

Praktische Beispiele

Sehen wir uns nun genauer an, wie man das alles praktisch einsetzen kann.

Dokumentation für einen Befehl anzeigen

Die einfache Form ist die direkte Anzeige der Hilfe für einen Befehl:

1

man grep

Manpages für ein Thema finden

So findest du alle Manpages für ein Thema:

1

man -k copy

Zeigt relevante Einträge, wie cp, copy_file_range, usw. an.

Das Ergebnis ist übrigens identisch, wie wenn du mit apropos suchen würdest:

1

apropos copy

Abschnitt angeben

Einige Begriffe haben Manpages in verschiedenen Sektionen.

1
2


man 1 printf
man 3 printf

Zum Beispiel gibt es printf als Befehl (Sektion 1) und als C-Funktion (Sektion 3).

Suche in einer Manpage

Vielleicht willst du bestimmte Werte der Manpage von ls finden.

Dazu kannst du eine Suche starten:

1

/format

Nach drücken der Enter-Taste wird in diesem Fall eine Vorwärtssuche gestartet.

Mit n kannst du dich durch die Suchtreffer bewegen und mit Esc die Suche abbrechen.

Fazit

Das Kommando man ist ein unverzichtbares Werkzeug für jeden, der sich tiefer mit Linux beschäftigen möchte.

Es bietet einen schnellen Zugriff auf Dokumentation. Mit den enthaltenen Details lassen sich Befehle und Programme besser verstehen und nutzen.

Hilfe zu `man`

Mehr zu man findest du unter tldr man. Details zum Befehl tldr gibt es hier.

Und zum Abschluss noch ein Trick: Mit man man kannst du die Dokumentation für man selbst lesen!