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:
Sucht man Hilfe zur Funktion und den Optionen eines bestimmten Konsolenbefehls oder Programms, so kann man sich im Terminal [3] schnell 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.
Funktion¶
Die Syntax des Aufrufes lautet:
man [Option] [Thema]
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
oderfirefox
)
Sprache¶
Die manpages liegen in der Regel in englischer Sprache vor. Wer sie auf deutsch bevorzugt, sollte sich das Paket
manpages-de (universe, [2])
installieren [1].
man-Optionen¶
Die Optionen | |||
Option | Bedeutung | ||
-k Schlüsselwort | zur Suche von Manual-Seiten mit einem bestimmten Schlüsselwort | ||
-f Thema | Kurzinfo zum gewählten Thema |
man-Themenbereich¶
In Unix- und Linux Literatur oder auch in den man-Pages 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 Themenbereich 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 less 1
man-Tastenkürzel¶
Die Tastenkürzel | |||
Taste | Bedeutung | Taste | Bedeutung |
↑ 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 Such modus "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 |
Bequeme Hilfe im Browser¶
Benutzer des Konqueror können sich die manpages komfortabel im Browser anschauen. Dazu gibt man einfach als Adresse folgendes ein:
man:SEITENNAME
oder
info:SEITENNAME
oder
#SEITENNAME
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 Gui-Tool gnome-help.
Möchte man jedoch mit Firefox, IceCat oder Opera genauso wie mit Konqueror die Manpages direkt im Browser lesen findet man hier ein leicht zu installierendes Skript mit dem dies ermöglicht wird: Manpages im Browser lesen.
Grafische Frontends¶
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
Manpages ohne man 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:
nroff -man /Pfad/Zur/Manpage | less
Weiterführende Themen¶
Um manpages auf Webservern bereit zu stellen, dient das Paket man2html (universe) oder, möchte man die gesamte Breite der mitgelieferten Dokumentation nutzen, dpkg-www.
Eine Manpage erstellen ist auch nicht schwer.