Table of Contents
help2man - generowanie prostej strony podręcznika
help2man
[OPCJA]... PROGRAM
‘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 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.
Najnowsza wersja tego oprogramowania jest dostępna
pod:
ftp://ftp.gnu.org/gnu/help2man/
Program napisał Brendan O’Dea <bod@debian.org>
Błędy
proszę zgłaszać na adres <bug-help2man@gnu.org>.
Copyright © 1997, 1998,
1999, 2000, 2001, 2002, 2003, 2004 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.
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.
Table of Contents