MAN(1) Dienstprogramme fur Handbuchseiten MAN(1) BEZEICHNUNG man - eine Oberflache fur die System-Referenzhandbucher UBERSICHT man [man Optionen] [[Abschnitt] Seite ...] ... man -k [apropos Optionen] Regularer_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-Anzeigeprogramm fur die Handbuchseiten. Jedes an man ubergebene 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 verfugbaren 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 Ausfuhrbare Programme oder Shell-Befehle 2 Systemaufrufe (Kernel-Funktionen) 3 Bibliotheksaufrufe (Funktionen in Programmbibliotheken) 4 Spezielle Dateien (gewohnlich in /dev) 5 Dateiformate und Konventionen, z.B. /etc/passwd 6 Spiele 7 Verschiedenes (einschliesslich Makropaketen und Konventionen), z. B. man(7), groff(7), man-pages(7) 8 Befehle fur die Systemverwaltung (in der Regel nur fur root) 9 Kernel-Routinen [nicht Standard] Eine Handbuchseite besteht aus verschiedenen Abschnitten. Zu den gebrauchlichen Abschnittsnamen gehoren NAME, SYNOPSIS, CONFIGURATION, DESCRIPTION, OPTIONS, EXIT STATUS, RETURN VALUE, ERRORS, ENVIRONMENT, FILES, VERSIONS, STANDARDS, NOTES, BUGS, EXAMPLE, AUTHORS und SEE ALSO. Die folgenden Konventionen gelten fur den Abschnitt UBERSICHT und konnen fur 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 konnen nicht zusammen benutzt werden. Argument ... Das Argument kann wiederholt werden. [Ausdruck] ... Der gesamte Ausdruck innerhalb [ ] kann wiederholt werden. Die Darstellung ist vom Ausgabegerat abhangig. So kann man im Allgemeinen Kursivschrift auf Terminals nicht darstellen und stattdessen den Text unterstreichen oder einfarben. Die Befehls- oder Funktionsdarstellung ist ein Muster, das zu allen moglichen Aufrufen passen sollte. In manchen Fallen ist es ratsam, wie im Abschnitt UBERSICHT dieser Handbuchseite praktiziert, die verschiedenen, sich ausschliessenden Aufrufe anzugeben. BEISPIELE man ls Zeigt die Handbuchseite fur den Begriff (das Programm) ls an. man man.7 Zeigt die Handbuchseite fur das Makropaket man aus Abschnitt 7 an. Dies ist eine alternative Schreibweise fur >>man 7 man<<. man 'man(7)' Zeigt die Handbuchseite fur das Makropaket man aus Abschnitt 7 an. Dies ist eine weitere alternative Schreibweise fur "man 7 man". Dies konnte beim Kopieren und Einfugen von Querverweisen in Handbuchseiten bequemer sein. Beachten Sie, dass die Klammern normalerweise in Anfuhrungszeichen gesetzt werden mussen, um zu verhindern, dass sie von der Shell interpretiert werden. man -a intro Zeigt nacheinander alle vorhandenen >>intro<<-Handbuchseiten an. Sie konnen zwischen den aufeinander folgendenden Ausgaben der Seiten abbrechen oder beliebige Seiten uberspringen. man -t bash | lpr -Pps Formatiert die Handbuchseite fur bash in das Standardformat von Troff oder Groff und schickt sie zum Drucker ps. Fur Groff ist das Standardausgabeformat gewohnlich PostScript. Mit man --help konnen 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 gerateunabhangige (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 Kurzbeschreibungen und Namen der Handbuchseiten nach dem als regularen Ausdruck angesehenen Schlusselwort printf und gibt alle Fundstellen aus. Diese Option entspricht apropos printf. man -f smail Sucht die durch smail angegebenen Handbuchseiten und gibt alle Kurzbeschreibungen der gefundenen Seiten aus. Diese Option entspricht apropos smail. UBERSICHT Um dem Benutzer eine grosstmogliche Flexibilitat zu bieten, sind in man viele Optionen verfugbar. Veranderungen konnen 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 fur die Festlegung der Arbeitsweise von man ausgewertet. Sie konnen die Allzweckvariable $MANOPT auf einen beliebigen Ausdruck im Befehlszeilenformat setzen. Bei der Zuweisung des Wertes an $MANOPT mussen Sie Leerzeichen als Teil von Argumenten einer Option mit einem Backslash (linksseitigem Schragstrich) maskieren (schutzen). man wertet diese Variable vor der eigenen Befehlszeile aus. Die Optionen, die ein Argument benotigen, werden durch die gleichen Optionen in der Befehlszeile uberschrieben. Um alle in $MANOPT gesetzten Optionen zuruckzusetzen, kann als erste Befehlszeilen-Option -D angegeben werden. Dies ermoglicht man, alle in $MANOPT gesetzten Optionen zu >>vergessen<<, obwohl diese weiterhin gultig 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) fur Details dazu, wo diese Dateien gespeichert sind. Dieses Paket unterstutzt Internationalisierung. Wenn auf Ihrem System Handbuchseiten in Ihrer Muttersprache verfugbar sind, konnen Sie mittels Locale-Funktionen auf diese Seiten zugreifen. Falls Ihr System nicht bereits automatisch vornimmt, muss um diese Unterstutzung zu aktivieren, entweder in $LC_MESSAGES, $LANG oder anderen systemabhangigen Umgebungsvariablen die gewunschte Sprache festgelegt werden. Die Sprache wird normalerweise im POSIX- Format angegeben: [_[.[,]]] Wenn die angeforderte Seite in Ihrer Locale verfugbar 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 hatten, aber diese nicht vorfinden und Sie diese beisteuern mochten, nehmen Sie bitte mit dem Betreuer dieser Software Kontakt auf, der dann die Ubersetzung 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 uber weitere Funktionen und Erweiterungen, die fur dieses Handbuch-Anzeigeprogramm verfugbar 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/man_db.conf ausser Kraft gesetzt werden. Folgende Reihenfolge ist voreingestelllt: 1 1p n l 8 3 3p 0 0p 2 3type 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 fur 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 fur den Praprozessor untersucht. Um eine gultige Praprozessor-Zeichenkette zu enthalten, muss die erste Zeile '\" ahneln, 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 ausgefuhrt. Wenn alternativ ein ausfuhrbares Programm mandb_nfmt (oder mandb_tfmt mit -t) in der Wurzel der Handbuchhierarchie existiert, wird dieses an Stelle der Pipeline ausgefuhrt. Ihm wird die Handbuchquelldatei, die Zeichenkette fur den Praprozessor und wahlweise das durch die Argumente -T oder -E festgelegte >>Gerat<< (tatsachlich ein Dateiformat oder ein Zeichensatz) ubergeben. OPTIONEN Optionen ohne Argumente, die entweder in der Befehlszeile, in $MANOPT oder in beiden doppelt vorkommen, sind nicht schadlich. Fur Optionen, die ein Argument benotigen, uberschreibt jedes Duplikat den vorhergehenden Wert. Allgemeine Optionen -C Datei, --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 zuruck. 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 gepruft werden. Warnmeldungen ist eine kommagetrennte Liste von Warnungen. Wird kein Wert vorgegeben, wird die Voreinstellung >>mac<< angewendet. Um eine groff-Warnung zu deaktivieren, stellen Sie ihr ein Ausrufezeichen (!) voran: Beispielsweise aktiviert --warnings=mac,!break Warnungen in der Kategorie >>mac<< und deaktiviert sie in der Kategorie >>break<<. Siehe den Punkt >>warnings<< in info groff fur eine Liste verfugbarer Warnungen. Haupt-Betriebsarten -f, --whatis Diese Option ist in etwa vergleichbar mit whatis. Wenn die Handbuchseite verfugbar ist, wird eine Kurzbeschreibung der gewunschten Handbuchseite angezeigt. Zu Details siehe whatis(1). -k, --apropos Diese Option ist etwa vergleichbar mit apropos. Es werden die Kurzbeschreibungen der Handbuchseiten nach Schlusselwortern 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 moglich, einen Abschnitt angeben, um die Anzahl der zu durchsuchenden Seiten zu reduzieren. Suchbegriffe konnen einfache Zeichenketten (Voreinstellung) oder bei Verwendung der Option --regex regulare Ausdrucke sein. Beachten Sie, dass dies die Quellen der Handbuchseiten, nicht den dargestellten Text, durchsucht und daher aufgrund von Kommentaren in den Quelltexten, Fehlinterpretationen von Bindestrichen, die als >>\-<< geschrieben sind und ahnlichem falsche Treffer enthalten kann. Durchsuchen des dargestellten Textes ware 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 gultig formatierte Nroff-Quelle interpretiert. Es werden keine Cat-Dateien erstellt. Wenn eines der Argumente >>-<< ist, wird die Eingabe von der Standardeingabe ubernommen. Wenn diese Option nicht verwendet wird, dann wird man auch darauf ausweichen, als Argumente angegebene Handbuchseiten als lokale Dateinamen zu interpretieren, wenn das Argument einen Schragstrich (/) enthalt, da dies darauf hindeutet, dass sich das Argument auf einen Pfad im Dateisystem bezieht. -w, --where, --path, --location Zeigt nicht die Handbuchseiten an, sondern gibt den Ort der Nroff-Quelldatei aus, die formatiert werden wurde. 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 wurden. 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 fur jeden moglichen Treffer ausgefuhrt. -c, --catman Diese Option ist nicht fur den allgemeinen Gebrauch bestimmt und sollte nur von dem Programm catman verwendet werden. -R Kodierung, --recode=Kodierung Anstatt die Seite wie ublich zu formatieren, wird der Quelltext in die angegebene Kodierung umgewandelt und ausgegeben. Wenn Sie die Kodierung der Quelldatei bereits kennen, konnen Sie auch direkt manconv(1) aufrufen. Diese Option ermoglicht Ihnen aber die Umkodierung mehrerer Handbuchseiten ohne die ausdruckliche Angabe der Kodierung jeder einzelnen Datei, wenn die Seiten schon in einer zu den Handbuchhierarchien analogen Struktur installiert sind. Ziehen Sie in Erwagung, man-recode(1) zu verwenden, anstatt mehrere Handbuchseiten umzuwandeln, da dessen Benutzerschnittstelle fur Mehrfachumwandlungen entworfen wurde und daher viel schneller sein kann. Handbuchseiten finden -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 vorubergehend ausser Kraft zu setzen, konnen Sie man mit dieser Option eine Locale vorgeben. Beachten Sie, dass dieser Wert erst wirksam wird, wenn die Suche tatsachlich 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, konnen 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 Aufzahlung von Betriebssystemnamen sein. Um auch die Handbuchseiten des eigenen Betriebssystems zu durchsuchen, fugen sie den Systemnamen man in die Argument-Zeichenkette ein. Diese Option uberschreibt die Umgebungsvariable $SYSTEM. -M Pfad, --manpath=Pfad Gibt die Verwendung eines alternativen Pfades vor. Standardmassig verwendet man von manpath abgeleiteten Code, um den Suchpfad zu ermitteln. Diese Option uberschreibt die Umgebungsvariable $MANPATH und sorgt dafur, 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 (fur die Anzeige von Handbuchseiten ausserhalb solcher Hierarchien siehe die Option -l). -S Liste, -s Liste, --sections=Liste Mit der Liste, in der Sie Doppelpunkte oder Kommas als Trennzeichen verwenden konnen, konnen sie eine bestimmte Suchreihenfolge vorgeben. Diese Option setzt die Umgebungsvariable $MANSECT ausser Kraft. (Die Schreibweise -s ist kompatibel mit System V.) -e Unter-Erweiterung, --extension=Unter-Erweiterung Einige Systeme integrieren umfangreiche Handbuchseiten-Pakete, wie z. B. Zubehor fur das Tcl-Paket, in die normalen Abschnitte. Fur die Losung des Problems zweier unterschiedlicher Handbuchseiten mit gleichem Namen, wie exit(3), wurden fruher alle Tcl-Seiten dem Abschnitt l zugeordnet und mit einer speziellen Endung versehen, in diesem Fall exit(3tcl). Dies erwies sich als ungluckliche Losung. Diese Version von man ermoglicht es, die Seiten in die richtigen Abschnitte einzuordnen und ihre. exit(3tcl), anzufugen. Im Normalbetrieb zeigt man bevorzugt exit(3) gegenuber exit(3tcl) an. Um diese Situation zu bewaltigen, konnen Sie man die Zeichenkette Unter-Erweiterung ubergeben. 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 beschranken. -i, --ignore-case bei der Suche nach Handbuchseiten Gross- und Kleinschreibung ignorieren (Voreinstellung) -I, --match-case Handbuchseiten-Suche unter Beachtung von Gross- und Kleinschreibung --regex Zeigt alle Seiten an, bei denen ein Teil der Namen oder der Beschreibungen auf den als Argument ubergebenen regularen Ausdruck Seite passen, wie bei apropos(1). Gewohnlich gibt es keinen begrundeten Weg, um bei der Suche nach einem regularen 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 ubergebenen 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 ubereinstimmen. Gewohnlich gibt es keinen begrundeten 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 Fallen notwendig. Es ist normalerweise besser, stattdessen den Befehl mandb(8) auszufuhren. --no-subpages Standardmassig versucht man, auf seiner Befehlszeile ubergebene Namenspaare als gleichwertig mit einem Namen, der einen Bindestrich oder einen Unterstrich enthalt, zu interpretieren. Dies unterstutzt das verbreitete Muster von Programmen, die eine Reihe von Unterbefehlen implementieren, sodass fur den Aufruf der entsprechenden Handbuchseiten eine ahnliche Syntax wie fur 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 Steuerung der Ausgabeformatierung -P Anzeigeprogramm, --pager=Anzeigeprogramm Gibt an, welches Anzeigeprogramm verwendet werden soll. Standardmassig verwendet man less, wobei auf cat ausgewichen wird, falls less nicht gefunden wurde oder nicht ausfuhrbar ist. Diese Option uberschreibt die Umgebungsvariable $MANPAGER, welche wiederum die Umgebungsvariable $PAGER uberschreibt. 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 Schragstriche sowie einfache und doppelte Anfuhrungszeichen) enthalten. Er darf keine Pipelines verwenden, um mehrere Befehle zu verbinden. Wenn Sie das benotigen, verwenden Sie ein Skript, das die gewunschte Seite entweder als Argument erhalt 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 ahnelt 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 ausser Kraft. Wenn diese Zeichenkette $MAN_PN enthalt, wird dieser Text durch den Namen der Handbuchseite gefolgt von der Abschnittsnummer, umgeben von >>(<< und >>)<<, ersetzt. Die Zeichenkette fur die Erzeugung der Voreinstellung konnte 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 ausgedruckt werden.) Die dreizeilige Darstellung wurde nur der besseren Lesbarkeit wegen gewahlt. Was das bedeutet, steht in der Handbuchseite von less(1). Da die Zeichenkette zuerst von der Shell ausgewertet wird, mussen alle einfachen und doppelten Anfuhrungszeichen sowie der linksseitige Schragstrich (Backslash) durch einen vorangestellten Backslash geschutzt werden. Weitere Optionen fur less(1) konnen nach einem geschutzten $ am Ende der Zeichenkette hinzugefugt werden. Die Standardwerte sind hier -ix8. Wie nachfolgend beschrieben, kann die Umgebungsvariable $MANLESS zum Festlegen einer Vorgabe-Zeichenkette fur 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 konnen einige Zeichen nicht korrekt angezeigt werden, wenn die latin1(7)-Geratebeschreibung mit GNU Nroff benutzt wird. Diese Option ermoglicht die Anzeige von in reinem ascii kodierten Handbuchseiten als ascii-Zeichen auf dem latin1->>Gerat<<. Latin1-kodierter Text wird nicht ubersetzt. Die folgende Tabelle zeigt die Ubersetzungen, die durchgefuhrt werden: Ein Teil davon kann nur dann richtig angezeigt werden, wenn das latin1->>Gerat<< von GNU Nroff verwendet wird. Beschreibung oktal latin1 ascii ------------------------------------------------ Bindestrich 255 - - Aufzahlungszeichen 267 o o (middle dot) Accent aigu 264 ' ' Multiplikationszeichen 327 x x Wenn die latin1-Spalte richtig angezeigt wird, kann das Terminal fur 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-Geratebeschreibung formatiert. Wenn die latin1-Spalte fehlt oder beschadigt ist, mussen Sie moglicherweise 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 fur eine vom Standard verschiedene Zeichenkodierung. Aus Grunden der Abwartskompatibilitat kann Kodierung ein Nroff-Gerat wie ascii, latin1 oder utf8 sowie eine richtige Zeichenkodierung wie UTF-8 sein. --no-hyphenation, --nh Normalerweise wird Nroff automatisch Text an Zeilenumbruchen trennen, um damit den Text ohne ubermassige Abstande darzustellen. Dazu trennt es auch Worter, die keinen Bindestrich enthalten. Diese Option deaktiviert die automatische Silbentrennung. Sie trennt nur Worter, 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 konnen Sie durch das Einfugen 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 Leerraume (>>ragged right<<). Wenn Sie eine Handbuchseite schreiben und Sie wollen einfach nur Nroff vom Blocksatz bestimmter Absatze abhalten, verwenden Sie nicht diese Option. Lesen Sie stattdessen die Nroff-Dokumentation. Beispielsweise konnen Sie die Direktiven .>>.na.<<, >>.nf<<, >>.fi<< und >>.ad<< verwenden, um zeitweise Ausrichten und Fullen zu deaktivieren. -p Zeichenkette, --preprocessor=Zeichenkette Diese Option gibt die Reihenfolge an, in der die Praprozessoren vor Nroff oder Troff/Groff aufgerufen werden. Nicht alle Installationen verfugen uber alle Praprozessoren. Einige der Praprozessoren und die Zeichen, die sie reprasentieren, sind: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Diese Option uberschreibt die Umgebungsvariable $MANROFFSEQ. Der Praprozessor 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[Gerat], --troff-device[=Gerat] Diese Option wird dazu verwendet, um das Ausgabeformat von Groff (oder moglicherweise Troff) fur andere als das Standardausgabegerat anzupassen. Diese Option impliziert -t. Zu den verfugbaren Ausgabeformaten (von groff 1.23.0) gehoren dvi, latin1, pdf, ps, utf8, 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 ausgewahlt. Fehlt es, wird er durch die Umgebungsvariable $BROWSER oder Vorgaben beim Bau des Programms (in der Regel lynx) 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. Mogliche Werte fur 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 >>Geraten<< X75, X75-12, X100 oder X100-12 jeweils -T. -Z, --ditroff Groff ruft Troff und anschliessend den passenden Postprozessor auf, um eine fur das gewahlte >>Gerat<< 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. Hilfe bekommen -?, --help Hilfetext anzeigen und beenden --usage zeigt eine kurze Anwendungszusammenfassung an und beendet das Programm. -V, --version Versionsinformation anzeigen und beenden EXIT-STATUS 0 erfolgreiche Programmausfuhrung 1 Fehler beim Aufruf, in der Syntax oder in der Konfigurationsdatei 2 betriebsbedingter Fehler 3 Ein Kind-Prozess gab einen von Null verschiedenen EXIT-Status zuruck. 16 Mindestens eine Seite/Datei oder ein Schlusselwort gibt es nicht oder es wurden keine Treffer dafur gefunden. UMGEBUNGSVARIABLEN MANPATH Wenn $MANPATH gesetzt ist, wird ihr Wert als Suchpfad fur die Handbuchseiten benutzt. Siehe den Abschnitt SUCHPFAD in der Handbuchseite manpath(5) fur 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 hinzugefugt. Beispielsweise weist MANROFFOPT=-P-i das Formatierungsprogramm an, kursiven Text (was nur von einigen Terminals unterstutzt wird) statt unterstrichenen Text zu verwenden. MANROFFSEQ Wenn $MANROFFSEQ gesetzt ist, wird ihr Wert benutzt, um die Abfolge der Praprozessoren zu bestimmen, die jede Handbuchseite vor Nroff oder Troff durchlauft. Als Standard durchlaufen die Seiten den Praprozessor 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 1p n l 8 3 3p 0 0p 2 3type 5 4 9 6 7<<, es sei denn, dies wird durch die SECTION-Anweisung in /etc/man_db.conf ausser Kraft gesetzt. MANPAGER, PAGER Wenn $MANPAGER oder $PAGER gesetzt ist ($MANPAGER wird bevorzugt verwendet), legt dieser Wert das Anzeigeprogramm fur die Handbuchseite fest. Standardmassig wird less verwendet, wobei auf cat ausgewichen wird, falls less nicht gefunden wurde oder nicht ausfuhrbar ist. Der Wert kann ein einfacher Befehlsname oder ein Befehl mit Argumenten sein. Er darf Shell-Maskierung (also linksseitige Schragstriche sowie einfache und doppelte Anfuhrungszeichen) enthalten. Er darf keine Pipelines verwenden, um mehrere Befehle zu verbinden. Wenn Sie das benotigen, verwenden Sie ein Skript, das die gewunschte Seite entweder als Argument erhalt oder von der Standardeingabe liest. MANLESS Wenn $MANLESS gesetzt ist, wird deren Wert als Zeichenkette fur die Festlegung einer Eingabeaufforderung fur das Anzeigeprogramm less verwendet, so als ob dieser Wert mit der Option -r ubergeben worden ware (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 ausser 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 fur man --html zu starten. In jedem Befehl wird %s durch einen Dateinamen fur 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 fur 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 fur man spezifischen Umgebungsvariablen auch als Befehlszeilenoptionen ausgedruckt und in $MANOPT aufgenommen werden konnen, ist zu erwarten, dass Sie obsolet werden. Ubrigens mussen alle Leerzeichen, die als Teil eines Arguments interpretiert werden sollen, geschutzt werden. MANWIDTH Wenn $MANWIDTH gesetzt ist, wird ihr Wert als die Zeilenlange fur die Formatierung der Handbuchseiten verwendet. Wenn sie nicht gesetzt ist, werden die Handbuchseiten mit einer fur das aktuelle Terminal angemessenen Zeilenlange angezeigt, die (bei Verfugbarkeit) 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 Zeilenlange 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 konnen. Ist aber $MAN_KEEP_FORMATTING auf einen nicht leeren Wert gesetzt, werden diese Formatierungszeichen beibehalten. Dies kann nutzlich sein fur Adapter, die man interpretieren und Formatierungszeichen verarbeiten konnen. 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 storen. Programme wie Groff produzieren haufig relativ harmlose, hassliche Fehlermeldungen uber 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 vertrauenswurdige Daten verarbeiten, in einer seccomp(2)-Sandbox ein. Dadurch wird es sicherer, komplexen Auswertungscode uber beliebige Handbuchseiten hinweg auszufuhren. Falls dies aus irgendeinem Grund fehlschlagt, der nicht auf den Inhalt der anzuzeigenden Handbuchseite zuruckzufuhren ware, konnen 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 ausgefuhrten Unterprozess beschreiben. LANG, LC_MESSAGES Abhangig von System und Implementierung werden entweder $LANG oder $LC_MESSAGES oder beide nach Informationen zur aktuellen Locale durchsucht. man wird (wenn moglich) seine Nachrichten in dieser Locale anzeigen. Fur genaue Details siehe setlocale(3). DATEIEN /etc/man_db.conf Konfigurationsdatei fur Man-db /usr/share/man globale Handbuchhierarchie. 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) Fur einige Pakete kann die Dokumentation in anderen Formaten verfugbar sein, zum Beispiel info(1) oder HTML. GESCHICHTE 1990, 1991 - John W. Eaton (jwe@che.utexas.edu) schrieb die erste Version. 23. Dez. 1992: Fehlerbereinigung durch Rik Faith (faith@cs.unc.edu) ,unterstutzt durch Willem Kasdorp (wkasdo@nikhefk.nikef.nl). 30. April 1994 - 23. Februar 2000: Wilf (G.Wilford@ee.surrey.ac.uk) hat mit der Hilfe von einigen wenigen engagierten Menschen dieses Paket weiterentwickelt und gewartet. 30. Oktober 1996 - Februar 2000: Fabrizio Polacco wartete und erweiterte mit Hilfe aus der gesamten Community dieses Paket fur das Debian-Projekt. 31. Marz 2001 - heute: Colin Watson entwickelt und wartet man-db. FEHLER https://gitlab.com/man-db/man-db/-/issues https://savannah.nongnu.org/bugs/?group=man-db 2.12.1 2024-04-05 MAN(1)