Linux Certif

Toute la documentation sur la certification Linux LPI

help2man

NAZWA

help2man - generowanie prostej strony podrêcznika

SK£ADNIA

help2man [OPCJA]... PROGRAM

OPIS

`help2man' generuje stronê podrêcznika z wyj¶cia `--help' i `--version'.

-n, --name=£AÑCUCH

opis akapitu NAZWA

-s, --section=SEKCJA

numer sekcji dla strony podrêcznika (1, 6, 8)

-m, --manual=TEKST

nazwa podrêcznika (Polecenia u¿ytkownika, ...)

-S, --source=TEKST

pochodzenie programu (FSF, Debian, ...)

-L, --locale=£AÑCUCH

ustawienie lokalizacji (domy¶lnie "C")

-i, --include=PLIK

do³±czenie materia³u z `PLIKU'

-I, --opt-include=PLIK

do³±czenie materia³u z `PLIKU', je¶li takowy istnieje

-o, --output=PLIK

zapisanie wyj¶cia do `PLIKU'

-p, --info-page=TEKST

nazwa podrêcznika Texinfo

-N, --no-info

pominiêcie wskazania do podrêcznika Texinfo

--help

wy¶wietlenie tego opisu i zakoñczenie pracy

--version

wy¶wietlenie numeru wersji i zakoñczenie pracy

PROGRAM powinien przyjmowaæ opcje `--help' i `--version', aczkolwiek mo¿na podaæ alternatywne nazwy opcji przy pomocy:

-h, --help-option=£AÑCUCH

³añcuch opcji pomocy

-v, --version-option=£AÑCUCH

³añcuch opcji wersji

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/

AUTOR

Program napisa³ Brendan O'Dea <bod@debian.org>

ZG£ASZANIE B£ÊDÓW

B³êdy proszê zg³aszaæ na adres <bug-help2man@gnu.org>.

COPYRIGHT

Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
Ten program jest darmowy; warunki kopiowania s± opisane w Œród³ach. Autorzy nie daj± ¯ADNYCH gwarancji, w tym równie¿ gwarancji PRZYDATNOŠCI DO SPRZEDA¯Y LUB DO KONKRETNYCH CELÓW.

ZOBACZ TAK¯E

Pe³na dokumentacja dla programu help2man jest utrzymywana jako podrêcznik Texinfo. Je¶li programy info oraz help2man s± w³a¶ciwie zainstalowane, polecenie

info help2man

powinno udostêpniæ kompletny podrêcznik.