Man: Unterschied zwischen den Versionen

Versionsgeschichte interaktiv durchsuchen

Aktuelle Version vom 13. April 2025, 12:05 Uhr

Beschreibung

Jedes an man übergebene Argument Seite ist normalerweise der Name eines Programms oder einer Funktion
Gefunden und angezeigt wird die Handbuchseite, die auf jedes der Argumente passt
Wenn ein Abschnitt angegeben wird, sucht man nur in diesem Abschnitt der Handbuchseiten
Ohne eine explizite Angabe werden alle verfügbaren Abschnitte in einer festgelegten Reihenfolge durchsucht (siehe VOREINSTELLUNGEN) und nur die jeweils zuerst gefundene Seite angezeigt, wenn die Seite in mehreren Abschnitten vorkommt

Installation

sudo apt install man

Aufruf

man [man Optionen] [[Abschnitt] Seite ...] ..
man -k [apropos Optionen] Regulärer_Ausdruck ..
man -K [man Optionen] [Abschnitt] Begriff ..
man -f [whatis Optionen] Seite ..
man -l [man Optionen] Datei ..
man -w|-W [man Optionen] Seite ..

Anwendung

Suche in Manual-Pages

Die Einzeldokumentationen enthalten am Beginn einen Abschnitt (Name), der den Zweck des Programms kurz beschreibt (Apropos)
In diesem Abschnitt kann nach bestimmten Stichworten gesucht werden
Für jeden Manualeintrag, der im Abschnitt "Name" dieses Stichwort enthält, wird ein entsprechender Hinweis ausgegeben

$ apropos <stichwort>

Alternative

$ man -k <stichwort>

Beispiel

Sie suchen die Beschreibung des Aufbaus der Passwortdatenbank /etc/passwd

$ man -k passwd
passwd (5) - password file
passwd, npasswd (1) - change login password
rpc.yppasswdd (8) - NIS password update server
yppasswd, ypchfn, ypchsh (1) - NIS password update clients

Die Angaben in Klammern (zum Beispiel passwd (5)) geben an, in welcher Sektion des Manuals sich dieser Eintrag befindet

Die gewünschte Information kann aufgerufen werden

$ man –S 5 passwd

oder kurz mit

$ man 5 passwd

Manpage exportieren

man loginctl > loginctl.txt

Beispiele

Handbuchseite für ls anzeigen

man ls

Handbuchseite für das Makropaket man aus Abschnitt 7 anzeigen

Dies sind alternative Schreibweisen für man 7 man

man 'man(7)'
man man.7

Zeigt die Handbuchseite für das Makropaket man aus Abschnitt 7 an

Dies ist eine weitere alternative Schreibweise für "man 7 man"
Dies könnte beim Kopieren und Einfügen von Querverweisen in Handbuchseiten bequemer sein
Beachten Sie, dass die Klammern normalerweise in Anführungszeichen gesetzt werden müssen, um zu verhindern, dass sie von der Shell interpretiert werden

Zeigt nacheinander alle vorhandenen intro-Handbuchseiten an

Sie können zwischen den aufeinander folgendenden Ausgaben der Seiten abbrechen oder beliebige Seiten überspringen

man -a intro

Formatiert die Handbuchseite für bash in das Standardformat von Troff oder Groff und schickt sie zum Drucker ps

Für Groff ist das Standardausgabeformat gewöhnlich PostScript
Mit man --help können Sie herausfinden, welcher Prozessor mit der Option -t verbunden ist

Dieser Befehl dekomprimiert und formatiert den Nroff-Quelltext der Handbuchseite ./foo.1x.gz in eine geräteunabhängige (device-independent)

dvi-Datei

Die Umleitung der Ausgabe ist notwendig, da die Option -T ohne Anzeigeprogramm die Ausgabe zur Standardausgabe schickt
Die Ausgabe kann mit einem Programm wie xdvi betrachtet oder mit einem Programm wie dvips zu PostScript weiterverarbeitet werden

man -l -T dvi ./foo.1x.gz > ./foo.1x.dvi

Sucht in den Beschreibungen und Namen der Handbuchseiten nach dem als regulären Ausdruck angesehenen Schlüsselwort printf und gibt alle Fundstellen aus

Diese Option entspricht apropos printf

man -k printf

Sucht die durch smail angegebenen Handbuchseiten und gibt alle Beschreibungen der gefundenen Seiten aus

Diese Option entspricht apropos smail

man -f smail

Parameter

Exit-Status

Anhang

Siehe auch

Dokumentation

Man-Pages

Info-Pages

Links

Weblinks

@@ Zeile 1: / Zeile 1: @@
-==Funktion==
+'''man''' - [[manpage |Systemhandbücher]] anzeigen
+== Beschreibung ==
+''man'' zeigt [[manpage|Systemhandbücher]] an
+* Jedes an man übergebene Argument Seite ist normalerweise der Name eines Programms oder einer Funktion
+* Gefunden und angezeigt wird die Handbuchseite, die auf jedes der Argumente passt
+* Wenn ein Abschnitt angegeben wird, sucht man nur in diesem Abschnitt der Handbuchseiten
+* Ohne eine explizite Angabe werden alle verfügbaren Abschnitte in einer festgelegten Reihenfolge durchsucht (siehe VOREINSTELLUNGEN) und nur die jeweils zuerst gefundene Seite angezeigt, wenn die Seite in mehreren Abschnitten vorkommt
-Mit dem Befehl "man" kann man in einer Konsole/Shell/Bash eine Manual (Anleitung) für auf dem PC installierte Software oder andere Konsolenbefehle aufrufen. Darin sind unter anderem eine Beschreibung der Funktionsweise und des Aufbaus, eine Übersicht über die verwendbaren Schalter und damit verbundenen Änderungen der Funktionsweise der Befehle, eine Auflistung der Abschnitte des Manuals, Optionen zur Formatierung der Konsolenausgabe, sowie ein Hilfemenü zu finden.
+== Installation ==
+<syntaxhighlight lang="bash" highlight="1" line>
+sudo apt install man
+</syntaxhighlight>
-* Man Pages sind ein komfortabel zu benutzendes Hilfesystem und stehen für fast alle Linux-Befehle zur Verfügung
+== Aufruf ==
-* Geben Sie einfach den Befehl <code>man</code>, gefolgt von dem zu erklärenden Befehl, auf der Kommandozeile ein, und schon erhalten Sie eine genaue Beschreibung.
+<syntaxhighlight lang="bash" highlight="1-6" line>
+man [man Optionen] [[Abschnitt] Seite ...] ..
+man -k [apropos Optionen] Regulärer_Ausdruck ..
+man -K [man Optionen] [Abschnitt] Begriff ..
+man -f [whatis Optionen] Seite ..
+man -l [man Optionen] Datei ..
+man -w|-W [man Optionen] Seite ..
+</syntaxhighlight>
-== Beispiel==
+== Anwendung ==
+=== Suche in Manual-Pages ===
+* Die Einzeldokumentationen enthalten am Beginn einen Abschnitt (Name), der den Zweck des Programms kurz beschreibt (Apropos)
+* In diesem Abschnitt kann nach bestimmten Stichworten gesucht werden
+* Für jeden Manualeintrag, der im Abschnitt "Name" dieses Stichwort enthält, wird ein entsprechender Hinweis ausgegeben
+ $ '''apropos <stichwort>'''
-[[Datei:Screenshot 20201104 095015.png|mini]]
+=== Alternative ===
+ $ '''man -k <stichwort>'''
+'''Beispiel'''
+Sie suchen die Beschreibung des Aufbaus der Passwortdatenbank /etc/passwd
+ $ '''man -k passwd'''
+ passwd (5) - password file
+ passwd, npasswd (1) - change login password
+ rpc.yppasswdd (8) - NIS password update server
+ yppasswd, ypchfn, ypchsh (1) - NIS password update clients
+Die Angaben in Klammern (zum Beispiel passwd (5)) geben an, in welcher Sektion des Manuals sich dieser Eintrag befindet
+Die gewünschte Information kann aufgerufen werden
+ $ '''man –S 5 passwd'''
+oder kurz mit
+ $ '''man 5 passwd'''
+=== Manpage exportieren ===
+ man loginctl > loginctl.txt
+=== Beispiele ===
+; Handbuchseite für ''ls'' anzeigen
+<syntaxhighlight lang="bash" highlight="1" line>
+man ls
+</syntaxhighlight>
-= Mehr Beispiele=
+; Handbuchseite für das Makropaket man aus Abschnitt 7 anzeigen
-man ls, man cat, man cp und soweiter und sofort.
+* Dies sind alternative Schreibweisen für ''man 7 man''
+<syntaxhighlight lang="bash" highlight="1" line>
+man 'man(7)'
+man man.7
+</syntaxhighlight>
-==Syntax==
+; Zeigt die Handbuchseite für das Makropaket man aus Abschnitt 7 an
-man "Schalter" "Name des Befehls/der Software"
+* Dies ist eine weitere alternative Schreibweise für "man 7 man"
- man -k man
+* Dies könnte beim Kopieren und Einfügen von Querverweisen in Handbuchseiten bequemer sein
+* Beachten Sie, dass die Klammern normalerweise in Anführungszeichen gesetzt werden müssen, um zu verhindern, dass sie von der Shell interpretiert werden
+; Zeigt nacheinander alle vorhandenen ''intro''-Handbuchseiten an
+* Sie können zwischen den aufeinander folgendenden Ausgaben der Seiten abbrechen oder beliebige Seiten überspringen
+<syntaxhighlight lang="bash" highlight="1" line>
+man -a intro
+</syntaxhighlight>
-==Funktionsweise==
+; Formatiert die Handbuchseite für bash in das Standardformat von Troff oder Groff und schickt sie zum Drucker ps
-* Immer, wenn Sie eine man Page aufrufen, konsultiert das Programm ''man'' die in der Variablen ''$MANPATH'' enthaltenen Verzeichnisse. Hier können mehrere Verzeichnisse auf einmal hinterlegt sein<br>
+* Für Groff ist das Standardausgabeformat gewöhnlich PostScript
-* In nach Sektionen unterteilten Unterverzeichnissen befinden sich die Dateien der man Pages im komprimierten Zustand<br>
+* Mit man --help können Sie herausfinden, welcher Prozessor mit der Option -t verbunden ist
-* Das man System dekomprimiert die angeforderte Datei und übergibt sie anschließend an einen Pager. Dieser zeigt daraufhin die gewünschte man Page an.
-=Sektionen=
+; Dieser Befehl dekomprimiert und formatiert den Nroff-Quelltext der Handbuchseite ./foo.1x.gz in eine geräteunabhängige (device-independent)
-Das Man System ist in mehrere Sektionen unterteilt. Diese Sektionen sind folgendermaßen gegliedert:
+dvi-Datei
-* ausführbare Programme für Benutzer
+* Die Umleitung der Ausgabe ist notwendig, da die Option -T ohne Anzeigeprogramm die Ausgabe zur Standardausgabe schickt
-* Systemaufrufe (Funktionen, die durch den Kernel unterstützt werden)
+* Die Ausgabe kann mit einem Programm wie xdvi betrachtet oder mit einem Programm wie dvips zu PostScript weiterverarbeitet werden
-* Bibliothek aufrufe (Libraries)
+<syntaxhighlight lang="bash" highlight="1" line>
-* besondere Dateien (normalerweise in ''/dev'')
+man -l -T dvi ./foo.1x.gz > ./foo.1x.dvi
-* Dateiformate und Konventionen
+</syntaxhighlight>
-* Spiele
-* Sonstiges (Makro-Pakete und Konventionen)
-* administrative Programme (nur für den User root)
-* Kernel-Routinen (nicht standardisiert)
-== Aufbau ==
+; Sucht in den Beschreibungen und Namen der Handbuchseiten nach dem als regulären Ausdruck angesehenen Schlüsselwort printf und gibt alle Fundstellen aus
-Der Aufbau einer Manpage ist festgelegt und sollte immer die folgenden Elemente enthalten:
+* Diese Option entspricht apropos printf
-*''Name'' – die Bezeichnung des Elements mit einer kurzen Beschreibung
+<syntaxhighlight lang="bash" highlight="1" line>
-*''Synopsis'' – eine vollständige Kurzbeschreibung der Syntax
+man -k printf
-*''Description'' – eine ausführliche Beschreibung des Elements
+</syntaxhighlight>
-*''Defaults'' – voreingestellte Parameter
-*''Overview'' – ein Überblick über die komplexeren Zusammenhänge
-*''Options'' – Optionen und deren Beschreibung
-*''Return Values'' – Informationen über eventuelle Rückgabewerte, teilweise auch als Exit-Status bezeichnet
-*''See also'' – Verweise auf artverwandte Themen
-*''Bugs'' – bekannte Fehler
-*''Files'' – Konfigurationsdateien u. Ä.
-Es sind noch mehr Elemente denkbar, aber die hier aufgeführten sind die wohl geläufigsten.
-==$MANPATH und die Datei manpath.config==
+; Sucht die durch smail angegebenen Handbuchseiten und gibt alle Beschreibungen der gefundenen Seiten aus
-* Wie bereits erwähnt, enthält die Variable <code>$MANPATH</code> Informationen darüber, wo sich die Manpages überhaupt befinden<br>
+* Diese Option entspricht apropos smail
-* Genauere Informationen darüber erhalten Sie in der Konfigurationsdatei ''/etc/manpath.config.'' Wenn dem System neue Manpages hinzugefügt werden, wird diese Datei normalerweise bei Bedarf auch automatisch aktualisiert<br>
+<syntaxhighlight lang="bash" highlight="1" line>
-* Ein manueller Eingriff ist in der Regel nicht nötig. Um den aktuellen MANPATH zu ermitteln, geben Sie einfach das Kommando <code>manpath</code> ohne Parameter ein. Das Ergebnis sieht dann beispielsweise so aus:
+man -f smail
- archangel:/ # manpath
+</syntaxhighlight>
- /usr/share/man:/usr/local/man:/usr/X11R6/man:/opt/gnome/share/man
-* Ein weiterer wichtiger Pfad ist der, in dem das Mansystem seine Temporärdateien ablegt. Wie bereits erwähnt, sind Manpages im Rohformat komprimiert. Deshalb werden sie vor dem Anzeigen in ein temporäres Verzeichnis dekomprimiert<br>
-* In der Regel handelt es sich hierbei um das Verzeichnis ''/var/cache/man.'' Dieses Verzeichnis wird, gestützt durch den Daemon cron, zyklisch von catman bereinigt<br>
-* Um das Cache-Verzeichnis Ihres Computers ausfindig zu machen, geben Sie das Kommando <code>manpath -c</code> ein:
- archangel:/ # manpath -c
- /var/cache/man:/var/cache/man/local:/var/cache/man/opt
+=== Parameter ===
+=== Exit-Status ===
-[[Category:Linux:Dokumentation]]
+<noinclude>
+== Anhang ==
+=== Siehe auch ===
+{{Special:PrefixIndex/{{BASEPAGENAME}}/}}
+=== Dokumentation ===
+; Man-Pages
+; Info-Pages
+=== Links ===
+==== Weblinks ====
+{{DEFAULTSORT:man}}
+{{DISPLAYTITLE:man}}
+[[Kategorie:Linux/Befehl]]
+[[Kategorie:Manpage]]
+</noinclude>