summaryrefslogtreecommitdiff
path: root/help2man.pl.h2m
blob: 599a846cefc5d5d3d7ed9be63864fdc81742ae6c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
Encoding charset: ISO-8859-2
Language: Polish
Locale: pl_PL
Translator: Jakub Bogusz <qboosh@pld-linux.org>

Include file for Polish help2man man page

[nazwa]
help2man \- generowanie prostej strony podręcznika

[dołączane pliki]
Do generowanego pliku można dołączyć dodatkowy materiał przy pomocy
opcji
.B \-\-include
i
.B \-\-opt\-include
. Format jest prosty:

    [sekcja]
    tekst

    /wzorzec/
    tekst

Bloki sformatowanego tekstu *roff są wstawiane do wyjścia na początku
podanej
.BI [ sekcji ]
(bez rozróżniania wielkości liter) lub po akapicie pasującym do
.BI / wzorca /\fR.

Wzorce zapisuje się przy użyciu składni perlowych wyrażeń regularnych
i można je zakończyć modyfikatorami
.IR i ,
.I s
lub
.I m
(patrz
.BR 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
    \fIinne\fR
    AUTOR
    ZGŁASZANIE BŁĘDÓW
    COPYRIGHT
    ZOBACZ TAKŻE

Każda sekcja
.B [nazwa]
lib
.B [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
.B --name
).

Inne sekcje są dołączane do automatycznie generowanego wyjścia
w przypadku standardowych, wyżej wymienionych sekcji lub włączane
w miejscu
.I 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/