Provided by: manpages-de_0.5-2ubuntu1_all bug

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).