man(n) Manual Hilfsprogramme man(n) NAME man - Programm zum Einsehen der Online-Manuale SYNTAX man [-acdhwutZV] [-m System[,...]] [-L locale] [-p Zeichenkette] [-M Pfad] [-P Pager] [-r Prompt] [-T Format] [-S Liste] [-e Erweiterung] [[Abschnitt] Seite ...] ... man -l [-tZ] [-p Zeichenkette] [-P Pager] [-r Prompt] [-T Format] Datei ... man -k Schlsselwort ... man -f Seite ... BESCHREIBUNG man ist der Manualbrowser des Systems. Jedes Argument Seite ist normalerweise der Name eines Programmes oder einer Funktion. Gefunden und angezeigt wird die Manual- seite, die auf alle Argumente pat. Wenn ein Abschnitt angegeben wird, sucht man nur in diesem Abschnitt der Man- ualseiten. Ohne Angabe eine explizite Angabe werden alle verfgbaren Abschnitte in einer vorher definierten Reihen- folge durchsucht. Wenn die Seite in mehreren Abschnitten vorkommt, wird nur die jeweils erste Seite angezeigt, die gefunden wird. Die folgende Tabelle zeigt die Nummern der Abschnitte der Manualseiten gefolgt vom Typ der dort zu findenden Seiten. tab (@); l l. 1@Ausfhrbare Programme oder Shellbefehle 2@Systemaufrufe (Kernelfunktionen) 3@Bibliotheksaufrufe (Funktionen in System-Bibliotheken) 4@Spezielle Dateien (gewhnlich in /dev) 5@Dateiformate und Konventionen, z. B. /etc/passwd 6@Spiele 7@Makropakete und Konventionen, z. B. man(n), groff(f) 8@Systemadministrationsbefehle (in der Regel nur fr root) 9@Kernelroutinen [Nicht Standard] n@neu [veraltet] l@lokal [veraltet] p@ffentlich [veraltet] o@alt [veraltet] Eine Manualseite besteht aus mehreren Teilen. Die blichen Bezeichnungen sind u. a. NAME, SYNTAX, BESCHREIBUNG, OPTIONEN, DATEIEN, SIEHE AUCH, FEHLER, und AUTOR. Die folgenden Konventionen gelten fr den Abschnitt SYNTAX und knnen fr andere Abschnitte als Anleitung benutzt wer- den. tab (@); l l. bold text@Literale Angaben wie in der Anzeige. italic text@Ersetzen durch passendes Argument. [-abc]@Ein oder mehrere Argumente innerhalb der [ ] sind optional. -a|-b@Optionen, die durch | abgegrenzt sind, knnen nicht zusammen benutzt werden. Argument ...@Argu- ment kann wiederholt werden. [Ausdruck] ...@gesamter Aus- druck innerhalb [ ] kann wiederholt werden. Die Befehls- oder Funktionsbeispiele sind Muster, die auf alle mglichen Aufrufe passen sollten. In manchen Fllen ist es ratsam, die verschiedenen sich ausschlieenden Aufrufe zu illustrieren, wie es im SYNTAX Abschnitt dieser Manual- seite gezeigt ist. BEISPIELE man ls zeigt die Manualseite fr das Programm ls an. man -a intro zeigt alle vorhandenen intro Manualseiten an. Mit (q)uit ist es mglich, das aufeinanderfolgendende Anzeigen der Seiten abzubrechen oder mit (s)kip eine Seite zu berspringen. man -t alias | lpr -Pps Formatiert die Manualseite, die sich auf alias bezieht, in das Default troff oder groff Format und schickt es an den Drucker ps. Die Defaultausgabe fr groff ist Postscript. Das Default fr troff - ditroff, bentigt weitere Bearbeitung durch grops, bevor es von einem Postscriptdrucker gedruckt werden kann. man --help sollte zu bestimmen helfen, welcher Prozessor an die -t Option gebunden ist. man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi Dieser Befehl formatiert die komprimierte nroff-Manu- alseite ./foo.1x.gz in eine device independent (dvi) Datei. Diese Datei wird zuerst dekomprimiert, bevor sie durch passende Filter und Programme bearbeitet wird. Die Umlenkung ist notwendig, da die -T Option die Ausgabe unformatiert an die Standardausgabe schickt. Die Ausgabe kann mit einem Programm wie xdvi betrachtet oder mit einem Programm wie dvips in Postscript weiterverarbeitet werden. man -k printf Sucht die Kurzbeschreibungen und die Namen der Manual- seiten zum Schlsselwort printf und gibt alle Treffer aus. man -f smail Sucht die Manualseiten, die sich auf smail beziehen und gibt alle gefundenen Kurzbeschreibungen aus. UEBERSICHT Um dem Benutzer eine grtmgliche Flexibilitt zu bieten, sind in man viele Optionen verfgbar. Vernderungen knnen am Suchpfad, in der Reihenfolge der Abschnitte oder am Aus- gabeprozessor vorgenommen werden. Andere Verhaltensweisen und Operationen sind weiter unten beschrieben. Um die Arbeitsweise von man zu bestimmen, werden ver- schiedene Umgebungsvariablen benutzt. Mit dieser Version ist es mglich, die Variable $MANOPT auf einen Ausdruck im Kommandozeilenformat zu setzen. Es gibt folgende Ausnahme: Da jede Option in $MANOPT von Leerzeichen eingeschlossen ist, mssen Leerzeichen, die Teil eines Argumentes sind, gequotet werden. man bearbeitet diese Variable vor der eigenen Kommandozeile. Die Optionen, die ein Argument bentigen, knnen durch die gleichen Optionen in der Komman- dozeile berschrieben werden. Um alle Optionen zurckzuset- zen, die in $MANOPT gesetzt werden, kann -D als initiale Kommandozeilen-Option angegeben werden. Dies erlaubt man alle Optionen zu `berschreiben', die in $MANOPT gesetzt werden, obwohl diese weiterhin gelten. Damit wird die grt- mgliche Flexibilitt fr einen Benutzer erzeugt, der man auf seine eigenen Bedrfnisse anpassen will, ohne zahllose Optionen bei der Suche einer Manualseite einzugeben. Die Hilfsprogramme, die im man_db- Paket zusammengefat sind, machen umfassenden Gebrauch von Indexdatenbanken. Diese Zwischenspeicher enthalten Informationen ber den Ort und die zugehrige whatis Information (einzeilige Kurzbeschreibung der Manualseite), sowie darber, wo sich eine Manualseite im Dateisystem befindet. Eine Aufgabe von man ist die Konsistenzsicherung der Datenbank. Die Daten- banken verhindern die Notwendigkeit einer manuellen Bear- beitung zur Aktualisierung der whatis- Textdatenbank und erlauben man schneller zu arbeiten, als bei der Suche nach der passenden Manualseite im gesamten Dateisystem. Wenn man keine von mandb erstellte Indexdatenbank zu einer speziellen Manualhierarchie finden kann, wird dennoch nach der gewnschten Manualseite gesucht. In diesem Fall ist es jedoch wieder ntig, nach der alten Methode alle in Frage kommenden Verzeichnisse zu durchsuchen (sog. globbing). Wenn whatis oder apropos keine Indexdatenbank finden knnen, versucht es die Information aus der whatis- Daten- bank zu beziehen. Auch anwenderspezifische Manualhierar- chien werden whrend der Benutzung in Indexdatenbanken zusammengefat. Die Hilfsprogramme untersttzen komprimierte nroff-Quell- dateien, die normalerweise die Erweiterung .Z, .z oder .gz besitzen. Jede andere Erweiterung kann untersttzt werden, wenn sie zur bersetzungszeit bekannt ist. Als Default wer- den alle cat-Seiten mit gzip komprimiert. Jede globale Manualhierarchie wie /usr/man oder /usr/X11R6/man kann jedes Verzeichnis als cat-Seiten-Hierarchie besitzen. blicherweise werden cat-Seiten unter der gleichen Hierar- chie wie die Manualseiten gespeichert. Allerdings kann es aus Grnden, die im Linux File System Standard (FSSTND) erlutert sind, besser sein, sie an anderer Stelle zu spe- ichern. Details, wann dies der Fall ist, beschreibt man- path(h). Fr Details, warum dies empfohlen wird, siehe den Linux File System Standard (FSSTND). Dieses Paket untersttzt internationale Anpassungen (sog. NLS-Support, Native Language Support). Durch den Gebrauch von locale Funktionen ist es mglich, Manualseiten der Lan- dessprache zu verwalten, wenn sie auf dem System vorhanden sind. Um diese Untersttzung zu aktivieren, mu man entweder in $LC_MESSAGES, $LANG oder anderen systemabhngigen Umge- bungsvariablen die gewnschte Sprache einstellen. Die Sprache wird normalerweise in dem durch POSIX 1003.1 definierten Format angegeben: <Sprache>[_<Region>[.<Zeichensatz>[,<Version>]]] Wenn die angeforderte Seite in der locale vorhanden ist, wird sie anstelle der Standardseite (normalerweise in amerikanischem Englisch) angezeigt. Darber hinaus werden auch Sammlungen von landessprachlichen Systemmeldungen untersttzt und auf dieselbe Weise aktiviert - ebenfalls unter der Vorraussetzung, da die bersetzten Meldungen vor- liegen. Wer diese Manualseiten und die Ausgaben der Hilf- sprogramme gerne in seiner Landessprache htte, aber diese nicht vorfindet, ist aufgefordert, eine bersetzung anzufertigen und sie dem Autor zuzusenden, damit sptere Versionen davon profitieren knnen. Die anderen Eigenschaften und Erweiterungen von man sind in den beiliegenden Dokumenten beschrieben. Einen umfassenden Einblick in die mandb zugrundeliegenden Konzepte sind in der Dokumentation man_db-2.3 - the database cached manual pager suite beschrieben. Die Doku- mentation sollte auf denselben Server wie das mandb- Paket selbst zu finden sein. NORMALEINSTELLUNGEN man sucht nach der gewschten Manualseite in der Index- datenbank. Wenn die Suche fehlschlgt, wird ein Konsisten- ztest durchgefhrt, um die korrekte Wiedergabe des Dateisystems zu sichern. Nachdem die Datenbanken erzeugt wurden, ist es i. A. nicht notwendig, mandb zu starten, es sei denn, die Datenbank wurde verflscht. Wenn eine Manualseite gefunden wurde, wird getestet, ob dazu bereits eine vorformatierte cat-Seite existiert und diese neuer als die nroff-Datei ist. In diesem Fall wird die vorformatierte Datei dekomprimiert und mit einem Browser angezeigt. Die Auswahl des Browsers kann auf unterschiedliche Weise erfolgen (fr Details siehe -P Option). Wenn keine cat-Seite gefunden wird oder wenn sie lter als die nroff-Datei ist, wird die nroff-Datei durch diverse Programme gefiltert und entweder sofort angezeigt oder zuerst als komprimierte cat-Datei gespeichert und dann angezeigt. Eine cat-Datei wird erzeugt, wenn ein relatives cat-Verze- ichnis existiert und man dort das Schreibrecht hat. Die Filter werden in mehreren Schritten zusammengestellt: Zuerst wird die Kommandozeilen-Option -p oder die Umge- bungsvariable $MANROFFSEQ untersucht. Wenn -p nicht benutzt wird und die Umgebungsvariable nicht gesetzt ist, wird die Anfangszeile der nroff-Datei nach einer Zeichen- kette fr den Prprozessor untersucht. Eine solche Prprozes- sor-Zeichenkette mu folgendes Aussehen haben: '\" <Zeichenkette> wobei Zeichenkette jede Kombination von Buchstaben sein kann, die unter Option -p weiter unten beschrieben sind. Wenn keine der obigen Methoden eine Filter-Information enthlt, wird tbl als Default verwendet. Als primrer Formatierer wird entweder nroff, troff oder groff gestartet. OPTIONEN Eine Argumentoption, die entweder in der Kommandozeile, in $MANOPT oder in beiden doppelt vorkommt , ist nicht schdlich. Fr Optionen, die ein Argument bentigen, berschreibt jedes Duplikat den vorhergehenden Wert. -l, --local-file Aktiviert den lokalen Modus. Formatiert und zeigt lokale Manualdateien an, anstatt die System-Manual- sammlung zu durchsuchen. Jedes Manualseiten-Argu- ment wird als nroff-Quelle im richtigen Format interpretiert. Komprimierte nroff-Quelldateien mit einer untersttzten Kompressions-Erweiterung werden von man dekomprimiert, bevor sie ber den blichen Filter angezeigt werden. Es wird keine cat-Datei erzeugt. Wenn eines der Argumente `-' ist, wird die Eingabe von der Standardeingabe bernommen. -L locale, --locale=locale Normalerweise bestimmt man die aktuelle locale durch einen Aufruf der C Funktion setlocale (3), die diverse Umgebungsvariablen, darunter u. U. $LC_MESSAGES und $LANG untersucht. Diese Funktion kann dazu verwendet werden, kurzzeitig den so gefundenen Wert zu berschreiben. Dazu kann diese Option mit einer Zeichenkette, die die temporre locale enthlt, angegeben werden. Man beachte, da dieser Effekt erst beim konkreten Suchen der Seite in Erscheinung tritt. Daher werden Ausgaben wie die Hilfeseite immer in der ursprnglichen Sprache aus- gegeben. -D, --default Diese Option wird normalerweise nur als allererste angegeben und setzt das Verhalten von man in allen Belangen wieder zum Normalverhalten zurck. Der Zweck dieser Option ist es, Optionen wieder rck- gngig zu machen, die bereits in der Umgebungsvari- able $MANOPT gesetzt sind. Alle Optionen, die -D folgen, haben wieder ihren gewohnten Effekt. -M Pfad, --manpath=Pfad Ermglicht es, einen alternativen Manualpfad anzugeben. Normalerweise verwendet man dieselben Methoden wie in manpath, um den Suchpfad zu ermit- teln. Diese Option berschreibt die Umgebungsvari- able $MANPATH. -P Pager, --pager=Pager Gibt an, welcher Pager verwendet wird. Die Normale- instellung ist exec /usr/bin/pager -s. Diese Option berschreibt die Umgebungsvariable $PAGER und wird nicht in Zusammenhang mit -f oder -k verwen- det. -r Prompt, --prompt=Prompt Wenn eine hinreichend neue Version von less als Pager verwendet wird, versucht man dort einige sin- nvolle Optionen zu setzen. Die Eingabeaufforderung in der letzten Zeile sieht in dem Fall so aus: Manual page name(e) line x, wobei name die Manualseite bezeichnet, die gerade angezeigt wird, sec der Abschnitt ist, in dem sie gefunden wurde, und x die aktuelle Zeilennummer ist. Diese Anzeige wird durch Verwendung der Umge- bungsvariable $LESS erreicht. Man beachte, da einzelne Bezeichnungen sich bei der Verwendung von landessprachlichen Meldungen ndern knnen. Die Option -r ermglicht es, durch Angabe einer For- matierungszeichenkette, das Ausgabeformat selbst zu bestimmen. Wenn diese Zeichenkette $MAN_PN enthlt, wird dieser Text durch den Namen der Manualseite gefolgt von der Abschnittsnummer in runden Klammern ersetzt. Die Zeichenkette, die im Normalfall ver- wendet wird ist: \ Manual\ page\ \$MAN_PN\ ?ltline\ %lt?L/%L.: byte\ %bB?s/%s..?\ (END):?pB %pB\\%.. Die zweizeilige Darstellung wurde nur der besseren Lesbarkeit wegen gewhlt. Nhere Informationen liefert less(s). Da die Zeichenkette zuerst vom Kommandointerpreter ausgewertet wird, mssen entsprechende Zeichen durch einen Backslash geschtzt werden. Weitere Optionen fr less knnen nach einem geschtzten $ am Ende der Zeichenkette hinzugefgt werden. Der Default ist hier -ix8. -S Liste, --sections=Liste Eine durch Doppelpunkte getrennte Liste von Abschnitten definiert bei Benutzung dieser Option die Reihenfolge, in der die Abschnitte durchsucht werden. Diese Option berschreibt die Umgebungsvari- able $MANSECT. -a, --all Wird eine Manualseite in einem Abschnitt gefunden, so terminiert man nach Anzeige dieser Seite. Wird jedoch diese Option angegeben, so werden alle passenden Manualseiten nacheinander angezeigt. -c, --catman Diese Option berprft nur, ob die zur angegebenen Manualseite passende cat-Seite aktuell ist und erzeugt ggf. eine neue. Es wird dabei nichts angezeigt. -d, --debug Bei dieser Option werden keine Manualseiten angezeigt, sondern nur eine Menge von Diagnosein- formation. -e Erweiterung, --extension=Erweiterung Einige Systeme enthalten groe Pakete an Manual- seiten, wie z. B. in dem Tcl Paket, die in die nor- malen Manualabschnitte integriert werden. Um beispielsweise das Problem zweier unterschiedlicher Manualseiten mit gleichem Namen, wie exit(t), zu lsen, wurden frher alle Tcl Seiten dem Abschnitt l zugeordnet. Dieses erwies sich als keine gute Lsung. Bei dieser Version von man ist es mglich, die Seiten in die richtigen Abschnitte einzuordnen und ihrem Seitennamen eine spezifische Erweiterung, hier z. B. exit(t) anzuhngen. Unter normalen Umstnden zeigt man bevorzugt exit(t) gegenber exit(t) an. Um dieses Verhalten umzukehren, ist man die Zeichenkette Erweiterung zu bergeben, die angibt, in welchem Paket die Manualseite zu finden ist. Im obigen Fall beschrnkt man seine Suche auf Seiten mit der Erweiterung *tcl, wenn es mit -e tcl aufgerufen wurde. Die Suche wird dabei in allen Abschnitten durchgefhrt. -f, --whatis Diese Option ist das quivalent zu whatis. Es wird eine Kurzbeschreibung der gewnschten Manualseite angezeigt, wenn sie gefunden wurde. Zu Details siehe whatis(s). Mit dieser Option ist nur eine Standardsuche mglich. Verbesserte Suchmglichkeiten bieten die Optionen von whatis. -k, --apropos Diese Option ist das quivalent zu apropos. Es wer- den die Kurzbeschreibungen zu allen Manualseiten nach dem angegebenen Stichwort durchsucht. Zu Details siehe apropos(s). Mit dieser Option ist nur eine Standardsuche mglich. Verbesserte Such- mglichkeiten bieten die Optionen von apropos. -m System[,...], --systems=System[,...] Wenn auch Manualseiten von einem anderen Betrieb- ssystem installiert sind, so kann auf sie mit dieser Option zugegriffen werden. Um beispielsweise die Manualseiten von NewOS zu durchsuchen, mu -m NewOS angegeben werden. Das angegebene System kann eine durch Kommata abge- trennte Aufzhlung von Betriebssystemnamen sein. Die normalen Seiten werden durch den Betriebssystemna- men man angesprochen. Diese Option berschreibt die Umgebungsvariable $SYSTEM. -p Zeichenkette, --preprocessor=Zeichenkette Diese Option gibt die Reihenfolge an, in der die Prprozessoren vor nroff oder troff/groff abgear- beitet werden. Nicht alle Installationen haben notwendigerweise alle Prprozessoren. Einige der Prprozessoren und die Zeichen, um sie zu reprsen- tieren, sind: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Diese Option berschreibt die Umgebungsvariable $MANROFFSEQ. Der Prprozessor zsoelim wird immer als erster gestartet. -u, --update Die Indexdatenbanken werden immer whrend des laufenden Betriebes auf neuestem Stand gehalten, was insbesondere bedeutet, da mandb nicht bentigt wird, um sie konsistent zu halten. Wenn die ausge- whlte Manualseite nicht im Index gefunden wurde oder die -a Option verwendet wurde, macht man einen Konsistenztest auf Verzeichnisebene, um sicherzustellen, da der Index immer noch eine gltige Reprsentation der Manualseiten im Dateisys- tem darstellt. Wenn dieser Test auf Inode-Ebene durchgefhrt werden soll, mu man die Option -u benutzen. -t, --troff Mit dieser Option wird /usr/bin/groff -mandoc ver- wendet, um die Manualseite zu formatieren und an die Standardausgabe zu liefern. Im Zusammenhang mit -T oder -Z ist diese Option nicht ntig. -T Format, --troff-device [=Format] Diese Option wird dazu verwendet, um das Aus- gabeformat von groff (oder mglicherweise troff) zu ndern. Diese Option impliziert die Angabe von -t. Verfgbare Ausgabeformate (von Groff-1.09) beinhal- ten dvi, latin1, X75 und X100. -Z, --ditroff Das traditionelle troff erzeugt ditroff. groff startet zunchst troff und leitet danach dessen Aus- gabe an einen fr das gewhlte Ausgabeformat geeigneten Postprozessor weiter. Wenn /usr/bin/groff -mandoc groff ist, zwingt diese Option groff dazu, traditionelles troff zu emulieren und impliziert -t, andernfalls wird es ignoriert. -w, --where, --location Zeigt nicht die Manualseiten, sondern die Position der Dateien im Dateisystem an, die formatiert oder angezeigt wrden. Wenn die Datei eine cat-Seite ist, wird auch der Ort ihrer nroff-Quelldatei angezeigt. -h, --help Zeigt einen Hilfstext an. -V, --version Zeigt Programmversion und Autor an. UMGEBUNG MANPATH Wenn $MANPATH gesetzt ist, wird dessen Wert als Suchpfad fr die Manualseiten benutzt. MANROFFSEQ Wenn $MANROFFSEQ gesetzt ist, wird dessen Wert benutzt, um die Abfolge der Prprozessoren zu bes- timmen, die jede Manualseite vor nroff oder troff durchluft. Als Default durchlaufen die Seiten den tbl (t) Prprozessor. MANSEC Wenn der Wert von $MANSEC eine durch Doppelpunkte getrennte Liste von Abschnitten ist, wird dieser Wert dazu benutzt, um die zu durchsuchenden Abschnitte und deren Reihenfolge zu bestimmen. PAGER Wenn $PAGER gesetzt ist, wird dieses Programm zur Anzeige benutzt. Default ist exec /usr/bin/pager -s . SYSTEM Wenn $SYSTEM gesetzt ist, hat dies den gleichen Effekt wie die Option -m System wobei System als Inhalt der Umgebungsvariable $SYSTEM benutzt wird. MANOPT Wenn $MANOPT gesetzt ist, wird der Wert dieser Variablen vor der man Kommandozeile durchsucht und abgearbeitet. Wie auch alle anderen Umgebungsvari- ablen, die als Kommandozeilen-Optionen ausgedrckt werden knnen, ist es mglich, den Inhalt von $MANOPT durch die Kommandozeile zu berschreiben. Alle Leerzeichen, die Teil eines Argumentes sind, mssen gequotet werden. LANG, LC_MESSAGES Abhngig von System und Implementation werden entweder $LANG oder $LC_MESSAGES oder beide nach der gegenwrtigen locale Information durchsucht. man wird (wenn mglich) seine Nachrichten in dieser locale anzeigen. Fr Details siehe setlocale(e). DATEIEN /etc/manpath.config Die Manualkonfigurationsdatei. /usr/.../man Globale Manualhierarchien. /var/catman/.../index.(bt|db|dir|pag) Die FSSTND complianten globalen Indexdatenbanken. SIEHE AUCH mandb(b), manpath(h), manpath(h), apropos(s), whatis(s), catman(n), less(s), nroff(f), troff(f), groff(f), zsoe- lim(m), setlocale(e), man(n), ascii(i), latin1(1). FEHLER Die Option -t funktioniert nur, wenn ein troff-hnliches Programm installiert ist. Die Option -e funktioniert momentan nur in Manualhierar- chien, fr die mit mandb eine Indexdatenbank erzeugt wurde. Manualseiten, die die erweiterte Darstellung im Zusammen- hang mit der Option -e untersttzen, drfen keinen Punkt beinhalten, denn sonst werden diese Seiten als fehlerhaft zurckgewiesen. GESCHICHTE 1990, 1991 - Originale geschrieben von John W. Eaton (jwe@che.utexas.edu). 23. Dez. 1992: Fehlerbereinigung durch Rik Faith (faith@cs.unc.edu) untersttzt durch Willem Kasdorp (wkasdo@nikhefk.nikef.nl). Zwischen dem 30. April 1994 und dem 23. Februar 2000 hat Wilf (G.Wilford@ee.surrey.ac.uk) unter Mithilfe von eini- gen wenigen engagierten Menschen dieses Paket entwickelt und weitergefhrt. Die deutsche bersetzung wurde von Anke Steuernagel (a_steuer@informatik.uni-kl.de) und Nils Magnus (mag- nus@informatik.uni-kl.de) angefertigt. Fr persnliche Wrdigungen und Zustze siehe Quelltexte. 2.3.20 07 September 2001 man(n)