man

Formatieren und Anzeigen von Seiten des Online-Handbuches (man pages)

man.1.man
man.7.man

1. man.1.man

Manpage of man

man

Section: User Commands (1)
Updated: 2. September 1995
Index Return to Main Contents

NAME

man - Formatieren und Anzeigen von Seiten des Online-Handbuches (man pages)
manpath - Anzeigen des Benutzer-eigenen Suchpfades für Seiten des Online-Handbuches (man pages)

SYNTAX

man [-acdfhktw] [-m system] [-p string] [-C config_file] [-M path] [-P pager] [-S section_list] [section] name ...

BESCHREIBUNG

man formatiert Seiten aus dem Online-Handbuch und zeigt diese an. Diese Version unterstützt die MANPATH und (MAN)PAGER Umgebungsvariablen, so daß Sie ihre eigenen man pages verwenden können und selbst wählen können, welches Programm die formatierten Seiten anzeigen soll. Wenn der Parameter section angegeben wird, so sucht man nur in dieser Sektion des Handbuchs. Sie können auch mit Hilfe von Kommando-Zeilen-Optionen oder Umgebungsvariablen die Reihenfolge angeben, in der die Sektionen nach Einträgen durchsucht werden und welche zusätzlichen Programme die Quelltexte bearbeiten sollen. Wenn der Parameter name das Zeichen / enthält, dann wird zunächst versucht, diese Datei zu bearbeiten. Damit können Sie z.B. man ./foo.5 oder auch man /cd/foo/bar.1.gz eingeben.

OPTIONEN

-C config_file: bestimmt welche man.conf-Datei als Steuerdatei verwendet wird.
-M path: bestimmt eine Liste von Verzeichnissen, die nach Handbuch-Seiten durchsucht werden. Wenn diese Option nicht angegeben ist, so wird die Umgebungsvariable MANPATH benutzt. Ist diese Variable nicht gesetzt, so wird diese Liste aus der Datei man.conf erstellt.
-P pager: bestimmt welches Programm zur Anzeige der Handbuch-Seiten benutzt wird. Als default benutzt man /usr/bin/less -is Diese Option überschreibt die Umgebungsvariable PAGER
-S section_list: ist eine durch Doppelpunkte getrennte Liste von Handbuch-Sektionen, die nach Handbuch-Seiten durchsucht werden soll. Diese Option überschreibt die Umgebungsvariable MANSECT
-a: Als Default wird man beendet, nachdem es die erste Handbuchseite angezeigt hat, die gefunden wurde. Diese Option weist man an, alle Handbuch-Seiten anzuzeigen, die zu name, passen, nicht nur die erste.
-d: zeigt nicht die Handbuch-Seiten an, sondern gibt etliche Informationen zur Fehlersuche aus.
-f: ist äquivalent zu whatis.
-h: gibt eine (einzeilige) Hilfe aus und beendet man.
-k: ist äquivalent zu apropos.
-m system: bestimmt eine andere Menge von Handbuch-Seiten, die aufgrund des angegebenen System-Namen durchsucht werden sollen.
-p string: bestimmt die Abfolge von Präprozessoren, die vor nroff oder troff gestartet werden sollen. Nicht alle Installationen verfügen über alle Präprozessoren. Einige der Präprozessoren und die dafür verwendeten Buchstaben sind: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Diese Option überschreibt die Umgebungsvariable MANROFFSEQ
-t: benutzt /usr/bin/groff -Tps -mandoc um die Handbuch-Seite zu formatieren und leitet die Ausgabe weiter nach stdout. Die Ausgabe von /usr/bin/groff -Tps -mandoc muß möglicherweise durch einen Filter weiterbearbeitet werden, bevor sie gedruckt werden kann.
-w or --path: die Handbuchseiten werden nicht angezeigt, sondern die Fundorte der Seiten, die formatiert oder angezeigt würden. Wenn kein Argument angegeben wurde, wird die Liste der Verzeichnisse ausgegeben, die von man nach Handbuch-Seiten durchsucht werden. Wenn manpath ein Link zu man ist, dann ist "manpath" äquivalent zu "man --path".

ENVIRONMENT

MANPATH: Wenn die Umgebungsvariable MANPATH gesetzt ist, dann wird dieser Wert als Suchpfad für Handbuch-Seiten verwendet.
MANROFFSEQ: Wenn die Umgebungsvariable MANROFFSEQ gesetzt ist, dann wird dieser Wert benutzt um die Präprozessoren zu bestimmen, die aufgerufen werden sollen, bevor die Handbuch-Seite mit nroff oder troff bearbeitet wird. Standardmäßig werden Handbuch-Seiten durch den Tabellen Präprozessor bearbeitet bevor nroff gestartet wird.
MANSECT: Wenn die Umgebungsvariable MANSECT gesetzt ist, dann bestimmt dieser Wert welche Handbuch-Sektionen durchsucht werden sollen.
MANWIDTH: Wenn die Umgebungsvariable MANWIDTH gesetzt ist, dann beschreibt deren Wert die Breite auf der die Handbuch-Seite angezeigt werden soll. Ansonsten wird die Seite u.U. über die gesamte Breite des Bildschirmes gezogen.
PAGER: Wenn die Umgebungsvariable PAGER gesetzt ist, so wird dieser Wert als Name des Programms benutzt, mit dem die Handbuch-Seiten angezeigt werden sollen. Standardmäßig wird /usr/bin/less -is verwendet.
LANG: Wenn die Umgebungsvariable LANG gesetzt ist, gibt ihr Inhalt den Namen des Unterverzeichnisses an, wo zuerst nach der Handbuch-Seite gesucht werden soll. So zB bewirkt der Shell-Befehl `LANG=dk man 1 foo', daß man zuerst in ...../foo.1 nach der Handbuchseite für 'foo' sucht, und wenn es dort nicht fündig wird, dann in ...man1/foo.1, wobei '...' ein Verzeichnis aus dem Suchpfad bedeutet.
NLSPATH, LC_MESSAGES, LANG: Die Umgebungsvariablen NLSPATH und LC_MESSAGES (oder LANG falls erstere nicht existiert) spielen bei der Suche nach dem Message Katalog eine Rolle (englische Messages sind fest einkompiliert, daher ist auch kein Katalog für sie notwendig). Beachten Sie, daß auch Programme wie col(1), das von man aufgerufen wird, noch zusätzliche Variablen wie LC_CTYPE benutzen.
PATH: PATH wird bei der Konstruktion des vorgegebenen Suchpfades für Handbuchseiten verwendet.
SYSTEM: SYSTEM wird verwendet, um einen alternativen Systemnamen herauszufinden (sinnvoll zusammen mit der -m Option).

SIEHE AUCH

apropos(1), whatis(1), less(1), groff(1).

BUGS

Die -t Option kann nur auf System verwendet werden, auf denen ein troff-Programm installiert ist.

This document was created by man2html using the manual pages.
Time: 23:24:30 GMT, July 09, 2008

2. man.7.man

Manpage of MAN

MAN

Section: Verschiedenes (7)
Updated: 7. Juni 1996
Index Return to Main Contents

BEZEICHNUNG

man - Makros zum Formtieren

ÜBERSICHT

groff -Tascii -man datei ...

groff -Tps -man datei ...

man [abschnitt] titel

BESCHREIBUNG

Diese Manualseite beschreibt das groff tmac.an Makropaket. Das Makropaket sollte von Entwicklern benutzt werden, die Manualseiten für Linux schreiben oder portieren. Es ist nahezu kompatibel zu älteren Versionen dieses Paketes, so sollte es kein Problem sein, andere Manualseiten zu konvertieren (Ausnahmen bilden die Erscheinungen des NET-2 BSD, die ein völlig anderes Makropaket benutzen).

Beachten Sie, dass NET-2 BSD Manualseiten mit groff durch die Benutzung der Option -mdoc anstelle der Option -man benutzt werden können. Es wird die Benutzung der Option -mandoc empfohlen, da hiermit automatisch erkannt wird, welches Makropaket benutzt wird.

PRÄAMBEL

Das erste Kommando einer Manpage sollte

.TH Titel Abschnitt Datum Quelle Handbuch

sein, wobei gilt:

Titel

Der Titel der Manpage (z.B. MAN).

Abschnitt

Die Kapitelnummer, der die Manpage zugeordnet werden soll (z.B. 7).

Datum

Das Datum der letzten Revision --- vergessen Sie nicht, dies immer bei einer inhaltlichen Änderung der Manpage zu ändern, da dies die übliche Methode einer Versionskontrolle ist.

Quelle

Die Quelle des Kommandos.

Für Binärdateien benutzen Sie entsprechendes wie GNU, NET-2, SLS Distribution, MCC Distribution.

Für System Calls benutzen Sie die Versionsnummer des betrachteten Kernels: Linux 0.99.11.

Für Library Calls benutzen Sie die Quelle der Funktion selbst: GNU, BSD 4.3, Linux DLL 4.4.1.

Handbuch

Der Titel des gesamten Handbuches (z.B. Bibliotheksfunktionen).

Die traditionellen Handbuchabschnitte sind:

1 Kommandos: Die Kommandos, die vom Benutzer aus einer Shell heraus ausgeführt werden können.
2 System Calls: Funktionen, die vom Kernel selbst für den Aufrufenden ausgeführt werden.
3 Library Calls: Der Großteil der Funktionen der Library libc, so wie sort(3))
4 Spezialdateien: Dateien, die in /dev) zu finden sind.
5 Dateiformate und Konventionen: Formate von menschenlesbaren Dateien wie /etc/passwd .
6 Spiele
7 Makropakete und Konventionen: Eine Beschreibung des standardmäßigen Layouts des Dateisystems, diese Manpage und ähnliche Dinge.
8 System Management Kommandos: Kommandos wie mount(8), die nur durch den Superuser ausführbar sind.
9 Kernel Routinen: Dies ist kein standardisiertes Kapitel und wird geführt, da der Quellcode des Linux Kernels frei verfügbar ist und viele Leute an Änderungen des Kernels parallel arbeiten.

SCHRIFTSÄTZE

Obwohl es mehrere willkürliche Konventionen für Manpages in der Welt von UNIX gibt, beschreiben mehrere Hundert Linux-spezifische Manpages unsere Standards:

Bei Funktionen werden die Argumente stets als kursiv definiert, ebenso wie im Abschnitt ÜBERSICHT, alles andere der Funktion wird im Halbfettdruck dargestellt:

: int myfunction(int argc, char **argv);

Die Umsetzung der Anweisungen kann bei verschiedenen Textprozessoren abweichen, wenn bestimmte Darstellungsarten wie kursiv nicht im angegebenen Zeichensteuervorrat enthalten sind. Es kann dann zu falschen Umsetzungen wie Unterstrichen oder Halbfettdruck anstelle von kursiv kommen.

Dateinamen sind stets kursiv angegeben (z.B. /usr/include/stdio.h), ausgenommen im Abschnitt ÜBERSICHT, wo eingebundene Dateinamen im Halbfettdruck (z.B. #include <stdio.h>). dargestellt werden.

Spezielle Makros, üblicherweise in Großbuchstaben, sind im Halbfettdruck dargestellt, wie beispielsweise MAXINT).

Bei Auflistungen von Fehlercodes werden auch die Codes halbfett dargestellt (diese Liste benutzt üblicherweise das Makro .TP ).

Verweise auf andere Manpages (oder auf das Thema der Manpage) ist halbfett. Wenn eine Kapitelnummer für die Manpage angegeben ist, wird diese normal ohne einschließende Leerzeichen abgegeben, wie in man(7).

Die Kommandos, mit denen das Aussehen der Schrift angegeben wird, sind:

.B

Halbfettdruck

.BI

halbfett, abwechselnd mit kursiv

.BR

halbfett, abwechselnd mit Schrifttyp Roman

.I

kursiv

.IB

kursiv, abwechselnd mit halbfett

.IR

kursiv, abwechselnd mit Schrifttyp Roman

.RB

Roman, abwechselnd mit halbfett

.RI

Roman, abwechselnd mit kursiv

.SB

klein, abwechselnd mit halbfett

.SM

klein

Traditionell darf ein Kommando bis zu sechs Argumente haben, doch die GNU-Version scheint diese Begrenzung zu überschreiten. Argumente werden durch Leerzeichen getrennt, doppelte Anführungszeichen können verwendet werden, um Argumente anzugeben, die Leerzeichen beinhalten. Alle Argumente werden hintereinander ohne die dazwischenliegenden Leerzeichen ausgegeben, sodass beispielsweise mit dem Kommando .BR ein Wort im Halbfettdruck, gefolgt von einem Wort in der Schrift Roman, gefolgt von einem Wort im Halbfettdruck usw. dargestellt werden kann.

ABSCHNITTE

Abschnitte werden mit .SH begonnen, gefolgt vom Namen des Abschnittes. Falls der Name Leerzeichen beinhaltet, sollte er von doppelten Anführungszeichen eingeschlossen werden. Gebräuchliche Abschnittsnamen sind: NAME, ÜBERSICHT, BESCHREIBUNG, OPTIONEN, DATEIEN, SIEHE AUCH, DIAGNOSEN, BUGS und AUTOR. Der einzige benötigte Abschnitt ist NAME, der eine einzeilige Beschreibung des Programms sein sollte:

.SH NAME
.B chess \- ein Schachspiel

Es ist überaus wichtig, dass dieses Format eingehalten wird, und dass ein Backslash '\' vor dem Bindestrich nach dem Programmnamen steht. Dieses Format wird vom Programm makewhatis(8) benutzt, um eine Datenbank mit Kurzbeschreibungen der vorhandenen Kommandos aufzubauen, die dann mit den Kommandos whatis(1) und apropos(1) abgefragt werden können.

ANDERE MAKROS

Es gibt folgende weitere Makros:

.DT: Voreingestellte Tabulatoren
.HP: Beginn eines eingerückten Absatzes
.IP: Beginn eines eingerückten Absatzes mit vorangestelltem Titel. Ähnlich ist das Makro .TP, doch wird hier der Titel in der selben Zeile angegeben und nicht in der folgenden. Titel.
.LP: Äquivalent zu .PP
.PD: Setzt den Abstand zwischen zwei Absätzen auf den Wert des Arguments
.PP: Start eines neuen Absatzes
.RE: Ende eines eingerückten Absatzes
.RS: Beginn eines eingerückten Absatzes
.SS: Unterüberschriften (ähnlich wie .SH)
.TP: Beginn eines Absatzes mit einer Überschrift. Die Überschrift wird im Gegensatz zum Kommando .IP in der folgenden Zeile angegeben. Dies ermöglicht Anweisungen zum Schriftstil in der Überschrift.

DATEIEN

/usr/lib/groff/tmac/tmac.an
bzw.
/usr/share/groff/tmac/tmac.an
/usr/man/whatis

SIEHE AUCH

groff(1), man(1), whatis(1), apropos(1), makewhatis(8).

Index

BEZEICHNUNG
ÜBERSICHT
BESCHREIBUNG
PRÄAMBEL
SCHRIFTSÄTZE
ABSCHNITTE
ANDERE MAKROS
DATEIEN
SIEHE AUCH

This document was created by man2html using the manual pages.
Time: 23:24:30 GMT, July 09, 2008