.\" Copyright 1992 Rickard E. Faith (faith@cs.unc.edu)
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\" 
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\" 
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" Modified Sun Jul 25 11:06:05 1993 by Rik Faith (faith@cs.unc.edu)
.\" German translation  Rene Tschirley (gremlin@cs.tu-berlin.de)
.\"
.TH MAN 7 "7. Juni 1996" "Linux" "Verschiedenes"
.SH BEZEICHNUNG
man \- Makros zum Formtieren
.SH "ÜBERSICHT"
.B groff \-Tascii \-man
.I datei
\&...
.LP
.B groff \-Tps \-man
.I datei
\&...
.LP
.B man
.RI [ abschnitt ]
.I titel
.SH BESCHREIBUNG
Diese Manualseite beschreibt das
.B "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 
.B groff
durch die Benutzung der Option
.B \-mdoc
anstelle der Option
.B \-man
benutzt werden können.  Es wird die Benutzung der Option
.B \-mandoc
empfohlen, da hiermit automatisch erkannt wird, welches
Makropaket benutzt wird.
.SH "PRÄAMBEL"
Das erste Kommando einer Manpage sollte
.RS
.sp
.B \&.TH
.IR "Titel Abschnitt Datum Quelle Handbuch"
.sp
.RE
sein, wobei gilt:
.RS
.TP 0.8i
.I Titel
Der Titel der Manpage (z.B.
.IR MAN ).
.TP
.I Abschnitt

Die Kapitelnummer, der die Manpage zugeordnet werden soll (z.B.
.IR 7 ).
.TP
.I Datum
Das Datum der letzten Revision \(em vergessen Sie nicht, dies immer bei
einer inhaltlichen Änderung der Manpage zu ändern, da dies die übliche
Methode einer Versionskontrolle ist.
.TP
.I Quelle
Die Quelle des Kommandos.
.sp
Für Binärdateien benutzen Sie entsprechendes wie
.IR GNU ", " NET-2 ", " "SLS Distribution" ", " "MCC Distribution" .
.sp
Für System Calls benutzen Sie die Versionsnummer des betrachteten
Kernels: 
.IR "Linux 0.99.11" .
.sp
Für Library Calls benutzen Sie die Quelle der Funktion selbst:
.IR GNU ", " "BSD 4.3" ", " "Linux DLL 4.4.1" .
.TP
.I Handbuch
Der Titel des gesamten Handbuches (z.B.
.IR "Bibliotheksfunktionen" ).
.RE
.PP
Die traditionellen Handbuchabschnitte sind:
.RS
.TP 0.8i
.B 1 Kommandos
Die Kommandos, die vom Benutzer aus einer Shell heraus ausgeführt
werden können.
.TP
.B 2 System Calls
Funktionen, die vom Kernel selbst für den Aufrufenden ausgeführt werden.
.TP
.B 3 Library Calls
Der Großteil der Funktionen der Library
.IR libc , 
so wie
.BR sort (3))
.TP
.B 4 Spezialdateien
Dateien, die in 
.IR /dev )
zu finden sind.
.TP
.B 5 Dateiformate und Konventionen
Formate von menschenlesbaren Dateien wie
.I /etc/passwd .
.TP
.B 6 Spiele
.TP
.B 7 Makropakete und Konventionen
Eine Beschreibung des standardmäßigen Layouts des Dateisystems, diese
Manpage und ähnliche Dinge.
.TP
.B 8 System Management Kommandos
Kommandos wie
.BR mount (8),
die nur durch den 
.I Superuser
ausführbar sind.
.TP
.B 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.
.RE
.SH 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:
.IP
Bei Funktionen werden die Argumente stets als kursiv definiert,
.IR "ebenso wie im Abschnitt ÜBERSICHT" ,
alles andere der Funktion wird im Halbfettdruck dargestellt:
.RS
.BI "int myfunction(int " argc ", char **" argv );
.RE
.IP
Die Umsetzung der Anweisungen kann bei verschiedenen Textprozessoren
abweichen, wenn bestimmte Darstellungsarten wie
.IR "kursiv"
nicht im angegebenen Zeichensteuervorrat enthalten sind.  Es kann dann
zu falschen Umsetzungen wie Unterstrichen oder Halbfettdruck anstelle
von kursiv kommen.
.IP
Dateinamen sind stets kursiv angegeben (z.B.
.IR "/usr/include/stdio.h" ),
ausgenommen im Abschnitt ÜBERSICHT, wo eingebundene Dateinamen im
Halbfettdruck (z.B.
.BR "#include <stdio.h>" ).
dargestellt werden.
.IP
Spezielle Makros, üblicherweise in Großbuchstaben, sind im
Halbfettdruck dargestellt, wie beispielsweise
.BR MAXINT ).
.IP
Bei Auflistungen von Fehlercodes werden auch die Codes halbfett
dargestellt (diese Liste benutzt üblicherweise das Makro
.B \&.TP
).
.IP
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 
.BR man (7).

Die Kommandos, mit denen das Aussehen der Schrift angegeben wird, sind:
.TP 0.8i
.B \&.B
Halbfettdruck
.TP
.B \&.BI
halbfett, abwechselnd mit kursiv
.TP
.B \&.BR
halbfett, abwechselnd mit Schrifttyp Roman
.TP
.B \&.I
kursiv
.TP
.B \&.IB
kursiv, abwechselnd mit halbfett
.TP
.B \&.IR
kursiv, abwechselnd mit Schrifttyp Roman
.TP
.B \&.RB
Roman, abwechselnd mit halbfett
.TP
.B \&.RI
Roman, abwechselnd mit kursiv
.TP
.B \&.SB
klein, abwechselnd mit halbfett
.TP
.B \&.SM
klein
.LP
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
.B \&.BR
ein Wort im Halbfettdruck, gefolgt von einem Wort in der
Schrift Roman, gefolgt von einem Wort im Halbfettdruck
usw. dargestellt werden kann.
.SH ABSCHNITTE
Abschnitte werden mit
.B \&.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
.IR NAME ,
der eine einzeilige Beschreibung des Programms sein sollte:
.RS
.sp
\&.SH NAME
.br
\&.B chess \\- ein Schachspiel
.sp
.RE
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
.BR makewhatis (8)
benutzt, um eine Datenbank mit Kurzbeschreibungen der vorhandenen
Kommandos aufzubauen, die dann mit den Kommandos 
.BR whatis (1)
und
.BR apropos (1)
abgefragt werden können.
.SH "ANDERE MAKROS"
Es gibt folgende weitere Makros:
.TP
.B \&.DT
Voreingestellte Tabulatoren
.TP
.B \&.HP
Beginn eines eingerückten Absatzes
.TP
.B \&.IP
Beginn eines eingerückten Absatzes mit vorangestelltem Titel.  Ähnlich
ist das Makro
.BR \&.TP ,
doch wird hier der Titel in der selben Zeile angegeben und nicht in
der folgenden.
Titel.
.TP
.B \&.LP
Äquivalent zu
.B \&.PP
.TP
.B \&.PD
Setzt den Abstand zwischen zwei Absätzen auf den Wert des Arguments
.TP
.B \&.PP
Start eines neuen Absatzes
.TP
.B \&.RE
Ende eines eingerückten Absatzes
.TP
.B \&.RS
Beginn eines eingerückten Absatzes
.TP
.B \&.SS
Unterüberschriften (ähnlich wie
.BR \&.SH )
.TP
.B \&.TP
Beginn eines Absatzes mit einer Überschrift.  Die Überschrift wird im
Gegensatz zum Kommando
.B \&.IP
in der folgenden Zeile angegeben.  Dies ermöglicht Anweisungen zum
Schriftstil in der Überschrift.
.LP
.SH DATEIEN
.I /usr/lib/groff/tmac/tmac.an
.br
bzw.
.br
.I /usr/share/groff/tmac/tmac.an
.br
.I /usr/man/whatis
.SH "SIEHE AUCH"
.BR groff (1),
.BR man (1),
.BR whatis (1),
.BR apropos (1),
.BR makewhatis (8).