VMware ESXi and vSphere Cluster Management

Linux-Manpages mit dem Befehl man verwenden

Lerne, wie du mit man und man -k Linux-Handbuchseiten öffnest, Optionen prüfst und unbekannte Befehle findest.

Linux enthält sehr viele Befehle, Optionen und Systemwerkzeuge. Niemand muss deren vollständige Syntax auswendig kennen. Für das Nachschlagen steht auf vielen Linux-Systemen eine lokale Dokumentation bereit: die Manpages.

Eine Manpage ist eine Dokumentationsseite für einen Befehl oder ein Systemthema. Manpage ist die Kurzform von manual page, also „Handbuchseite“. Das Kommando man zeigt diese Seiten im Terminal an.

Wofür Manpages gedacht sind

Manpages sind eine bevorzugte lokale Informationsquelle für Linux-Befehle. Sie helfen dir, einen unbekannten Befehl zu verstehen, die richtige Aufrufweise zu prüfen und die Bedeutung einzelner Optionen nachzulesen. Dadurch kannst du Befehle vor ihrer Verwendung kontrollieren, statt wichtige Details zu erraten.

Eine Option ist ein Zusatzargument, das das Verhalten eines Befehls steuert. Die Syntax beschreibt die vorgegebene Form, in der ein Befehl mit Optionen und weiteren Argumenten aufgerufen wird.

Der Grundaufruf von man

Die allgemeine Syntax lautet:

man <befehl>

Ersetze <befehl> durch den Namen des Befehls, dessen Dokumentation du lesen möchtest. Um beispielsweise die Handbuchseite von ls zu öffnen, verwendest du:

man ls

Die Manpage erklärt dann unter anderem, wofür ls verwendet wird, wie der Befehl aufgerufen wird und welche Optionen verfügbar sind.

Auch man selbst ist ein Befehl und besitzt daher eine eigene Handbuchseite:

man man

Dieser Aufruf ist besonders nützlich, wenn du die Funktionen und Optionen des Dokumentationsprogramms selbst nachschlagen möchtest.

Welche Informationen eine Manpage enthält

Der genaue Aufbau kann je nach Befehl variieren, typische Inhalte sind jedoch:

• Zweck und Funktion: Eine kurze Erklärung, was der dokumentierte Befehl macht.
• Aufrufweise und Syntax: Die Form, in der der Befehl mit Argumenten und Optionen verwendet wird.
• Optionen: Einzelne Zusatzargumente und ihre Auswirkungen auf das Verhalten des Befehls.
• Zusätzliche Angaben: Beispielsweise Referenzen, Urheberrechtsinformationen oder Hinweise zu verwandten Themen.

Beim Nachschlagen einer Option solltest du besonders den Abschnitt zu den Optionen lesen. Dort steht normalerweise, ob eine Option ein weiteres Argument benötigt und welche Wirkung sie hat.

Manpages mit less lesen

Eine Manpage wird normalerweise nicht einfach als einmalige Textausgabe ausgegeben. Sie wird in einem textbasierten Pager geöffnet. Ein Pager zeigt längere Texte seitenweise an. Das übliche Programm dafür ist less.

Nach man ls befindest du dich also in einer less-Sitzung. Du kannst dich durch den Text bewegen, nach Begriffen suchen und die Anzeige anschließend verlassen.

Eine typische Vorgehensweise ist, die Manpage zu öffnen und anschließend nach einem Abschnitt oder einer Option zu suchen. Bei man ls kannst du beispielsweise mit /sort nach Vorkommen des Begriffs „sort“ suchen.

Manpages nach Stichwörtern durchsuchen

Wenn du den genauen Befehlsnamen nicht kennst, hilft die Option -k. Sie durchsucht die Namen von Manpages und deren Kurzbeschreibungen nach einem Suchwort.

Die allgemeine Syntax lautet:

man -k <suchwort>

Ein Suchwort ist ein Begriff, der die gewünschte Aufgabe oder Funktion beschreibt. Die Suche nach Werkzeugen zum Löschen kann zum Beispiel so aussehen:

man -k delete

Die Ausgabe listet passende Manpage-Einträge auf. Typischerweise enthält jede Ergebniszeile einen Befehlsnamen und eine kurze Zusammenfassung:

rmdir     (1) remove empty directories
shred     (1) overwrite a file to hide its contents
unlink    (1) call the unlink function to remove a file

Die konkreten Treffer hängen von deiner Distribution und den installierten Manpages ab. Lies die Kurzbeschreibungen und öffne anschließend einen passenden Eintrag mit man. Beachte, dass viele Kurzbeschreibungen englische Begriffe verwenden. Eine Suche mit delete kann daher erfolgreicher sein als eine Suche mit dem deutschen Wort „löschen“.

Wichtige man-Aufrufe

Praktischer Ablauf im Linux-Alltag

1. Aufgabe bestimmen: Formuliere, was du erledigen möchtest, zum Beispiel ein Verzeichnis löschen oder Dateien anzeigen.
2. Befehl suchen: Wenn der Name unbekannt ist, verwende ein passendes, häufig englisches Stichwort mit man -k.
3. Manpage öffnen: Lies mit man <befehl> den Zweck, die Syntax und die verfügbaren Optionen.
4. Option prüfen: Suche innerhalb der Seite nach der betreffenden Option oder lies den Abschnitt zu den Optionen.
5. Befehl ausführen: Verwende den Befehl erst, wenn du verstanden hast, welche Argumente und Optionen erforderlich sind.

Beim Löschen eines Verzeichnisses könntest du zunächst suchen, wenn dir der genaue Name des Werkzeugs unbekannt ist:

man -k delete

Anschließend öffnest du die Manpage eines passenden Befehls und prüfst seine Einschränkungen. So erkennst du beispielsweise, ob ein Werkzeug nur leere Verzeichnisse löscht oder welche Optionen sein Verhalten verändern.

Fehler und Lösungen

Der Befehlsname ist unbekannt

Verwende man -k mit einem Aufgaben- oder Funktionsbegriff. Vergleiche die Kurzbeschreibungen der Treffer und öffne danach die wahrscheinlich passende Manpage.

Die Manpage ist sehr lang

Behandle die Anzeige als less-Sitzung: Blättere mit den vorgesehenen Tasten, suche mit /Suchbegriff nach einem Thema und beende die Anzeige mit q.

Die Bedeutung einer Option ist unklar

Öffne die Manpage des betreffenden Befehls und lies den Abschnitt zu den Optionen vollständig genug, um Nebenwirkungen, benötigte Argumente und Einschränkungen zu verstehen.

Prüfungsrelevante Merksätze

• man bedeutet sinngemäß „manual page“ und zeigt lokale Unix- und Linux-Handbuchseiten an.
• man <befehl> öffnet die Dokumentation für den angegebenen Befehl.
• man man zeigt die Handbuchseite von man selbst.
• Manpages enthalten typischerweise Zweck, Syntax, Optionen und zusätzliche Referenzinformationen.
• less ist der textbasierte Pager, in dem Manpages gelesen werden; q beendet die Anzeige.
• man -k <suchwort> sucht in Manpage-Namen und Kurzbeschreibungen, wenn der genaue Befehlsname unbekannt ist.

Weitere Inhalte findest du unter Linux-Manpages.