HELP2MAN(1)

NAME
help2man - generiert eine einfache Handbuchseite

BESCHREIBUNG
`help2man' generates a man page out of `--help' and `--version' output.

Usage: help2man [OPTION]... EXECUTABLE

-n, --name=STRING
    description for the NAME paragraph

-s, --section=SECTION
    section number for manual page (1, 6, 8)

-m, --manual=TEXT
    name of manual (User Commands, ...)

-S, --source=TEXT
    source of program (FSF, Debian, ...)

-L, --locale=STRING
    select locale (default "C")

-i, --include=FILE
    include material from `FILE'

-I, --opt-include=FILE
    include material from `FILE' if it exists

-o, --output=FILE
    send output to `FILE'

-p, --info-page=TEXT
    name of Texinfo manual

-N, --no-info
    suppress pointer to Texinfo manual

-l, --libtool
    exclude the `lt-' from the program name

--help
    print this help, then exit

--version
    print version number, then exit

EXECUTABLE should accept `--help' and `--version' options and produce output on stdout although alternatives may be specified using:

-h, --help-option=STRING
    help option string

-v, --version-option=STRING
    version option string

--version-string=STRING
    version string

--no-discard-stderr
    include stderr when parsing option output

Report bugs to <bug-help2man@gnu.org>.

DATEIEN ZUM EINFÜGEN
Zusätzliches Material kann in die generierte Ausgabe mit den --include und --opt-include Optionen eingefügt werden. Das Format ist einfach:
    [Abschnitt]
    Text
    /Muster/
    Text Blöcke aus wörtlichem *roff-Text werden entweder beim Start durch Angabe von [Abschnitt] (unabhängig von Groß-/Kleinschreibung) in die Ausgabe eingefügt oder nach einen passenden Absatz /Muster/. Muster benutzen die Syntax von regulären Perl-Ausdrücken und können von i, s oder m Bestimmungswörtern gefolgt sein (siehe perlre(1)). Zeilen vor dem ersten Abschnitt oder Muster, die mit »-« beginnen, werden als Optionen behandelt. Alles andere wird stillschweigend ignoriert und könnte für Kommentare, RCS-Schlüsselwörter oder was Sie wollen benutzt werden. Die Reihenfolge in der die Abschnitte ausgegeben werden, ist:
    NAME
    ÜBERSICHT
    BESCHREIBUNG
    OPTIONEN
    ENVIRONMENT
    FILES
    BEISPIELE
    andere
    AUTOR
    FEHLERBERICHTE
    COPYRIGHT
    SIEHE AUCH Jeder [NAME] oder [ÜBERSICHT] -Abschnitt, der in der eingefügten Datei erscheint, wird das ersetzen, was automatisch generiert würde (obwohl Sie das weitere immer noch, wenn nötigt, mit --name überschreiben können). Andere Abschnitte werden der automatisch erzeugten Ausgabe für die oben angegebenen Standardabschnitte vorangestellt oder unter andere (oben) in der Reihenfolge, in der sie in der eingefügten Datei vorgefunden werden, eingefügt.

VERFÜGBARKEIT
Die neuste Version dieser Distribution ist Online erhältlich von:
    ftp://ftp.gnu.org/gnu/help2man/

COPYRIGHT
Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, 2011 Free Software Foundation, Inc. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Written by Brendan O'Dea <bod@debian.org>

SIEHE AUCH
Die vollständige Dokumentation für help2man wird als ein Texinfo-Handbuch verwaltet. Wenn die info und help2man Programme ordentlich auf Ihrem Rechner installiert sind, kann Ihnen der Befehl

    info help2man

Zugriff auf das komplette Handbuch geben.