man - eine Schnittstelle zu den Systemreferenzhandbüchern
SYNOPSIS
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 ...
BESCHREIBUNG
man ist das System-Manual-Pager. Jedes an man übergebene Seitenargument ist normalerweise der Name eines Programms, Dienstprogramms oder einer Funktion. Die zu jedem dieser Argumente gehörende Manualseite wird dann gefunden
und angezeigt. Wenn ein Abschnitt angegeben wird, sucht man nur in diesem Abschnitt des Handbuchs. Die Standardaktion ist, in allen verfügbaren Abschnitten in einer vordefinierten Reihenfolge zu suchen (siehe STANDARDS) und nur die erste gefundene Seite anzuzeigen, auch wenn die Seite in mehreren Abschnitten vorhanden ist.
Die folgende Tabelle zeigt die Abschnittsnummern des Handbuchs sowie die darin enthaltenen Seitentypen.
1 Ausführbare Programme oder Shell-Befehle
2 Systemaufrufe (Funktionen, die vom Kernel bereitgestellt werden)
3 Bibliotheksaufrufe (Funktionen innerhalb von Programmbibliotheken)
4 Spezielle Dateien (normalerweise in /dev zu finden)
5 Dateiformate und Konventionen, z. B. /etc/passwd
6 Spiele
7 Verschiedenes (einschließlich Makropaketen und Konventionen), z. B. man(7), [groff]({filename}../../groff)(7), man-pages(7)
8 Systemadministrationsbefehle (normalerweise nur für Root)
9 Kernelroutinen [Nicht standardmäßig]
Eine Manualseite besteht aus mehreren Abschnitten.
Zu den üblichen Abschnittsnamen gehören NAME, SYNOPSIS, KONFIGURATION, BESCHREIBUNG, OPTIONEN, EXIT-STATUS, RÜCKGABEWERT, FEHLER, UMGEBUNG, DATEIEN, VERSIONEN, STANDARDS, HINWEISE, FEHLER, BEISPIEL, AUTOREN und SIEHE AUCH.
Die folgenden Konventionen gelten für den Abschnitt SYNOPSIS und können als Richtlinie für andere Abschnitte verwendet werden.
fetter Text genau so wie dargestellt eingeben.
kursiver Text durch das entsprechende Argument ersetzen.
[-abc] alle oder einige der Argumente innerhalb von [ ] sind optional.
-a|-b Optionen, die durch | getrennt sind, können nicht zusammen verwendet werden.
Argument ... Argument ist wiederholbar.
[Ausdruck] ... der gesamte Ausdruck innerhalb von [ ] ist wiederholbar.
Die genaue Darstellung kann je nach Ausgabegerät variieren. Beispielsweise kann man in einem Terminal normalerweise keine Kursivschrift darstellen und verwendet stattdessen fettgedruckte oder farbige Schrift.
Die Befehls- oder Funktionsillustration ist ein Muster, das alle möglichen Aufrufe abdecken sollte. In einigen Fällen ist es ratsam, mehrere exklusive Aufrufe zu veranschaulichen, wie im Abschnitt SYNOPSIS dieser Manualseite gezeigt.
BEISPIELE
man ls
Zeigt die Manualseite für das Element (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". Es kann praktischer sein, wenn Sie Querverweise zu Handbuchseiten kopieren und einfügen. Beachten Sie, dass die Klammern normalerweise in Anführungszeichen gesetzt werden müssen, um sie vor der Shell zu schützen.)
man -a intro
Zeigt nacheinander alle verfügbaren Handbuchseiten vom Typ "intro" an, die im Handbuch enthalten sind. Es ist möglich, zwischen den einzelnen Anzeigen zu beenden oder einige davon zu überspringen.
man -t bash | lpr -Pps
Formatiert die Handbuchseite für bash in das Standard-Troff- oder Groff-Format und leitet sie an den Drucker "ps" weiter. Die Standardausgabe für Groff ist normalerweise PostScript. Die Option "man --help" gibt an, welcher Prozessor an die Option "-t" gebunden ist.
man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi
Dieser Befehl dekomprimiert und formatiert die Nroff-Quellhandbuchseite ./foo.1x.gz in eine geräteunabhängige (DVI)-Datei. Die Umleitung ist erforderlich, da die Option "-T" dazu führt, dass die Ausgabe an stdout weitergeleitet wird, ohne dass ein Pager verwendet wird. Die Ausgabe kann mit einem Programm wie xdvi angezeigt oder mit einem Programm wie dvips weiter zu PostScript verarbeitet werden.
man -k printf
Durchsucht die Kurzbeschreibungen und Handbuchseitennamen nach dem Schlüsselwort "printf" als regulärer Ausdruck. Gibt alle Übereinstimmungen aus. Entspricht apropos printf.
man -f smail
Sucht die von smail referenzierten Handbuchseiten und gibt die Kurzbeschreibungen aller gefundenen Seiten aus. Entspricht whatis smail.
ÜBERBLICK
Es stehen viele Optionen für man zur Verfügung, um dem Benutzer so viel Flexibilität wie möglich zu bieten. Änderungen können an dem Suchpfad, der Abschnittsreihenfolge, dem Ausgabeprozessor und anderen Verhaltensweisen und Operationen vorgenommen werden, die unten detailliert beschrieben sind.
Wenn sie gesetzt sind, werden verschiedene Umgebungsvariablen abgefragt, um die Funktionsweise von man zu bestimmen. Es ist möglich, die "Catch-all"-Variable $MANOPT auf eine beliebige Zeichenkette im Befehlszeilenformat zu setzen, wobei alle Leerzeichen, die als Teil eines Optionsarguments verwendet werden, escaped werden müssen (durch ein vorangestelltes Backslash). Man wird $MANOPT analysieren, bevor es seine eigene Befehlszeile analysiert. Optionen, die ein Argument benötigen, werden durch die gleichen Optionen in der Befehlszeile überschrieben. Um alle in $MANOPT festgelegten Optionen zurückzusetzen, kann -D als erste Option in der Befehlszeile angegeben werden. Dadurch kann man die in $MANOPT angegebenen Optionen "vergessen", obwohl diese immer noch gültig gewesen sein müssen.
Handbuchseiten werden normalerweise im Nroff(1)-Format unter einem Verzeichnis wie /usr/share/man gespeichert. In einigen Installationen gibt es möglicherweise auch vorformatierte Cat-Seiten, um die Leistung zu verbessern. Siehe manpath(5) für Einzelheiten dazu, wo diese Dateien gespeichert sind.
Dieses Paket unterstützt Handbuchseiten in mehreren Sprachen, die durch Ihre Gebietssprache gesteuert werden. Wenn Ihr System dies nicht automatisch für Sie eingerichtet hat, müssen Sie möglicherweise $LC_MESSAGES, $LANG oder eine andere systemspezifische Umgebungsvariable festlegen, um Ihre bevorzugte Gebietssprache anzugeben, normalerweise im POSIX-Format.
<Sprache>[_<Gebiet>[.<Zeichensatz>[,<Version>]]]
Wenn die gewünschte Seite in Ihrer Sprache verfügbar ist, wird diese anstelle der Standardseite (normalerweise Amerikanisches Englisch) angezeigt.
Wenn Sie feststellen, dass die mit diesem Paket gelieferten Übersetzungen nicht in Ihrer Muttersprache verfügbar sind und Sie diese gerne bereitstellen möchten, kontaktieren Sie bitte den Betreuer, der diese Aktivität koordinieren wird.
Einzelne Handbuchseiten werden normalerweise von den Betreuern des Programms, der Funktion oder des Themas, das sie dokumentieren, geschrieben und gepflegt, und sind nicht in diesem Paket enthalten. Wenn Sie feststellen, dass eine Handbuchseite fehlt oder unzureichend ist, melden Sie dies bitte den Betreuern des betreffenden Pakets.
Weitere Informationen zu anderen Funktionen und Erweiterungen, die mit diesem Handbuch-Pager verfügbar sind, finden Sie in den mit dem Paket gelieferten Dokumenten.
VOREINSTELLUNGEN
Die Reihenfolge der zu durchsuchenden Abschnitte kann durch die Umgebungsvariable $MANSECT oder durch die Direktive SECTION in /etc/manpath.config überschrieben werden. Standardmäßig ist sie wie folgt:
1n l 8 3 0 2 3type 3posix 3pm 3perl 3am 5 4 9 6 7
Die formatierte Handbuchseite wird mithilfe eines Pagers angezeigt. Dies kann auf verschiedene Weise angegeben werden, andernfalls wird ein Standardwert verwendet (siehe Option -P für Details).
Die Filter werden auf verschiedene Arten entschlüsselt. Zunächst werden die Befehlszeilenoption -p oder die Umgebungsvariable $MANROFFSEQ abgefragt. Wenn -p nicht verwendet wurde und die Umgebungsvariable nicht gesetzt ist, wird die erste Zeile der Nroff-Datei auf eine Präprozessorzeichenfolge analysiert. Um eine gültige Präprozessorzeichenfolge zu enthalten, muss die erste Zeile wie folgt aussehen:
'\" <Zeichenfolge>
wobei Zeichenfolge eine beliebige Kombination von Buchstaben sein kann, die durch die Option -p unten beschrieben werden.
Wenn keine der oben genannten Methoden Filterinformationen liefert, wird ein Standardsatz verwendet.
Eine Formatierungspipeline wird aus den Filtern und dem primären Formatter (Nroff oder [t]roff mit -t) gebildet und ausgeführt. Alternativ wird, wenn ein ausführbares Programm mandb_nfmt (oder mandb_tfmt mit -t) im Man-Baum-Stammverzeichnis vorhanden ist, dieses stattdessen ausgeführt. Es erhält die Handbuch-Quelldatei, die Präprozessorzeichenfolge und optional das mit -T oder -E angegebene Gerät als Argumente.
OPTIONEN
Nicht-argumentierte Optionen, die entweder auf der Befehlszeile, in $MANOPT oder in beiden vorkommen, sind nicht schädlich. Für Optionen, die ein Argument erfordern, überschreibt jede Duplizierung den vorherigen Argumentwert.
Allgemeine Optionen
-C Datei, --config-file=Datei
Verwenden Sie diese Benutzerkonfigurationsdatei anstelle der Standarddatei \~/.manpath.
-d, --debug
Geben Sie Debugging-Informationen aus.
-D, --default
Diese Option wird normalerweise als allererste Option ausgegeben und setzt das Verhalten von Man auf seine Standardeinstellungen zurück. Sie dient dazu, Optionen zurückzusetzen, die möglicherweise in $MANOPT festgelegt wurden. Alle nach -D folgenden Optionen haben ihre übliche Wirkung.
--warnings[=warnings]
Aktiviert Warnungen von groff. Dies kann verwendet werden, um die Konsistenz des Quelltexts von Handbuchseiten zu überprüfen. warnings ist eine durch Kommas getrennte Liste von Warnungsnamen; wenn diese
nicht angegeben wird, ist der Standardwert "mac". Um eine groff-Warnung zu deaktivieren, fügen Sie ein "!" voran: zum Beispiel
--warnings=mac,!break aktiviert Warnungen in der Kategorie "mac" und deaktiviert Warnungen in der
Kategorie "break". Siehe den Abschnitt "Warnungen" in der Info-Datei von groff für eine Liste der verfügbaren Warnungsnamen.
Hauptbetriebsmodi
-f, --whatis
Ungefähr äquivalent zu whatis. Zeigt eine kurze Beschreibung aus der Handbuchseite an, falls verfügbar. Siehe whatis(1) für Details.
-k, --apropos
Ungefähr äquivalent zu apropos. Durchsucht die kurzen Beschreibungen der Handbuchseiten nach Schlüsselwörtern und zeigt alle Übereinstimmungen an. Siehe apropos(1) für Details.
-K, --global-apropos
Durchsucht alle Handbuchseiten nach Text. Dies ist eine Brute-Force-Suche und wird wahrscheinlich einige Zeit in Anspruch nehmen; wenn möglich, sollten Sie einen Abschnitt angeben, um die Anzahl der zu durchsuchenden Seiten zu reduzieren. Suchbegriffe können einfache Zeichenketten (Standard) oder reguläre Ausdrücke sein, wenn die Option --regex verwendet wird.
Beachten Sie, dass dies die Quellen der Handbuchseiten und nicht den gerenderten Text durchsucht und daher falsche positive Ergebnisse aufgrund von Kommentaren in den Quelldateien oder falsche negative Ergebnisse aufgrund von Bindestrichen, die in den Quelldateien als "-" geschrieben werden, enthalten kann. Das Durchsuchen des gerenderten Texts wäre viel langsamer.
-l, --local-file
Aktiviert den "lokalen" Modus. Formatiert und zeigt lokale Handbuchdateien an, anstatt die Handbuchsammlung des Systems zu durchsuchen. Jedes Argument für eine Handbuchseite wird als eine nroff-Quelldatei im richtigen Format interpretiert. Es wird keine Cat-Datei erzeugt. Wenn "-" als eines der Argumente angegeben ist, wird die Eingabe von stdin gelesen.
Wenn diese Option nicht verwendet wird, interpretiert man auch Handbuchseitenargumente als lokale Dateinamen, wenn das Argument ein "/" -Zeichen enthält, da dies ein guter Hinweis darauf ist, dass das Argument auf einen Pfad im Dateisystem verweist.
-w, --where, --path, --location
Zeigt die Handbuchseite nicht tatsächlich an, gibt aber den Speicherort der Quelldatei an, die formatiert würde. Wenn auch die Option -a verwendet wird, werden die Speicherorte aller Quelldateien ausgegeben, die den Suchkriterien entsprechen.
-W, --where-cat, --location-cat
Zeigt die Handbuchseite nicht tatsächlich an, gibt aber den Speicherort der vorformatierten Cat-Datei an, die angezeigt würde. Wenn auch die Option -a verwendet wird, werden die Speicherorte aller vorformatierten Cat-Dateien ausgegeben, die den Suchkriterien entsprechen.
Wenn -w und -W beide verwendet werden, werden sowohl die Quelldatei als auch die Cat-Datei durch ein Leerzeichen getrennt ausgegeben. Wenn alle von -w, -W und -a verwendet werden, wird dies für jedes mögliche Ergebnis durchgeführt.
-c, --catman
Diese Option ist nicht für den allgemeinen Gebrauch bestimmt und sollte nur vom Programm catman verwendet werden.
-R encoding, --recode=encoding
Anstatt die Handbuchseite auf die übliche Weise zu formatieren, wird deren Quelle in die angegebene Kodierung konvertiert und ausgegeben. Wenn Sie die Kodierung der Quelldatei bereits kennen, können Sie auch manconv(1) direkt verwenden. Diese Option ermöglicht es Ihnen jedoch, mehrere Handbuchseiten in eine einzige Kodierung zu konvertieren, ohne die Kodierung jeder einzelnen explizit angeben zu müssen, vorausgesetzt, dass sie bereits in einer Struktur installiert sind, die einer Handbuchseitenhierarchie ähnelt.
Erwägen Sie die Verwendung von man-recode(1) zum Konvertieren mehrerer Handbuchseiten, da dieses Tool eine Schnittstelle für die Massenkonvertierung bietet und daher viel schneller sein kann.
Handbuchseiten finden
-L locale, --locale=locale
Normalerweise bestimmt man Ihre aktuelle Locale durch einen Aufruf der C-Funktion setlocale(3), die verschiedene Umgebungsvariablen abfragt, möglicherweise einschließlich $LC_MESSAGES und $LANG. Verwenden Sie diese Option, um den ermittelten Wert vorübergehend zu überschreiben und direkt eine Locale-Zeichenkette an man zu übergeben. Beachten Sie, dass dies erst beim Start der Suche nach Seiten wirksam wird. Ausgaben wie die Hilfemeldung werden immer in der anfänglich ermittelten Locale angezeigt.
-m system[,...], --systems=system[,...]
Wenn dieses System Zugriff auf die Handbuchseiten anderer Betriebssysteme hat, können diese über diese Option abgerufen werden. Um nach einer Handbuchseite aus der Handbuchsammlung von NewOS zu suchen, verwenden Sie die Option -m NewOS.
Das angegebene System kann eine durch Kommas getrennte Kombination aus Betriebssystemnamen sein. Um eine Suche in den Handbuchseiten des nativen Betriebssystems einzubeziehen, fügen Sie den Systemnamen man in die Argumentzeichenkette ein. Diese Option überschreibt die Umgebungsvariable $SYSTEM.
-M path, --manpath=path
Geben Sie einen alternativen Manpath an, der verwendet werden soll. Standardmäßig verwendet man einen durch Code ermittelten Manpath, um den Pfad für die Suche zu bestimmen. Diese Option überschreibt die Umgebungsvariable $MANPATH und führt dazu, dass die Option -m ignoriert wird.
Ein als Manpath angegebener Pfad muss das Stammverzeichnis einer Handbuchseitenhierarchie sein, die wie im Man-db-Handbuch beschrieben in Abschnitte unterteilt ist (unter "Das Handbuchseitensystem"). Um Handbuchseiten außerhalb dieser Hierarchien anzuzeigen, siehe die Option -l.
-S list, -s list, --sections=list
Die angegebene Liste ist eine durch Doppelpunkte oder Kommas getrennte Liste von Abschnitten, die verwendet wird, um zu bestimmen, welche Handbuchabschnitte durchsucht werden sollen und in welcher Reihenfolge. Diese Option überschreibt die Umgebungsvariable $MANSECT. (Die Schreibweise -s dient der Kompatibilität mit System V.)
-e sub-extension, --extension=sub-extension
Einige Systeme binden große Pakete von Handbuchseiten, wie z. B. die, die dem Tcl-Paket beiliegen, in die Haupt-Handbuchseitenhierarchie ein. Um das Problem zu umgehen, dass es zwei Handbuchseiten mit demselben Namen wie z. B. exit(3) gibt, wurden die Tcl-Seiten normalerweise dem Abschnitt l zugewiesen. Da dies jedoch unglücklich ist, ist es jetzt möglich, die Seiten in den richtigen Abschnitt zu verschieben und ihnen eine bestimmte "Erweiterung" zuzuweisen, in diesem Fall exit(3tcl). Unter normalen Bedingungen zeigt man exit(3) gegenüber exit(3tcl) an. Um diese Situation zu bewältigen und zu vermeiden, dass man wissen muss, in welchem Abschnitt sich die benötigte Seite befindet, ist es jetzt möglich, man eine Sub-Erweiterungszeichenkette zu geben, die angibt, zu welchem Paket die Seite gehören muss. Wenn man beispielsweise die Option -e tcl an man übergibt, wird die Suche auf Seiten mit einer Erweiterung von *tcl beschränkt.
-i, --ignore-case
Ignoriere die Groß-/Kleinschreibung bei der Suche nach Handbuchseiten. Dies ist die Standardeinstellung.
-I, --match-case
Führe eine case-sensitive Suche nach Handbuchseiten durch.
--regex
Zeige alle Seiten an, deren Namen oder Beschreibungen mit jedem der angegebenen Seitenargumente als regulärer Ausdruck übereinstimmen, ähnlich wie bei apropos(1). Da es normalerweise keine sinnvolle Möglichkeit gibt, eine „beste“ Seite auszuwählen, wenn nach einem regulären Ausdruck gesucht wird, impliziert diese Option -a.
--wildcard
Zeige alle Seiten an, deren Namen oder Beschreibungen mit jedem der angegebenen Seitenargumente unter Verwendung von Shell-ähnlichen Wildcards übereinstimmen, ähnlich wie bei apropos(1) --wildcard. Das Seitenargument muss entweder vollständig mit dem Namen oder der Beschreibung übereinstimmen oder an Wortgrenzen in der Beschreibung. Da es normalerweise keine sinnvolle Möglichkeit gibt, eine „beste“ Seite auszuwählen, wenn nach einem Wildcard gesucht wird, impliziert diese Option -a.
--names-only
Wenn die Option --regex oder --wildcard verwendet wird, werden nur Seitennamen und nicht Seitennbeschreibungen abgeglichen, wie bei whatis(1). Andernfalls hat die Option keine Auswirkung.
-a, --all
Standardmäßig beendet man die Ausführung, nachdem die am besten geeignete Handbuchseite gefunden und angezeigt wurde. Durch die Verwendung dieser Option wird man dazu gezwungen, alle Handbuchseiten anzuzeigen, deren Namen mit den Suchkriterien übereinstimmen.
-u, --update
Diese Option bewirkt, dass man seine Datenbank-Caches der installierten Handbuchseiten aktualisiert. Dies ist nur in seltenen Fällen erforderlich, und es ist normalerweise besser, stattdessen mandb(8) auszuführen.
--no-subpages
Standardmäßig versucht man, Paare von Handbuchseitennamen, die in der Befehlszeile angegeben werden, als eine einzelne Handbuchseite zu interpretieren, die einen Bindestrich oder einen Unterstrich enthält. Dies unterstützt das übliche Muster von Programmen, die eine Reihe von Unterbefehlen implementieren, und ermöglicht es ihnen, Handbuchseiten für jeden bereitzustellen, auf die mit einer ähnlichen Syntax zugegriffen werden kann, wie sie zum Aufrufen der Unterbefehle selbst verwendet würde. Zum Beispiel:
$ man -aw git diff
/usr/share/man/man1/git-diff.1.gz
Um dieses Verhalten zu deaktivieren, verwenden Sie die 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
Formatierte Ausgabe steuern
-P pager, --pager=pager
Gibt an, welcher Ausgabepager verwendet werden soll. Standardmäßig verwendet man den Pager, und wenn dieser nicht gefunden wird oder nicht ausführbar ist, wird stattdessen cat verwendet. Diese Option überschreibt die Umgebungsvariable $MANPAGER, die wiederum die Umgebungsvariable $PAGER überschreibt. Sie wird nicht in Verbindung mit -f oder -k verwendet.
Der Wert kann entweder ein einfacher Befehlsname oder ein Befehl mit Argumenten sein und kann Shell-Maskierungen (Backslashes, einfache oder doppelte Anführungszeichen) verwenden. Er darf keine Pipes verwenden, um mehrere Befehle zu verbinden. Wenn dies erforderlich ist, verwenden Sie ein Wrapper-Skript, das die anzuzeigende Datei entweder als Argument oder über die Standardeingabe entgegennimmt.
-r prompt, --prompt=prompt
Wenn eine aktuelle Version von less als Pager verwendet wird, versucht man, dessen Prompt und einige sinnvolle Optionen zu setzen. Der Standard-Prompt sieht wie folgt aus:
Manual page name(sec) line x
wobei name den Namen der Manual-Seite, sec die Sektion, unter der sie gefunden wurde, und x die aktuelle Zeilennummer bezeichnet. Dies wird durch die Verwendung der Umgebungsvariablen $LESS erreicht.
Die Angabe von -r mit einer Zeichenkette überschreibt diesen Standard. Die Zeichenkette kann den Text $MAN_PN enthalten, der durch den Namen der aktuellen Manual-Seite und ihren Sektionsnamen, eingeschlossen in "(" und ")", ersetzt wird. Die Zeichenkette, die zur Erzeugung des Standards verwendet wird, könnte wie folgt ausgedrückt werden:
\ Manual\ page\ \$MAN_PN\ ?ltline\ %lt?L/%L.:
byte\ %bB?s/%s..?\ (END):?pB\ %pB\\%..
(drücken Sie h für Hilfe oder q zum Beenden)
Sie ist hier aus Lesbarkeitsgründen in drei Zeilen aufgeteilt. Für ihre Bedeutung siehe die Manual-Seite less(1). Die Prompt-Zeichenkette wird zuerst von der Shell ausgewertet. Alle doppelten Anführungszeichen, Backticks und Backslashes in dem Prompt müssen durch einen vorangestellten Backslash maskiert werden. Die Prompt-Zeichenkette kann mit einem maskierten $ enden, dem weitere Optionen für less folgen können. Standardmäßig setzt man die Optionen -ix8.
Die Umgebungsvariable $MANLESS, die unten beschrieben wird, kann verwendet werden, um eine Standard-Prompt-Zeichenkette festzulegen, wenn keine über die Befehlszeile angegeben wird.
-7, --ascii
Beim Anzeigen einer reinen ASCII(7)-Manual-Seite auf einem 7-Bit-Terminal oder Terminalemulator können einige Zeichen nicht korrekt angezeigt werden, wenn die Latin-1(7)-Gerätebeschreibung mit GNU nroff verwendet wird. Diese Option ermöglicht die Anzeige reiner ASCII-Manual-Seiten in ASCII mit dem Latin-1-Gerät. Sie übersetzt keinen Latin-1-Text. Die folgende Tabelle zeigt die durchgeführten Übersetzungen: Einige Teile davon werden möglicherweise nur dann korrekt angezeigt, wenn das Latin-1(7)-Gerät von GNU nroff verwendet wird.
Beschreibung Oktal latin1 ascii
Fortsetzungsstrich 255 ‐ Punkt (mittlerer Punkt) 267 • o
akut betonter Vokal 264 ´ '
Multiplikationszeichen 327 × x
Wenn die Spalte Latin-1 korrekt angezeigt wird, ist Ihr Terminal möglicherweise für Latin-1-Zeichen konfiguriert, und diese Option ist nicht erforderlich. Wenn die Spalten Latin-1 und ASCII identisch sind, lesen Sie diese Seite entweder mit dieser Option oder man hat diese Seite nicht mit der Latin-1-Gerätebeschreibung formatiert. Wenn die Spalte Latin-1 fehlt oder beschädigt ist, müssen Sie möglicherweise Manual-Seiten mit dieser Option anzeigen.
Diese Option wird ignoriert, wenn die Optionen -t, -H, -T oder -Z verwendet werden, und ist möglicherweise für andere nroff-Versionen als GNU-Versionen nutzlos.
-E encoding, --encoding=encoding
Generiert die Ausgabe für eine andere Zeichenkodierung als die Standardeinstellung. Zur Abwärtskompatibilität kann encoding eine nroff-Gerätebeschreibung wie ascii, latin1 oder utf8 sowie eine echte Zeichenkodierung wie UTF-8 sein.
--no-hyphenation, --nh
Normalerweise führt nroff automatisch eine Silbentrennung bei Zeilenumbrüchen durch, auch bei Wörtern, die keine Bindestriche enthalten, wenn dies erforderlich ist, um Wörter ohne übermäßige Leerzeichen in einer Zeile anzuordnen. Diese Option deaktiviert die automatische Silbentrennung, sodass Wörter nur dann mit einem Bindestrich versehen werden, wenn sie bereits einen enthalten.
Wenn Sie eine Handbuchseite schreiben und einfach verhindern möchten, dass nroff ein Wort an einer ungeeigneten Stelle trennt, verwenden Sie diese Option nicht, sondern konsultieren Sie stattdessen die nroff-Dokumentation; Sie können beispielsweise "\%" in ein Wort einfügen, um anzugeben, dass es an dieser Stelle silbengetrennt werden kann, oder "\%" am Anfang eines Wortes einfügen, um zu verhindern, dass es silbengetrennt wird.
--no-justification, --nj
Normalerweise führt nroff automatisch einen Blocksatz auf beiden Rändern durch. Diese Option deaktiviert den vollständigen Blocksatz und lässt den Text nur linksbündig, was manchmal als "ungleicher Blocksatz" bezeichnet wird.
Wenn Sie eine Handbuchseite schreiben und einfach verhindern möchten, dass nroff bestimmte Absätze als Blocksatz formatiert, verwenden Sie diese Option nicht, sondern konsultieren Sie stattdessen die nroff-Dokumentation; Sie können beispielsweise die Anweisungen ".na", ".nf", ".fi" und ".ad" verwenden, um die Anpassung und Ausfüllung vorübergehend zu deaktivieren.
-p string, --preprocessor=string
Gibt die Reihenfolge der Vorprozessoren an, die vor nroff oder troff/groff ausgeführt werden sollen. Nicht alle Installationen verfügen über einen vollständigen Satz von Vorprozessoren. Einige der Vorprozessoren und die zur Bezeichnung verwendeten Buchstaben sind: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Diese Option überschreibt die Umgebungsvariable $MANROFFSEQ. zsoelim wird immer als erster Vorprozessor ausgeführt.
-t, --troff
Verwendet groff -mandoc, um die Handbuchseite in die Standardausgabe zu formatieren. Diese Option ist nicht in Verbindung mit -H, -T oder -Z erforderlich.
-T[device], --troff-device[=device]
Diese Option wird verwendet, um die Ausgabe von groff (oder möglicherweise von troff) so zu ändern, dass sie für ein anderes Gerät als das Standardgerät geeignet ist. Sie impliziert -t. Beispiele (ab groff 1.23.0) sind: dvi, latin1, pdf, ps, utf8, X75 und X100.
-H[browser], --html[=browser]
Diese Option bewirkt, dass groff HTML-Ausgabe erzeugt und diese in einem Webbrowser anzeigt. Die Wahl des Browsers wird durch das optionale Browserargument bestimmt, falls eines angegeben ist, durch die Umgebungsvariable $BROWSER oder durch eine Kompilierzeit-Standardeinstellung, falls diese nicht gesetzt ist (normalerweise lynx). Diese Option impliziert -t und funktioniert nur mit GNU troff.
-X[dpi], --gxditview[=dpi]
Diese Option zeigt die Ausgabe von groff in einem grafischen Fenster mit dem Programm gxditview an. Der Wert für dpi (Punkte pro Zoll) kann 75, 75-12, 100 oder 100-12 sein, wobei der Standardwert 75 ist; die Varianten mit "-12" verwenden eine 12-Punkt-Basis-Schrift. Diese Option impliziert -T mit dem Gerät X75, X75-12, X100 oder X100-12.
-Z, --ditroff
groff führt troff aus und verwendet dann einen geeigneten Nachverarbeitungsprozessor, um eine Ausgabe zu erzeugen, die für das ausgewählte Gerät geeignet ist. Wenn groff -mandoc groff ist, wird diese Option an groff übergeben und unterdrückt die Verwendung eines Nachverarbeitungsprozessors. Sie impliziert -t.
Hilfe erhalten
-?, --help
Gibt eine Hilfemeldung aus und beendet das Programm.
--usage
Gibt eine kurze Nutzungsmeldung aus und beendet das Programm.
-V, --version
Zeigt Versionsinformationen an.
BEENDIGUNGSSTATUS
0 Erfolgreiche Programmausführung.
1 Fehler bei der Verwendung, Syntax oder Konfigurationsdatei.
2 Betrieblicher Fehler.
3 Ein Kindprozess hat einen anderen Exit-Status als Null zurückgegeben.
16 Mindestens eine der Seiten/Dateien/Schlüsselwörter existierte nicht oder wurde nicht gefunden.
UMGEBUNG
MANPATH
Wenn $MANPATH gesetzt ist, wird sein Wert als Pfad verwendet, um nach Handbuchseiten zu suchen.
Siehe den Abschnitt SUCHPFAD in manpath(5) für das Standardverhalten und Details darüber, wie diese Umgebungsvariable behandelt wird.
MANROFFOPT
Jedes Mal, wenn man den Formatter (nroff, troff oder groff) aufruft, fügt es den Inhalt von $MANROFFOPT der Befehlszeile des Formatters hinzu.
Zum Beispiel weist MANROFFOPT=-P-i den Formatter an, kursiven Text (der nur von einigen Terminals unterstützt wird) anstelle von unterstrichenem Text zu verwenden.
MANROFFSEQ
Wenn $MANROFFSEQ gesetzt ist, wird sein Wert verwendet, um die Liste der Präprozessoren zu bestimmen, die jede Handbuchseite durchlaufen sollen. Die Standardliste der Präprozessoren ist systemabhängig.
MANSECT
Wenn $MANSECT gesetzt ist, ist sein Wert eine durch Doppelpunkte getrennte Liste von Abschnitten, und er wird verwendet, um zu bestimmen, welche Handbuchabschnitte durchsucht werden sollen und in welcher Reihenfolge. Standardmäßig ist dies "1 n l 8 3 0 2 3ype 3posix 3pm 3perl 3am 5 4 9 6 7", es sei denn, dies wird durch die Direktive SECTION in /etc/manpath.config überschrieben.
MANPAGER, PAGER
Wenn $MANPAGER oder $PAGER gesetzt ist (wobei $MANPAGER bevorzugt wird), wird sein Wert als Name des Programms verwendet, das zum Anzeigen der Handbuchseite verwendet wird. Standardmäßig wird pager verwendet, wobei bei Nichtauffinden oder Nichtausführbarkeit von pager auf cat zurückgegriffen wird.
Der Wert kann ein einfacher Befehlsname oder ein Befehl mit Argumenten sein und kann Shell-Anführungszeichen (Backslashes, einfache oder doppelte Anführungszeichen) verwenden. Es dürfen keine Pipes verwendet werden, um mehrere Befehle zu verbinden; wenn dies erforderlich ist, verwenden Sie ein Wrapper-Skript, das die anzuzeigende Datei entweder als Argument oder auf der Standardeingabe entgegennimmt.
MANLESS
Wenn $MANLESS gesetzt ist, wird sein Wert als Standard-Prompt-Zeichenfolge für den less-Pager verwendet, als ob sie mit der Option -r übergeben worden wäre (so dass alle Vorkommnisse des Texts $MAN_PN auf die gleiche Weise erweitert werden). Wenn Sie beispielsweise die Prompt-Zeichenfolge bedingungslos auf „meine Prompt-Zeichenfolge“ setzen möchten, setzen Sie $MANLESS auf ‚-Psmeine Prompt-Zeichenfolge‘. Die Verwendung der Option -r überschreibt diese Umgebungsvariable.
BROWSER
Wenn $BROWSER gesetzt ist, ist sein Wert eine durch Doppelpunkte getrennte Liste von Befehlen, von denen jeder verwendet wird, um zu versuchen, einen Webbrowser für man --html zu starten. In jedem Befehl wird %s durch einen Dateinamen ersetzt, der die HTML-Ausgabe von groff enthält, %% wird durch ein einzelnes Prozentzeichen (%) ersetzt und %c wird durch einen Doppelpunkt (:) ersetzt.
SYSTEM Wenn $SYSTEM gesetzt ist, hat dies die gleiche Wirkung, als ob es als Argument für die Option -m angegeben worden wäre.
MANOPT Wenn $MANOPT gesetzt ist, wird es vor der Befehlszeile von man geparst und es wird erwartet, dass es in einem ähnlichen Format vorliegt. Da alle anderen man-spezifischen Umgebungsvariablen als Befehlszeilenoptionen ausgedrückt werden können und daher Kandidaten dafür sind, in $MANOPT enthalten zu sein, wird erwartet, dass sie obsolet werden. Hinweis: Alle Leerzeichen, die als Teil eines Arguments einer Option interpretiert werden sollen, müssen maskiert werden.
MANWIDTH
Wenn $MANWIDTH gesetzt ist, wird sein Wert als Zeilenlänge verwendet, für die die Handbuchseiten formatiert werden sollen. Wenn es nicht gesetzt ist, werden die Handbuchseiten mit einer Zeilenlänge formatiert, die für das aktuelle Terminal geeignet ist (unter Verwendung des Werts von $COLUMNS und ioctl(2), falls verfügbar, oder andernfalls wird auf 80 Zeichen zurückgegriffen). Cat-Seiten werden nur dann gespeichert, wenn die Standardformatierung verwendet werden kann, d. h. wenn die Terminalzeilenlänge zwischen 66 und 80 Zeichen liegt.
MAN_KEEP_FORMATTING
Normalerweise werden Formatierungszeichen verworfen, wenn die Ausgabe nicht an ein Terminal weitergeleitet wird (z. B. in eine Datei oder eine Pipe), um das Lesen des Ergebnisses ohne spezielle Tools zu erleichtern. Wenn $MAN_KEEP_FORMATTING jedoch auf einen beliebigen nicht leeren Wert gesetzt ist, werden diese Formatierungszeichen beibehalten. Dies kann für Wrapper um man nützlich sein, die Formatierungszeichen interpretieren können.
MAN_KEEP_STDERR
Normalerweise wird jegliche Fehlerausgabe von dem Befehl, der zum Erstellen formatierter Versionen von Handbuchseiten verwendet wird, verworfen, wenn die Ausgabe an ein Terminal (normalerweise an einen Pager) weitergeleitet wird, um zu verhindern, dass sie die Anzeige des Pagers stört. Programme wie groff erzeugen oft relativ geringfügige Fehlermeldungen über typografische Probleme wie schlechte Ausrichtung, die unansehnlich sind und in der Regel verwirrend sind, wenn sie zusammen mit der Handbuchseite angezeigt werden. Einige Benutzer möchten sie jedoch trotzdem sehen, daher wird, wenn $MAN_KEEP_STDERR auf einen beliebigen nicht leeren Wert gesetzt ist, die Fehlerausgabe wie gewohnt angezeigt.
MAN_DISABLE_SECCOMP
Unter Linux beschränkt man normalerweise Unterprozesse, die nicht vertrauenswürdige Daten verarbeiten, mit einer seccomp(2)-Sandbox. Dies macht es sicherer, komplexe Parsing-Code über beliebige Handbuchseiten auszuführen. Wenn dies aus irgendeinem Grund, der nicht mit dem Inhalt der angezeigten Seite zusammenhängt, fehlschlägt, können Sie $MAN_DISABLE_SECCOMP auf einen beliebigen nicht leeren Wert setzen, um die Sandbox zu deaktivieren.
PIPELINE_DEBUG
Wenn die Umgebungsvariable $PIPELINE_DEBUG auf "1" gesetzt ist, gibt man dann Debug-Meldungen auf der Standardfehlerausgabe aus, die die einzelnen ausgeführten Unterprozesse beschreiben.
LANG, LC_MESSAGES
Abhängig vom System und der Implementierung werden entweder oder beide der Umgebungsvariablen $LANG und $LC_MESSAGES abgefragt, um die aktuelle Nachrichten-Locale zu ermitteln. Man zeigt seine Meldungen in dieser Locale an (falls verfügbar). Einzelheiten finden Sie in setlocale(3).
DATEIEN
/etc/manpath.config
man-db-Konfigurationsdatei.
/usr/share/man
Eine globale Handbuchseiten-Hierarchie.
STANDARDS
POSIX.1-2001, POSIX.1-2008, POSIX.1-2017.
SIEHE AUCH
apropos(1), groff(1), less(1), manpath(1), nroff(1), troff(1), whatis(1), zsoelim(1), manpath(5), man(7), catman(8), mandb(8)
Die Dokumentation für einige Pakete ist möglicherweise in anderen Formaten verfügbar, z. B. info(1) oder HTML.
HISTORIE
1990 1991 – Ursprünglich von John W. Eaton (_) geschrieben.
-
Dez. 1992: Rik Faith (_) wendete Fehlerbehebungen an, die von Willem Kasdorp (_) geliefert wurden.
-
April 1994 – 23. Februar 2000: Wilf (_) hat dieses Paket mit Hilfe einiger engagierter Personen entwickelt und gewartet.
-
Oktober 1996 – 30. März 2001: Fabrizio Polacco <_> hat dieses Paket für das Debian-Projekt mit Hilfe der gesamten Community gewartet und verbessert.
-
März 2001 – heute: Colin Watson <_> entwickelt und wartet nun man-db.
FEHLER
https://gitlab.com/man-db/man-db/-/issues https://savannah.nongnu.org/bugs/?group=man-db