So verwenden Sie den man-Befehl unter Linux (mit Beispielen für Einsteiger:innen bis Profis)

Die Linux-Befehlszeilenschnittstelle ist eine leistungsfähige Schnittstelle, über die Benutzer:innen direkt mit dem Betriebssystem interagieren können. Für die Systemadministration, die Softwareentwicklung und viele weitere technische Aufgaben ist sie unverzichtbar. Sie bietet Flexibilität und Kontrolle über Systemvorgänge und ist damit ein zentrales Tool für Fachleute.

Man Pages sind umfassende Dokumentationsressourcen, die Funktionsweise, Optionen und Verwendung von Befehlen und Programmen unter Linux beschreiben. Sie dienen Benutzer:innen als wichtige Referenz und liefern detaillierte Informationen sowie Beispiele, die dabei helfen, die verschiedenen Werkzeuge zu verstehen und wirksam einzusetzen.

Der man-Befehl ist das Tor zu diesen Handbuchseiten. Mit einer einfachen Schnittstelle zum Abfragen und Lesen von Man Pages hilft man dabei, die gesuchten Informationen schnell zu finden. Besonders nützlich ist das bei der Fehlerbehebung, beim Erlernen neuer Befehle und beim souveränen Umgang mit der Linux-Umgebung.

Dieser Leitfaden vermittelt ein detailliertes Verständnis des man-Befehls unter Linux und zeigt, welche Bedeutung er für den Zugriff auf Handbuchseiten (oder „Man Pages“) verschiedener Befehle und Programme hat. Anhand praxisnaher Beispiele erfahren Sie, wie Sie den man-Befehl effizient nutzen und Ihre Kenntnisse auf der Befehlszeile ausbauen.

Was ist der man-Befehl unter Linux?

Der man-Befehl entstand Anfang der 1970er-Jahre mit dem Betriebssystem Unix, das in den Bell Labs von Ken Thompson, Dennis Ritchie und anderen entwickelt wurde. Zu Beginn war die Unix-Dokumentation spärlich, weshalb ein standardisiertes System zur Dokumentation von Befehlen und Funktionen nötig wurde. Das erste Unix Programmer’s Manual erschien 1971 und enthielt kurze Beschreibungen sowie Anwendungsbeispiele für verschiedene Befehle und Programme.

Der man-Befehl wurde entwickelt, um direkt von der Befehlszeile aus auf die elektronischen Fassungen dieser gedruckten Handbuchseiten zuzugreifen. So ließ sich die benötigte Dokumentation leichter finden, und der Griff zum gedruckten Handbuch wurde seltener nötig. In späteren Unix-Versionen wurde dieses System weiter verfeinert und ausgebaut.

Als Linus Torvalds Anfang der 1990er-Jahre Linux entwickelte, übernahm das System etliche Eigenschaften von Unix, darunter auch den man-Befehl. Das Projekt „Linux man-pages“ wurde ins Leben gerufen, damit Linux-spezifische Dokumentation jederzeit verfügbar ist, von einfachen Befehlen bis hin zu fortgeschrittenen Systemaufrufen und Konfigurationsdateien.

Gibt jemand man gefolgt von einem Befehlsnamen ein, durchsucht das System die Datenbank der Handbuchseiten und ruft die passende Dokumentation ab. Dabei werden vordefinierte Verzeichnisse durchsucht, in denen Man Pages abgelegt sind, und es wird eine aktuelle systemweite Datenbank aufgebaut. So erhalten Benutzer:innen korrekte und vollständige Informationen.

(Die Aktualisierung der eigenen „man db“ (Datenbank) wird in den Paketverwaltungen vieler Linux-Distributionen häufig als Schritt nach der Installation angestoßen. Das sorgt dafür, dass Updates, Installationen und Deinstallationen Ihre Dokumentation ebenso aktuell, aufgeräumt und (theoretisch) fehlerfrei zurücklassen wie Ihre Software selbst.

man in der Praxis: Beispiele von einfach bis fortgeschritten

Wie bereits erwähnt, können Sie Man Pages für gängige Befehle (z. B. ls, grep oder ssh) direkt über die Befehlszeile aufrufen, indem Sie man [Befehl] für den gewünschten Befehl eingeben. Fortgeschrittenere Funktionen wie die Stichwortsuche werden weiter unten behandelt.

Navigation in Man Pages

Die Navigation in Man Pages ist unkompliziert. Wer vim-kompatible Editoren nutzt, wird die Tastenbelegung wiedererkennen:

Tipps und Tricks für den souveränen Umgang mit dem man-Befehl

Ausgabe des man-Befehls anpassen:

• man mit anderen Befehlen kombinieren: Sie können man mit anderen Befehlen kombinieren, um die Ausgabe einer Man Page weiterzuverarbeiten. man ls | grep -i sort filtert zum Beispiel die Man Page von ls so, dass nur Zeilen mit dem Begriff „sort“ angezeigt werden.
• Anzeigeformat von Man Pages anpassen: Standardmäßig wird der Befehl less verwendet, um den Inhalt der Man Page in einem navigier- und durchsuchbaren Format anzuzeigen. Über Umgebungsvariablen wie MANPAGER und MANWIDTH lässt sich die Ausgabe verändern. Mit export MANPAGER=“less -S“ werden Man Pages beispielsweise in less mit aktiviertem horizontalem Scrollen angezeigt.

Eine typische Man Page enthält Abschnitte wie NAME, SYNOPSIS, DESCRIPTION, OPTIONS und EXAMPLES. Diese Gliederung sorgt für eine einheitliche Struktur, die das schnelle Auffinden der gesuchten Informationen erleichtert.

Sie verbessert die Lesbarkeit und stellt sicher, dass wichtige Details nicht übersehen werden. Dadurch ist die Dokumentation für Einsteiger:innen wie für erfahrene Benutzer:innen gleichermaßen praktisch und effizient.

Jeder Abschnitt hat einen bestimmten Zweck:

• NAME: Kurzbeschreibung des Befehls. Sie macht den Zweck des Befehls sofort deutlich.
• SYNOPSIS: Zusammenfassung der Befehlssyntax. Dieser Abschnitt zeigt, wie der Befehl verwendet wird, einschließlich Parameter und Optionen.
• DESCRIPTION: Ausführliche Erläuterung der Funktionsweise des Befehls. Hier erfahren Sie im Detail, was der Befehl tut und wie er arbeitet.
• OPTIONS: Liste der verfügbaren Optionen samt Beschreibung. Dieser Abschnitt hilft dabei, die verschiedenen Flags und Parameter zu verstehen, die das Verhalten des Befehls verändern.
• EXAMPLES: Praktische Anwendungsbeispiele. Sie zeigen typische Einsatzfälle und veranschaulichen, wie sich der Befehl in der Praxis nutzen lässt.

Fortgeschrittene Anwendungsfälle für man

Bestimmte Abschnitte aufrufen und extrahieren

• Nach Abschnittsnummer filtern: So greifen Sie auf bestimmte Abschnitte von Man Pages zu. man 3 printf ruft zum Beispiel die Dokumentation der Funktion printf aus der C-Standardbibliothek auf. Hier eine Liste der nummerierten Abschnitte von Man Pages:
  • 1: Benutzerbefehle (ausführbare Programme oder Shell-Befehle)
  • 2: Systemaufrufe (vom Kernel bereitgestellte Funktionen)
  • 3: Bibliotheksaufrufe (Funktionen innerhalb von Programmbibliotheken)
  • 4: Spezielle Dateien (üblicherweise in /dev)
  • 5: Dateiformate und Konventionen (z. B. /etc/passwd)
  • 6: Spiele und Bildschirmschoner
  • 7: Verschiedenes (einschließlich Makropakete und Konventionen)
  • 8: Befehle zur Systemadministration (meist nur für root)
  • 9: Kernel-Routinen (nicht standardisiert)

• Einzelne Abschnitte isolieren: Extrahieren Sie bestimmte Abschnitte wie EXAMPLES mit Werkzeugen wie awk oder sed. Beispiel: man ls | sed -n ‚/^EXAMPLES/,/^$/p‘ extrahiert den Abschnitt EXAMPLES aus der Man Page von ls.

Eigene Man Pages erstellen

• Eigene Dokumentation schreiben: Erstellen Sie eigene Man Pages für selbst entwickelte Skripte und Befehle. Dazu schreiben Sie eine Man Page in eine Textdatei und installieren sie für den man-Befehl. Beispiel: sudo cp mycommand.1 /usr/local/man/man1/ installiert eine eigene Man Page.
• man-Seiten in Skripte einbetten: Binden Sie Dokumentation direkt in Skripte ein, die sich über man abrufen lässt. Mit dem Befehl cat geben Sie den eingebetteten Text der Man Page aus. Beispiel: man ./myscript zeigt die eingebettete Man Page von myscript an.

man mit anderen Werkzeugen verbinden

• man mit apropos kombinieren: Nutzen Sie apropos, um Befehle zu einem Stichwort zu finden, und leiten Sie die Ergebnisse anschließend an man weiter. Beispiel: apropos network | xargs -n 1 man -k sucht nach netzwerkbezogenen Befehlen und zeigt deren Man Pages an.
  • Hinweis: man vs. apropos vs. info: Der man-Befehl liefert ausführliche Handbuchseiten zu Befehlen und Programmen in strukturierter Form, apropos durchsucht die Beschreibungen der Handbuchseiten nach Stichwörtern und hilft so, Befehle zu einem bestimmten Thema zu finden, und info zeigt Dokumentation im Hypertext-Format an, oft mit detaillieteren Informationen und besserer Navigation als man.

• Dokumentationssuche automatisieren: Schreiben Sie Skripte, die das Suchen und Anzeigen von Man Pages anhand von Eingaben automatisieren. Beispiel: #!/bin/bash read -p „Enter command: “ cmd; man $cmd fragt einen Befehl ab und zeigt dessen Man Page an.

Ausgabe anpassen und verbessern

• Ausgabe für bessere Lesbarkeit formatieren: Passen Sie die Ausgabe von Man Pages über Umgebungsvariablen und Optionen an. Beispiel: export MANWIDTH=80; man ls legt die Ausgabebreite fest und verbessert so die Lesbarkeit auf schmalen Bildschirmen.
• Man Pages in andere Formate umwandeln: Wandeln Sie Man Pages in HTML oder PDF um, um sie offline zu lesen oder auszudrucken. Beispiel: man -t ls | ps2pdf – ls.pdf wandelt die Man Page von ls in eine PDF-Datei um.

Fortgeschrittene Suchtechniken

• Volltextsuche in Man Pages: Führen Sie mit Werkzeugen wie grep eine Volltextsuche über alle installierten Man Pages durch. Beispiel: grep -r ‚keyword‘ /usr/share/man/man* sucht ein Stichwort in allen Man Pages.
• Reguläre Ausdrücke verwenden: Finden Sie mit regulären Ausdrücken komplexe Muster in Man Pages. Beispiel: man ls | grep -E ‚\-l | \-a‘ sucht in der Man Page von ls nach den Optionen -l und -a.

Lokalisierung und Internationalisierung

• Man Pages in anderen Sprachen aufrufen: Setzen Sie die Umgebungsvariable LANG, um Man Pages in anderen Sprachen aufzurufen. Beispiel: LANG=es_ES.UTF-8 man ls zeigt die Man Page von ls auf Spanisch an.
• Mehrsprachige Man Pages erstellen: Schreiben und installieren Sie mehrsprachige Man Pages für eigene Befehle, damit sie in verschiedenen Sprachumgebungen verfügbar sind.

Man Pages in IDEs und Editoren einbinden

• Einbindung in IDEs: Konfigurieren Sie Integrierte Entwicklungsumgebungen (IDEs) so, dass sie Man Pages für markierte Befehle oder Funktionen anzeigen. Beispiel: Vim mit dem Befehl :Man einrichten, um Man Pages direkt im Editor zu lesen.
• Editor-Plugins: Nutzen Sie Editor-Plugins, die schnellen Zugriff auf Man Pages bieten. Beispiel: Das Plugin vim-man installieren, um Man Pages in Vim mit einem einfachen Befehl nachzuschlagen.

man in Skripten und in der Automatisierung nutzen

• Das Tool man lässt sich in Skripten einsetzen, um Informationen aus Man Pages automatisiert zu extrahieren. Beispiel: man ls | col -b | grep -A2 ‚^ *-l ‚ extrahiert die Beschreibung der Option -l für den Befehl ls. Diese Technik eignet sich gut, um automatisierte Dokumentationswerkzeuge zu erstellen oder Befehlshilfen in eigene Skripte einzubinden.

Mehr Souveränität auf Ihrem Linux-Weg

Der man-Befehl ist für Linux-Benutzer:innen ein unverzichtbares Tool, das sofortigen Zugriff auf umfassende Dokumentation zu Befehlen und Programmen bietet. Er erleichtert es, die verschiedenen Werkzeuge der Linux-Umgebung zu verstehen und wirksam einzusetzen.

Probieren Sie man aus und experimentieren Sie mit weiteren Linux-Befehlen, um Ihr Verständnis und Ihre Fertigkeiten zu vertiefen. Je vertrauter Sie mit diesen Werkzeugen sind, desto wirksamer können Sie Ihre Systeme verwalten und Probleme beheben. Vertiefen Sie dieses praxisnahe Wissen mit unserem Video-Leitfaden zu den wichtigsten Linux-Befehlen

Abschließend zur Rolle von man für den effektiven Umgang mit der Linux-Befehlszeile: Den man-Befehl zu beherrschen, gehört zu den Grundfertigkeiten für alle, die mit der Linux-Befehlszeilenschnittstelle arbeiten. Er liefert nicht nur die nötige Dokumentation, sondern macht Sie auch unabhängiger und sicherer im Umgang mit dem Betriebssystem Linux.

Sie können sich auch das Video So verwenden Sie den man-Befehl unter Linux (mit Beispielen für Einsteiger:innen bis Profis) ansehen.