man

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 -Tdvi ./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

Optionen

Optionen ohne Argumente, die entweder in der Befehlszeile, in $MANOPT oder in beiden doppelt vorkommen, sind nicht schädlich

Für Optionen, die ein Argument benötigen, überschreibt jedes Duplikat den vorhergehenden Wert

Allgemein

Unix	GNU	Parameter	Beschreibung
-C	--config-file=	Datei	Verwendung dieser benutzerspezifischen Konfigurationsdatei an Stelle der Vorgabe ~/.manpath
-d	--debug		Ausgabe von Debug-Informationen
-D	--default		Diese Option wird normalerweise nur als die allererste angegeben und setzt das Verhalten von man auf die Vorgabewerte zurück Der Zweck dieser Option ist es, vielleicht schon in der Umgebungsvariablen $MANOPT gesetzte Optionen wieder aufzuheben Alle Optionen, die -D folgen, haben wieder ihren normalen Effekt
	--warnings	[=Warnmeldungen]	Aktiviert Groff-Warnmeldungen Damit kann der Zustand der Handbuch-Quelltexte geprüft werden Warnmeldungen ist eine kommagetrennte Liste von Warnungen Wird kein Wert vorgegeben, wird die Voreinstellung »mac« angewandt (siehe den Punkt »warnings« in info Groff für eine Liste verfügbarer Warnungen)

Haupt-Betriebsarten

Unix	GNU	Parameter	Beschreibung

-f, --whatis Diese Option ist äquivalent zu whatis

Wenn die Handbuchseite verfügbar ist, wird eine Beschreibung der gewünschten Handbuchseite angezeigt
Zu Details siehe whatis(1)

-k, --apropos Diese Option ist äquivalent zu apropos

Es werden die Beschreibungen der Handbuchseiten nach Schlüsselwörtern durchsucht und alle Treffer angezeigt
Zu Details siehe apropos(1)

-K, --global-apropos Sucht den Text in allen Handbuchseiten

Dieses Vorgehen mit roher Gewalt (brute-force) wird wahrscheinlich einige Zeit dauern
Daher sollten Sie, wenn möglich, einen Abschnitt angeben, um die Anzahl der zu durchsuchenden Seiten zu reduzieren
Suchbegriffe können einfache Zeichenketten (Voreinstellung) oder bei Verwendung der Option --regex reguläre Ausdrücke sein

Beachten Sie, dass dies die Quellen der Handbuchseiten, nicht den dargestellten Text, durchsucht und daher aufgrund von Kommentaren und ähnlichem in den Quelltexten falsche Treffer enthalten kann

Durchsuchen des dargestellten Textes wäre viel langsamer

-l, --local-file Aktiviert den »lokalen« Modus

Formatiert und zeigt lokale Handbuchdateien an, anstatt die System-Handbuchsammlung zu durchsuchen
Jedes Handbuchseiten-Argument wird als gültig formatierte Nroff-Quelle interpretiert
Es werden keine Cat-Dateien erstellt
Wenn eines der Argumente

»-« ist, wird die Eingabe von der Standardeingabe übernommen

Wenn diese Option nicht verwendet wird und man die gewünschte Seite nicht findet, nimmt man diese Option als angegeben an, betrachtet den Namen als Dateinamen und sucht nach einer exakten Übereinstimmung, bevor es eine Fehlermeldung anzeigt

-w, --where, --path, --location Zeigt nicht die Handbuchseiten an, sondern gibt den Ort der Nroff-Quelldatei aus, die formatiert werden würde

Wenn die Option -a ebenfalls angegeben wird, dann werden die Orte aller Quelldateien angegeben, die den Suchkriterien entsprechen

-W, --where-cat, --location-cat Zeigt nicht die Handbuchseiten an, sondern den Speicherort der Cat-Dateien, die angezeigt würden

Wenn die Option -a ebenfalls angegeben wird,

dann werden die Orte aller vorformatierten Cat-Dateien ausgegeben, die den Suchkriterien entsprechen

Wenn sowohl -w als auch -W angegeben werden, dann werden sowohl die Quelldatei als auch die Cat-Datei angegeben, durch Leerraum getrennt Falls -w, -W und -a zusammen angegeben werden, dann wird dies für jeden möglichen Treffer ausgeführt

-c, --catman Diese Option ist nicht für den allgemeinen Gebrauch bestimmt und sollte nur von dem Programm catman verwendet werden

-R Kodierung, --recode=Kodierung Anstatt die Seite wie üblich zu formatieren, wird der Quelltext in die angegebene Kodierung umgewandelt und ausgegeben

Wenn Sie die Kodierung der Quelldatei bereits kennen, können Sie auch direkt manconv(1) aufrufen
Diese Option ermöglicht Ihnen aber die Umkodierung mehrerer Handbuchseiten ohne die ausdrückliche Angabe der Kodierung jeder einzelnen Datei, wenn die Seiten schon in einer zu den Handbuchhierarchien analogen Struktur installiert sind

Ziehen Sie in Erwägung, man-recode(1) zu verwenden, anstatt mehrere Handbuchseiten umzuwandeln, da dessen Benutzerschnittstelle für Mehrfachumwandlungen entworfen wurde und daher viel schneller sein kann

Handbuchseiten finden

Unix	GNU	Parameter	Beschreibung

-L Locale, --locale=Locale man wird in der Regel Ihre aktuelle Locale durch einen Aufruf der C-Funktion setlocale(3) bestimmen, welche verschiedene Umgebungsvariablen auswertet (darunter sind eventuell auch $LC_MESSAGES und $LANG)

Um den ermittelten Wert vorübergehend außer Kraft zu setzen, können Sie man mit dieser Option eine Locale vorgeben
Beachten Sie, dass dieser Wert erst wirksam wird, wenn die Suche tatsächlich beginnt

Programm-Meldungen wie Hilfe-Nachrichten werden immer in der zu Anfang ermittelten Locale angezeigt werden

-m system[,...], --systems=System[,...] Wenn Ihr System auch auf die Handbuchseiten eines anderen Betriebssystems zugreifen kann, können diese mit dieser Option durchsucht werden

Um nach einer Handbuchseite aus der Handbuchseiten-Sammlung von NewOS zu suchen, verwenden Sie die Option -m NewOS

Das angegebene System kann eine durch Kommata abgetrennte Aufzählung von Betriebssystemnamen sein

Um auch die Handbuchseiten des eigenen Betriebssystems zu durchsuchen, fügen sie den Systemnamen man in die Argument-Zeichenkette ein
Diese Option überschreibt die Umgebungsvariable $SYSTEM

-M Pfad, --manpath=Pfad Gibt die Verwendung eines alternativen Pfades vor

Standardmäßig verwendet man von manpath abgeleiteten Code, um den Suchpfad zu ermitteln

Diese Option überschreibt die Umgebungsvariable $MANPATH und sorgt dafür, das -m ignoriert wird

Ein als Handbuch-Pfad festgelegter Pfad muss die Wurzel einer in Abschnitte gegliederten Handbuchhierarchie sein

Das ist im Handbuch von man-db (unter »The manual page system«) beschrieben (für die Anzeige von Handbuchseiten außerhalb solcher Hierarchien siehe die Option -l)

-S Liste, -s Liste, --sections=Liste Mit der Liste, in der Sie Doppelpunkte oder Kommas als Trennzeichen verwenden können, können sie eine bestimmte Suchreihenfolge vorgeben Diese Option setzt die Umgebungsvariable $MANSECT außer Kraft. (Die Schreibweise -s ist kompatibel mit System V.)

-e Unter-Erweiterung, --extension=Unter-Erweiterung Einige Systeme integrieren umfangreiche Handbuchseiten-Pakete, wie z. B. Zubehör für das Tcl-Paket, in die normalen Abschnitte

Für die Lösung des Problems zweier unterschiedlicher Handbuchseiten mit gleichem Namen, wie exit(3), wurden früher alle Tcl-Seiten dem Abschnitt l zugeordnet und mit einer speziellen Endung versehen, in diesem Fall exit(3tcl)
Dies erwies sich als unglückliche Lösung
Diese Version von man ermöglicht es, die Seiten in die richtigen Abschnitte einzuordnen und ihre
exit(3tcl), anzufügen
Im Normalbetrieb zeigt man bevorzugt exit(3) gegenüber exit(3tcl) an
Um diese Situation zu bewältigen, können Sie man die Zeichenkette Unter-Erweiterung übergeben
Diese gibt an,

in welchem Paket die Handbuchseite zu finden ist

Im obigen Beispiel wird die Option -e tcl die Suche von man auf Seiten mit der Erweiterung .tcl beschränken

-i, -ignore-case bei der Suche nach Handbuchseiten Groß- und Kleinschreibung ignorieren (Voreinstellung)

-I, --match-case Handbuchseiten-Suche unter Beachtung von Groß- und Kleinschreibung

--regex Zeigt alle Seiten an, bei denen ein Teil der Namen oder der Beschreibungen auf den als Argument übergebenen regulären Ausdruck Seite passen, wie bei apropos(1)

Gewöhnlich gibt es keinen begründeten Weg, um bei der Suche nach einem regulären Ausdruck eine »beste« Seite zu bestimmen

Darum impliziert diese Option -a

--wildcard Zeigt alle Seiten an, bei denen ein Teil der Namen oder der Beschreibungen auf den als Argument übergebenen Shell-Platzhalter (Wildcard) Seite passen, wie bei apropos(1) --wildcard

Das Argument Seite muss mit dem gesamten Namen oder einem Abschnitt der Beschreibung innerhalb von Wortgrenzen übereinstimmen
Gewöhnlich gibt es keinen begründeten Weg, um bei der Suche nach einem Platzhalter eine »beste« Seite zu bestimmen
Darum impliziert diese Option -a

--names-only Wenn die Optionen --regex oder --wildcard zum Einsatz kommen, wird wie bei whatis(1) nur in den Paketnamen und nicht in den Beschreibungen gesucht, Ansonsten hat diese Option keine Auswirkung

-a, --all Wird eine Handbuchseite in einem Abschnitt gefunden, so terminiert man nach Anzeige dieser Seite

Wird diese Option angegeben, werden alle passenden Handbuchseiten nacheinander angezeigt

-u, --update Diese Option veranlasst man, seine Zwischenspeicher-Datenbank der installierten Handbuchseiten zu aktualisieren

Dies ist nur in seltenen Fällen notwendig
Es ist normalerweise besser, stattdessen den Befehl mandb(8) auszuführen

--no-subpages Standardmäßig versucht man, auf seiner Befehlszeile übergebene Namenspaare als gleichwertig mit einem Namen, der einen Bindestrich oder einen Unterstrich enthält, zu interpretieren

Dies unterstützt das verbreitete Muster von Programmen, die eine Reihe von Unterbefehlen implementieren, sodass für den Aufruf der entsprechenden Handbuchseiten eine ähnliche Syntax wie für den Aufruf der Befehle genutzt werden kann
Zum Beispiel:

$ man -aw git diff
/usr/share/man/man1/git-diff.1.gz

Dieses Verhalten deaktivieren Sie mit der Option --no-subpages

$ man -aw --no-subpages git diff
/usr/share/man/man1/git.1.gz
/usr/share/man/man3/Git.3pm.gz
/usr/share/man/man1/diff.1.gz

Hilfe bekommen

Unix	GNU	Beschreibung
-?	--help	Hilfetext anzeigen und beenden
	--usage	zeigt eine kurze Anwendungszusammenfassung an und beendet das Programm
-V	--version	Versionsinformation anzeigen und beenden

Parameter

Exit-Status

Konfiguration

Dateien

Datei	Beschreibung
/etc/manpath.config	Konfigurationsdatei für man-db
/usr/share/man	globale Handbuchhierarchie

Umgebungsvariablen

Umgebungsvariable	Beschreibung
MANPATH	Wenn $MANPATH gesetzt ist, wird ihr Wert als Suchpfad für die Handbuchseiten benutzt Siehe den Abschnitt SUCHPFAD in der Handbuchseite manpath(5) für das Standardverhalten und Details dazu, wie mit dieser Umgebungsvariable umgegangen wird
MANROFFOPT	Jedes Mal, wenn man das Formatierungsprogramm aufruft (nroff, troff oder groff), wird der Inhalt von $MANROFFOPT zur Befehlszeile des Formatierungsprogramms hinzugefügt
MANROFFSEQ	Wenn $MANROFFSEQ gesetzt ist, wird ihr Wert benutzt, um die Abfolge der Präprozessoren zu bestimmen, die jede Handbuchseite vor Nroff oder Troff durchläuft Als Standard durchlaufen die Seiten den Präprozessor tbl (t)
MANSECT	Wenn $MANSECT gesetzt ist, wird ihr Wert als eine durch Doppelpunkte gegliederte Liste von Abschnitten interpretiert und dazu benutzt, die zu durchsuchenden Abschnitte und deren Reihenfolge zu bestimmen Die Vorgabe ist »1 n l 8 3 0 2 3posix 3pm 3perl 3am 5 4 9 6 7«, es sei denn, dies wird durch die SECTION-Anweisung in /etc/manpath.config außer Kraft gesetzt
MANPAGER PAGER	Wenn $MANPAGER oder $PAGER gesetzt ist ($MANPAGER wird bevorzugt verwendet), legt dieser Wert das Anzeigeprogramm für die Handbuchseite fest Standardmäßig wird pager verwendet, wobei auf cat ausgewichen wird, falls pager nicht gefunden wurde oder nicht ausführbar ist Der Wert kann ein einfacher Befehlsname oder ein Befehl mit Argumenten sein Er darf Shell-Maskierung (also linksseitige Schrägstriche sowie einfache und doppelte Anführungszeichen) enthalten Er darf keine Pipelines verwenden, um mehrere Befehle zu verbinden Wenn Sie das benötigen, verwenden Sie ein Skript, das die gewünschte Seite entweder als Argument erhält oder von der Standardeingabe liest
MANLESS	Wenn $MANLESS gesetzt ist, wird deren Wert als Zeichenkette für die Festlegung einer Eingabeaufforderung für das Anzeigeprogramm less verwendet, so als ob dieser Wert mit der Option -r übergeben worden wäre (daher werden sonstige Vorkommen des Textes $MAN_PN in der gleichen Weise expandiert) Wenn Sie beispielsweise die Eingabeaufforderung unbedingt auf »Meine Eingabeaufforderung« setzen wollen, setzen Sie $MANLESS auf ‘-PMeine Eingabeaufforderung’ Durch die Option -r wird diese Umgebungsvariable außer Kraft gesetzt
BROWSER	Wenn $BROWSER gesetzt ist, ist Wert eine durch Doppelpunkte getrennte Liste von Befehlen Mit allen diesen Befehlen wird versucht, einen Web-Browser für man --html zu starten In jedem Befehl wird %s durch einen Dateinamen für die HTML-Ausgabe von Groff, %% durch ein einzelnes Prozentzeichen und %c durch einen Doppelpunkt (:) ersetzt
SYSTEM	Wenn $SYSTEM gesetzt ist, hat das die gleiche Wirkung wie die Verwendung als Argument für die Option -m
MANOPT	Wenn $MANOPT gesetzt ist, wird der Wert dieser Variablen vor der man-Befehlszeile ausgewertet Es wird vorausgesetzt, dass der Wert im gleichen Format wie die Befehlszeile vorliegt Da alle anderen für man spezifischen Umgebungsvariablen auch als Befehlszeilenoptionen ausgedrückt und in $MANOPT aufgenommen werden können, ist zu erwarten, dass Sie obsolet werden. Übrigens müssen alle Leerzeichen, die als Teil eines Arguments interpretiert werden sollen, geschützt werden
MANWIDTH	Wenn $MANWIDTH gesetzt ist, wird ihr Wert als die Zeilenlänge für die Formatierung der Handbuchseiten verwendet Wenn sie nicht gesetzt ist, werden die Handbuchseiten mit einer für das aktuelle Terminal angemessenen Zeilenlänge angezeigt, die (bei Verfügbarkeit) mit einem Aufruf von ioctl(2) oder dem Wert von $COLUMNS bestimmt wurde Scheitert alles Andere, werden 80 Zeichen pro Zeile ausgegeben Cat-Seiten werden nur dann gespeichert, wenn die Standard-Formatierung verwendet werden kann, also die Zeilenlänge zwischen zwischen 66 und 80 Zeichen liegt
MAN_KEEP_FORMATTING	Wenn die Ausgabe nicht zu einem Terminal (zum Beispiel in eine Datei oder eine Pipeline) geschickt wird, werden Formatierungszeichen verworfen, um das Ergebnis ohne Spezialwerkzeuge lesen zu können Ist aber $MAN_KEEP_FORMATTING auf einen nicht leeren Wert gesetzt, werden diese Formatierungszeichen beibehalten Dies kann nützlich sein für Adapter, die man interpretieren und Formatierungszeichen verarbeiten können
MAN_KEEP_STDERR	Normalerweise werden bei der Ausgabe auf einem Terminal (in der Regel mit einem Anzeigeprogramm) alle Fehlermeldungen der Formatierprogramme verworfen, um die Ausgabe des Anzeigeprogramms nicht zu stören Programme wie Groff produzieren häufig relativ harmlose, hässliche Fehlermeldungen über typografische Probleme wie schlechte Ausrichtung Die Anzeige dieser Meldungen ist in der Regel verwirrend, wenn sie zusammen mit der Handbuchseite erfolgt Einige Benutzer wollen sie trotzdem sehen Setzen Sie $MAN_KEEP_STDERR auf einen nicht leeren Wert, damit Fehlermeldungen wie gewohnt angezeigt werden
MAN_DISABLE_SECCOMP	Unter Linux sperrt man normalerweise Unterprozesse, die nicht vertrauenswürdige Daten verarbeiten, in einer seccomp(2)-Sandbox ein Dadurch wird es sicherer, komplexen Auswertungscode über beliebige Handbuchseiten hinweg auszuführen Falls dies aus irgendeinem Grund fehlschlägt, der nicht auf den Inhalt der anzuzeigenden Handbuchseite zurückzuführen wäre, können Sie $MAN_DISABLE_SECCOMP auf einen beliebigen von Null verschiedenen Wert setzen, um die Sandbox zu deaktivieren
PIPELINE_DEBUG	Falls die Umgebungsvariable $PIPELINE_DEBUG auf »1« gesetzt ist, dann schreibt man Debugging-Meldungen in die Standardfehlerausgabe, die jeden ausgeführten Unterprozess beschreiben
LANG LC_MESSAGES	Abhängig von System und Implementierung werden entweder $LANG oder $LC_MESSAGES oder beide nach Informationen zur aktuellen Locale durchsucht man wird (wenn möglich) seine Nachrichten in dieser Locale anzeigen Für genaue Details siehe setlocale(3)

Anhang

Siehe auch

Dokumentation

Man-Page

Info-Pages

Links

Projekt

Weblinks