Beschreibung

man ist das System-Anzeigeprogramm für die Handbuchseiten

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.

Die folgende Tabelle zeigt die Nummern der Abschnitte der Handbuchseiten und den Typ der dort zu findenden Seiten.

1   Ausführbare Programme oder Shell-Befehle
2   Systemaufrufe (Kernel-Funktionen)
3   Bibliotheksaufrufe (Funktionen in Programmbibliotheken)
4   Spezielle Dateien (gewöhnlich in /dev)
5   Dateiformate und Konventionen, z. B. /etc/passwd
6   Spiele
7   Verschiedenes (einschließlich Makropaketen und Konventionen), z. B. man(7), groff(7), man-pages(7)
8   Befehle für die Systemverwaltung (in der Regel nur für root)
9   Kernel-Routinen [nicht Standard]

Eine Handbuchseite besteht aus verschiedenen Abschnitten

Zu den gebräuchlichen Abschnittsnamen gehören BEZEICHNUNG, ÜBERSICHT, KONFIGURATION, BESCHREIBUNG, OPTIONEN, EXIT-STATUS, RÜCKGABEWERT, FEHLER, UMGEBUNGSVARIABLEN, DATEIEN, VERSIONEN, KONFORM ZU, ANMERKUNGEN, FEHLER, BEISPIEL, AUTOREN und SIEHE AUCH.

Die folgenden Konventionen gelten für den Abschnitt ÜBERSICHT und können für andere Abschnitte als Leitfaden benutzt werden.

Fettdruck        genau wie angegeben eingeben Kursivdruck      durch passendes Argument ersetzen
[-abc]           Ein oder mehrere Argumente innerhalb der [ ] sind optional.
-a|-b            Durch | abgegrenzte Optionen können nicht zusammen benutzt werden.
Argument ...     Das Argument kann wiederholt werden.
[Ausdruck] ...   Der gesamte Ausdruck innerhalb [ ] kann wiederholt werden.

Die Darstellung ist vom Ausgabegerät abhängig.

So kann man im Allgemeinen Kursivschrift auf Terminals nicht darstellen und stattdessen den Text unterstreichen oder einfärben.

Die Befehls- oder Funktionsdarstellung ist ein Muster, das zu allen möglichen Aufrufen passen sollte.

In manchen Fällen ist es ratsam, wie im Abschnitt ÜBERSICHT dieser Handbuchseite praktiziert, die verschiedenen, sich ausschließenden Aufrufe anzugeben.

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

Optionen

Unix	GNU	Parameter	Beschreibung
-1	--single		Exit as soon as the first advertisement is received (default)

Parameter

Exit-Status

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 in Text-Datei exportieren

man loginctl > loginctl.txt

BEISPIELE

man ls Zeigt die Handbuchseite für den Begriff (das Programm) ls an.

man man.7

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

Dies ist eine alternative Schreibweise für »man 7 man«.

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.

man -a intro Zeigt nacheinander alle vorhandenen »intro«-Handbuchseiten an.

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

man -t bash | lpr -Pps 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.

man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi 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 -k printf 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 -f smail Sucht die durch smail angegebenen Handbuchseiten und gibt alle Beschreibungen der gefundenen Seiten aus.

Diese Option entspricht apropos smail.

Problembehebung

Konfiguration

Dateien

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

Umgebungsvariablen

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

Aufruf

Manpage

ÜBERSICHT

Um dem Benutzer eine größtmögliche Flexibilität zu bieten, sind in man viele Optionen verfügbar.

Veränderungen können am Suchpfad, in der Reihenfolge der Abschnitte, am Ausgabeprozessor sowie weiteren Verhaltensweisen und Operationen vorgenommen werden.
Dies wird weiter unten beschrieben.

Wenn sie gesetzt sind, werden verschiedene Umgebungsvariablen für die Festlegung der Arbeitsweise von man ausgewertet.

Sie können die Allzweckvariable $MANOPT auf einen beliebigen Ausdruck im Befehlszeilenformat setzen.
Bei der Zuweisung des Wertes an $MANOPT müssen Sie Leerzeichen als Teil von Argumenten einer Option mit einem Backslash (linksseitigem Schrägstrich) maskieren (schützen).
man wertet diese Variable vor der eigenen Befehlszeile aus.
Die Optionen, die ein Argument benötigen, werden durch die gleichen Optionen in der Befehlszeile überschrieben.
Um alle in $MANOPT gesetzten Optionen zurückzusetzen, kann als erste Befehlszeilen-Option -D angegeben werden.
Dies ermöglicht man, alle in $MANOPT gesetzten Optionen zu »vergessen«, obwohl diese weiterhin gültig gewesen sein mussten.

Handbuchseiten werden normalerweise im Format nroff(1) in einem Verzeichnis wie /usr/share/man gespeichert.

In einigen Installationen kann es auch vorformatierte cat-Seiten geben, um die Performance zu verbessern.
Siehe manpath(5) für Details dazu, wo diese Dateien gespeichert sind.

Dieses Paket unterstützt Internationalisierung.

Wenn auf Ihrem System Handbuchseiten in Ihrer Muttersprache verfügbar sind, können Sie mittels Locale-Funktionen auf diese Seiten zugreifen.
Falls Ihr System nicht bereits automatisch vornimmt, muss um diese Unterstützung zu aktivieren,

entweder in $LC_MESSAGES, $LANG oder anderen systemabhängigen Umgebungsvariablen die gewünschte Sprache festgelegt werden.

Die Sprache wird normalerweise im POSIX- Format angegeben:

<Sprache>[_<Region>[.<Zeichensatz>[,<Version>]]]

Wenn die angeforderte Seite in Ihrer Locale verfügbar ist, wird sie anstelle der (normalerweise in amerikanischem Englisch verfassten) Standardseite angezeigt.

Wenn Sie diese Handbuchseiten und die Ausgaben der Hilfsprogramme gerne in Ihrer Landessprache hätten, aber diese nicht vorfinden und Sie diese beisteuern möchten, nehmen Sie bitte mit dem Betreuer dieser Software Kontakt auf, der dann die Übersetzung koordiniert.

Individuelle Handbuchseiten werden normalerweise von den Betreuern des Programms, der Funktion oder sonstigen Themas gepflegt und daher in diesem Paket nicht enthalten.

Wenn Sie der Meinung sind, dass eine Handbuchseite fehlt oder unzureichend ist, melden Sie dies an die Betreuer des fraglichen Pakets.

Informationen über weitere Funktionen und Erweiterungen, die für dieses Handbuch-Anzeigeprogramm verfügbar sind, geben Ihnen die mit dem Paket verteilten Dokumente.

VOREINSTELLUNGEN

Die Reihenfolge der zu durchsuchenden Abschnitte kann durch die Umgebungsvariable $MANSECT oder durch die SECTION-Anweisung in /etc/manpath.config außer Kraft gesetzt werden.

Folgende Reihenfolge ist voreingestelllt: 1 n l 8 3 0 2 3posix 3pm 3perl 3am 5 4 9 6 7

Die formatierte Handbuchseite wird mit Hilfe eines Anzeigeprogramms dargestellt.

Dieses kann auf verschiedene Arten angegeben werden oder anderenfalls auf eine Voreinstellung ausgewichen werden (siehe die Option -P für Details).

Die Filter werden in mehreren Schritten zusammengestellt: Zuerst wird die Befehlszeilenoption -p oder die Umgebungsvariable $MANROFFSEQ untersucht. Wenn -p nicht benutzt wird und die Umgebungsvariable nicht gesetzt ist, wird die Anfangszeile der Nroff-Datei nach einer Zeichenkette für den Präprozessor untersucht.

Um eine gültige Präprozessor-Zeichenkette zu enthalten, muss die erste Zeile '\" <Zeichenkette> ähneln, wobei Zeichenkette jede weiter unten unter -p beschriebene Buchstabenkombination sein kann.
Wenn keine der obigen Methoden eine Filterinformation ergibt, wird ein Satz von Standardwerten verwendet.

Aus den Filtern und dem Hauptformatierprogramm (Nroff oder [tg]roff mit -t) wird eine Formatier-Pipeline gebildet und ausgeführt.

Wenn alternativ ein ausführbares Programm mandb_nfmt (oder mandb_tfmt mit -t) in der Wurzel der Handbuchhierarchie existiert, wird dieses an Stelle der Pipeline ausgeführt.
Ihm wird die Handbuchquelldatei, die Zeichenkette für den Präprozessor und wahlweise das durch die Argumente -T oder -E festgelegte

»Gerät« (tatsächlich ein Dateiformat oder ein Zeichensatz) übergeben.