ubuntuusers.de

man

Dieser Artikel wurde für die folgenden Ubuntu-Versionen getestet:

Dieser Artikel ist größtenteils für alle Ubuntu-Versionen gültig.

Zum Verständnis dieses Artikels sind folgende Seiten hilfreich:

Wiki/Icons/terminal.png Sucht man Hilfe zur Funktion und den Optionen eines bestimmten Befehls oder Programms, so kann man sich im Terminal [1] umfangreiche Hilfedateien anzeigen lassen: Die sogenannten Manpages. "man" steht für Manual (Anleitung). Diese Anleitungen haben unter Linux/Unix eine lange Tradition und werden ständig gepflegt.

Wer gerade nicht am eigenen Rechner sitzt, kann Manpages auch online im Browser nachschlagen.

Installation

Das Programm man ist normalerweise in der Standardinstallation enthalten, kann aber ansonsten über das Paket

  • man-db

installiert werden [2].

Die Handbuchseiten von neuen Programmen werden automatisch durch die Paketverwaltung in /usr/share/man/ gespeichert, dort finden sich alle Manpages in Sprachen und Themen sortiert.

Funktion

Die Syntax des Aufrufs lautet:

man [OPTION] THEMA 

oder praktisch:

man name_des_programms 

Beendet wird die Anzeige der Manpage mit der Taste Q (quit).

Umfang

Es gibt Manpages für folgende Bereiche:

  • Konsolenprogramme (z.B. ln)

  • Geräte (z.B. hd)

  • Dateiformate und Protokolle (z.B. nfs)

  • Konventionen und Standards (z.B. ascii)

  • Kommandos zur Systemadministration

  • Anwendungsprogramme (z.B. gedit oder firefox)

Sprache

Die Manpages liegen in der Regel in englischer Sprache vor. Wer sie auf deutsch bevorzugt, sollte sich das Paket

  • manpages-de (universe)

Paketliste zum Kopieren:

sudo apt-get install manpages-de 

Oder mit apturl installieren, Link: apt://manpages-de

installieren [3]. Auch ohne obiges Paket werden teilweise deutsche Manpages installiert, die bei entsprechend gesetzter LANG-Umgebungsvariable auch standardmäßig angezeigt werden. Leider sind die Übersetzungen nicht immer auf dem aktuellsten Stand. Möchte man daher immer die englische Version betrachten, so ist das mittels des folgenden Aufrufs möglich:

man -L en_US.utf8 manpage-name 

Möchte man die Einstellung dauerhaft übernehmen, so bietet es sich an, in einer der Dateien ~/.bashrc oder ~/.bash_aliases ein Alias hinzuzufügen. Dazu fügt man folgende Zeile an die Datei an:

1
alias man="man -L en_US.utf8"

man-Optionen

Die Optionen
OptionBedeutung
-k Schlüsselwortzur Suche von Manual-Seiten mit einem bestimmten Schlüsselwort
-f ThemaKurzinfo zum gewählten Thema
-t > ausgabe.psErzeugt ein schön formatiertes Postscript-Dokument des Themas

man-Themenbereich

In Unix- und Linux-Literatur oder auch in den Manpages selbst ist häufig eine man-Nummer hinter dem Kommando angegeben, z.B. less(1), damit der man-Text zielgenau aufgerufen werden kann. Es gibt die Themenbereiche 1 bis 9 und n.

  • (1) Benutzerkommandos

  • (2) Systemaufruf

  • (3) Funktionen der Programmiersprache C

  • (4) Dateiformate

  • (5) Konfigurationsdateien

  • (6) Spiele

  • (7) Diverses

  • (8) Kommandos zur Systemadministration

  • (9) Kernelfunktionen

  • (n) Neue Kommandos

Die Eingabe für den Aufruf von less mit dem Thema (1) sieht so aus:

man 1 less 

man-Tastenkürzel

Die Tastenkürzel
TasteBedeutungTasteBedeutung
oder Y im Text nach oben scrollen oder E im Text nach unten scrollen
im Text nach links scrollen im Text nach rechts scrollen
Bild ↑ oder U oder B im Text seitenweise nach oben scrollen Bild ↓ oder D oder F im Text seitenweise nach unten scrollen
G zum Textanfang springen + G zum Textende springen
+ 7 in den Suchmodus "Vorwärtssuche" + ß in den Suchmodus "Rückwärtssuche"
N zum nächsten Suchresultat springen + N zum vorherigen Suchresultat springen
H Hilfetext mit vielen zusätzlichen Tasten und Optionen Q Beenden

Farbige Textanzeige

Unter Ubuntu wird standardmäßig less als Terminal Pager für die Anzeige einer Manpage verwendet. Möchte man für mehr Übersichtlichkeit einige Schlüsselworte im Text farblich hervorheben lassen, dann kann man stattdessen most 🇬🇧 dafür verwenden. Der unterstützt sozusagen eine Syntaxhervorhebung für Manpages.

Das gleichnamige Paket muss installiert sein:

  • most (universe)

Paketliste zum Kopieren:

sudo apt-get install most 

Oder mit apturl installieren, Link: apt://most

Und der Pager danach als Standard im Alternativen-System einrichten werden:

sudo update-alternatives --config pager 

Falsch installierte Manpages lesen

Manchmal gibt es Situationen, in denen man Manpages nicht mit dem man-Befehl lesen kann, da sie zum Beispiel nicht in den richtigen Ordnern liegen. Dann kann man sie mit folgendem Befehl lesen:

man -l /Pfad/Zur/Manpage 

Den Pfad zur Manpage (u.a.) erhält man mit dem Befehl whereis:

whereis name_des_programms 

Anzeige mittels grafischer Programme

Unter GNOME gibt es mit gnome-help - auch yelp genannt - ein grafisches Frontend zum Darstellen der Hilfetexte. Der Aufruf erfolgt durch

gnome-help man:SEITENNAME 

oder

yelp man:SEITENNAME 

Ist die Benutzeroberfläche KDE auf dem System installiert, kann man auch dessen Universalbetrachter Konqueror zum Anzeigen von man- und info-Seiten verwenden. Dazu gibt man in die Adresszeile eine der vier folgenden Aufruf-Varianten ein:

man:/SEITENNAME
man:SEITENNAME
#SEITENNAME
info:SEITENNAME 

Konqueror liefert eine besser lesbare Ausgabe, da es sich nicht strikt an die in den Manpages vorgegebene 80-Zeichen-pro-Zeile-Begrenzung hält, sondern die Absatzbreiten so formatiert, dass die volle Fensterbreite ausgenutzt wird.

Für den Firefox gilt etwa der gleiche Befehl, nämlich

man:SEITENNAME

als URL einzugeben. Zunächst erscheint ein Dialog mit der Frage, ob die entsprechende Anwendung gestartet werden soll. Bestätigt man diese (über eine Checkbox kann festgelegt werden, dass zukünftig die Anwendung immer gestartet werden soll), startet Firefox dann das grafische Werkzeug gnome-help.

Manpages übers Internet lesen

Die Manpages für alle unterstützen Ubuntu-Versionen findet man im tagesaktuellen Ubuntu Manpage Repository 🇬🇧. Das ermöglicht es auch, nicht installierte Manpages anzuschauen. Um bequem auf diese Seiten zuzugreifen, gibt es verschiedene Möglichkeiten:

  • Über die URL-Abkürzung manpg.es kann man alle Manpages über die Navigationszeile des Browsers erreichen, zum Beispiel: http://manpg.es/bash. Diese Kurzadressen kann man auch gut in E-Mails, IRC oder Kurznachrichtendiensten verwenden. Bestimmte Themenbereiche kann man erreichen, indem man einen Punkt und die Nummer anhängt, z.B. http://manpg.es/open.1.

  • Man kann diese Manpages auch über die Kommandozeile lesen. Dazu installiert man das Paket

    • bikeshed (universe)

    Paketliste zum Kopieren:

    sudo apt-get install bikeshed 

    Oder mit apturl installieren, Link: apt://bikeshed

    Dann kann man folgenden Befehl verwenden:

    dman SEITENNAME 

    Für frühere Ubuntuversionen kann man das Skript dman ⮷ herunterladen und als dman zum Beispiel unter ~/bin/ im Homeverzeichnis oder systemweit unter /usr/local/bin/ speichern (Root-Rechte erforderlich).

Export von Manpages

Generierung von PS-Dateien zum Drucken

Mit dem Befehl

man -Tps SEITENNAME > datei.ps 

kann man eine PS-Datei generieren, die man zum Drucken verwenden kann.

Generierung von durchsuchbaren PDF-Dateien

Mit dem Befehl

 man -t bash | ps2pdf - > bash.pdf 

kann man eine PDF-Datei generieren, die man auch durchsuchen kann.

Weiterführende Themen

  • Um Manpages auf Webservern bereitzustellen, dient das Paket man2html (universe). Möchte man die gesamte Breite der mitgelieferten Dokumentation nutzen: dpkg-www.

  • Eine weitere Möglichkeit, Manpages im Web bereitzustellen, ist das Ubuntu Manpage Repository 🇬🇧 (Code), welches beim Ubuntu Manpage Repository Anwendung findet. Es stellt die Manpages für eine vollständige Distribution als formatierte und Google-indizierte Webseiten bereit.

  • Eine Manpage erstellen ist auch nicht schwer.

  • info ist eine komfortable Alternative zu man

Diese Revision wurde am 2. November 2018 18:39 von ubot erstellt.
Die folgenden Schlagworte wurden dem Artikel zugewiesen: Shell