Man/Optionen

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

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

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

Ausgabe

Steuerung der Ausgabeformatierung

Unix	GNU	Parameter	Beschreibung

-P Anzeigeprogramm, --pager=Anzeigeprogramm Gibt an, welches Anzeigeprogramm verwendet werden soll

Standardmäßig verwendet man pager, wobei auf cat ausgewichen wird, falls pager nicht gefunden wurde oder nicht ausführbar ist
Diese Option überschreibt die Umgebungsvariable $MANPAGER, welche wiederum die Umgebungsvariable

$PAGER überschreibt

Die Option wird nicht zusammen mit -f oder -k verwendet

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

-r Eingabeaufforderung, --prompt=Eingabeaufforderung Wenn eine aktuelle Version von less(1) als Anzeigeprogramm verwendet wird, versucht man, dort einige sinnvolle Optionen zu setzen

Die Standard-Eingabeaufforderung ähnelt

Handbuchseite Name(Abschnitt) Zeile x

wobei Name die Handbuchseite bezeichnet, x die aktuelle Zeilennumer und Abschnitt den Fundort bezeichnet

Diese Anzeige wird durch Verwendung der Umgebungsvariable $LESS erreicht

Die Option -r in Verbindung mit einer Zeichenkette setzt diese Vorgabe außer Kraft

Wenn diese Zeichenkette $MAN_PN enthält, wird dieser Text durch den Namen der Handbuchseite gefolgt von der Abschnittsnummer, umgeben von »(« und »)«, ersetzt
Die Zeichenkette für die Erzeugung der Voreinstellung könnte als

\ Manual\ page\ \$MAN_PN\ ?ltline\ %lt?L/%L.:
byte\ %bB?s/%s..?\ (END):?pB\ %pB\\%.

h gibt einen Hilfstext aus, q beendet das Programm

ausgedrückt werden.) Die dreizeilige Darstellung wurde nur der besseren Lesbarkeit wegen gewählt

Was das bedeutet, steht in der Handbuchseite von less(1)
Da die Zeichenkette zuerst von der Shell ausgewertet wird, müssen alle einfachen und doppelten Anführungszeichen sowie der linksseitige Schrägstrich (Backslash) durch einen vorangestellten Backslash geschützt werden
Weitere Optionen für less(1) können nach einem geschützten $ am Ende der Zeichenkette hinzugefügt werden
Die Standardwerte sind hier -ix8

Wie nachfolgend beschrieben, kann die Umgebungsvariable $MANLESS zum Festlegen einer Vorgabe-Zeichenkette für die Eingabeaufforderung verwendet werden, sofern in der Befehlszeile keine angegeben wird

-7, --ascii Bei der Anzeige einer in reinem ascii(7) kodierten Handbuchseite auf einem 7-Bit-Terminal oder -Terminal-Emulator können einige Zeichen nicht korrekt angezeigt werden, wenn die latin1(7)-Gerätebeschreibung mit GNU Nroff benutzt wird

Diese Option ermöglicht die Anzeige von in reinem ascii kodierten Handbuchseiten als ascii-Zeichen auf dem latin1-»Gerät«
Latin1-kodierter Text wird nicht übersetzt
Die folgende Tabelle zeigt die Übersetzungen, die durchgeführt werden: Ein Teil davon kann nur dann richtig angezeigt werden, wenn das latin1-»Gerät« von GNU Nroff verwendet wird

Beschreibung oktal latin1 ascii ───────────────────────────────────────────────────────── Bindestrich 255 ‐ - Aufzählungszeichen (middle dot) 267 • o Accent aigu 264 ´ ' Multiplikationszeichen 327 × x

Wenn die latin1-Spalte richtig angezeigt wird, kann das Terminal für die Anzeige von latin1-Zeichen eingerichtet sein und diese Option ist nicht notwendig

Wenn die Spalten latin1 und ascii identisch sind, lesen Sie diese Seite schon mit dieser Option oder man hat diese Seite nicht mit der latin1-Gerätebeschreibung formatiert
Wenn die latin1-Spalte fehlt oder beschädigt ist, müssen Sie möglicherweise die Handbuchseiten mit dieser Option ansehen

Diese Option wird ignoriert, wenn Sie die Optionen -t, -H, -T oder -Z verwenden und kann nutzlos sein, wenn Sie eine andere als die GNU-Version von Nroff verwenden

-E Kodierung, --encoding=Kodierung Erzeugt eine Ausgabe für eine vom Standard verschiedene Zeichenkodierung

Aus Gründen der Abwärtskompatibilität kann Kodierung ein Nroff-Gerät wie ascii, latin1 oder utf8 sowie eine richtige Zeichenkodierung wie UTF-8 sein

--no-hyphenation, --nh Normalerweise wird Nroff automatisch Text an Zeilenumbrüchen trennen, um damit den Text ohne übermäßige Abstände darzustellen

Dazu trennt es auch Wörter, die keinen Bindestrich enthalten
Diese Option deaktiviert die automatische Silbentrennung
Sie trennt nur Wörter, die bereits Bindestriche enthalten

Wenn Sie eine Handbuchseite schreiben und einfach nur Nroff von der falschen Trennung eines Wortes abhalten wollen, verwenden Sie nicht diese Option

Lesen Sie stattdessen die Nroff-Dokumentation
Beispielsweise können Sie durch das Einfügen von »\%« in einem Wort diese Stelle als Trennstelle markieren oder mit »\%« am Wortanfang das Wort als nicht trennbar kennzeichnen

--no-justification, --nj Normalerweise setzt Nroff den Text automatisch im Blocksatz

Diese Option deaktiviert die Ausrichtung des Textes an der rechten Seite und bewirkt damit an der rechten Seite unterschiedliche Leerräume (»ragged right«)

Wenn Sie eine Handbuchseite schreiben und Sie wollen einfach nur Nroff vom Blocksatz bestimmter Absätze abhalten, verwenden Sie nicht diese Option

Lesen Sie stattdessen die Nroff-Dokumentation
Beispielsweise können Sie die Direktiven .».na.«, ».nf«, ».fi« und ».ad« verwenden, um zeitweise Ausrichten und Füllen zu deaktivieren

-p Zeichenkette, --preprocessor=Zeichenkette Diese Option gibt die Reihenfolge an, in der die Präprozessoren vor Nroff oder Troff/Groff aufgerufen werden

Nicht alle Installationen verfügen über alle Präprozessoren
Einige der Präprozessoren und die Zeichen, die sie repräsentieren, sind: eqn (e), grap (g), pic (p), tbl

(t), vgrind (v), refer (r)

Diese Option überschreibt die Umgebungsvariable $MANROFFSEQ
Der Präprozessor zsoelim wird immer als erster gestartet

-t, --troff Mit dieser Option wird groff -mandoc verwendet, um die Handbuchseite zu formatieren und an die Standardausgabe zu liefern

In Verbindung mit -H, -T oder -Z ist diese Option nicht erforderlich

-T[Gerät], --troff-device[=Gerät] Diese Option wird dazu verwendet, um das Ausgabeformat von Groff (oder möglicherweise Troff) für andere als das Standardausgabegerät anzupassen

Diese Option impliziert -t
Zu den verfügbaren Ausgabeformaten (von Groff-1.17) gehören dvi, latin1, ps, utf8, X75 und X100.X75

und X100

-H[Browser], --html[=Browser] Diese Option veranlasst Groff, eine HTML-Ausgabe zu erzeugen und diese in einem Webbrowser anzuzeigen

Der Browser wird durch das optionale Argument Browser ausgewählt
Fehlt es, wird er durch die Umgebungsvariable $BROWSER oder Vorgaben beim Bau des Programms (in der Regel linux)

bestimmt

Diese Option impliziert -t und wird nur mit GNU Troff arbeiten

-X[dpi], --gxditview[=dpi] Diese Option zeigt die Ausgabe von Groff mit dem Programm gxditview in einem Grafik-Fenster an

Mögliche Werte für dpi (dots per inch) sind 75, 75-12, 100 oder 100-12 sein; Standard ist 75
Die 12-Varianten verwenden eine 12-Punkt-Basisschrift
Diese Option impliziert mit den »Geräten« X75, X75-12, X100 oder X100-12 jeweils -T

-Z, --ditroff Groff ruft Troff und anschließend den passenden Postprozessor auf, um eine für das gewählte »Gerät« verwendbare Ausgabe zu erzeugen

Wenn groff -mandoc Groff ist, wird diese Option an Groff weitergereicht und verhindert den Gebrauch eines Postprozessors
Diese Option impliziert -t