Linux Certif

Toute la documentation sur la certification Linux LPI

help2man

NAME

help2man - manual page for help2man 1.36

SYNOPSIS

help2man [OPTION]... EXECUTABLE

DESCRIPTION

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

-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

--help

print this help, then exit

--version

print version number, then exit

EXECUTABLE should accept `--help' and `--version' options 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

NAZWA

help2man - generowanie prostej strony podrêcznika

DO³±CZANE PLIKI

Do generowanego pliku mo¿na do³±czyæ dodatkowy materia³ przy pomocy opcji --include i --opt-include

    [sekcja]
    tekst

    /wzorzec/
    tekst

Bloki sformatowanego tekstu *roff s± wstawiane do wyj¶cia na pocz±tku podanej [sekcji] (bez rozró¿niania wielko¶ci liter) lub po akapicie pasuj±cym do /wzorca/.

Wzorce zapisuje siê przy u¿yciu sk³adni perlowych wyra¿eñ regularnych i mo¿na je zakoñczyæ modyfikatorami i, s lub m (patrz perlre(1)).

Linie przed pierwsz± sekcj± lub wzorzec zaczynaj±cy siê od `-' s± przetwarzane jako opcje. Ca³a reszta jest po cichu ignorowana i mo¿e byæ u¿ywana jako komentarze, s³owa kluczowe RCS itp.

Kolejno¶æ sekcji na wyj¶ciu to:

    NAZWA
    SK£ADNIA
    OPIS
    OPCJE
    PRZYK£ADY
    inne
    AUTOR
    ZG£ASZANIE B£ÊDÓW
    COPYRIGHT
    ZOBACZ TAK¯E

Ka¿da sekcja [nazwa] lib [sk³adnia] wystêpuj±ca w pliku do³±czanym zastêpuje to, co zosta³oby automatycznie wyprodukowane (aczkolwiek mo¿na w razie potrzeby obej¶æ to zachowanie przez --name ).

Inne sekcje s± do³±czane do automatycznie generowanego wyj¶cia w przypadku standardowych, wy¿ej wymienionych sekcji lub w³±czane w miejscu inne (jak wy¿ej) w kolejno¶ci, w jakiej wyst±pi³y w do³±czanym pliku.

DOSTêPNO¶æ

Najnowsza wersja tego oprogramowania jest dostêpna pod:

    ftp://ftp.gnu.org/gnu/help2man/

AUTHOR

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

REPORTING BUGS

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

COPYRIGHT

Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 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.

SEE ALSO

The full documentation for help2man is maintained as a Texinfo manual. If the info and help2man programs are properly installed at your site, the command

info help2man

should give you access to the complete manual.