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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.2.
.TH HELP2MAN "1" "kwietnia 2022" "GNU help2man 1.49.2" "Polecenia użytkownika"
.SH NAZWA
help2man \- generowanie prostej strony podręcznika
.SH SKŁADNIA
.B help2man
[\fI\,OPCJA\/\fR]... \fI\,PROGRAM\/\fR
.SH OPIS
`help2man' generuje stronę podręcznika z wyjścia `\-\-help' i `\-\-version'.
.TP
\fB\-n\fR, \fB\-\-name\fR=\fI\,ŁAŃCUCH\/\fR
opis akapitu NAZWA
.TP
\fB\-s\fR, \fB\-\-section\fR=\fI\,SEKCJA\/\fR
numer sekcji dla strony podręcznika (1, 6, 8)
.TP
\fB\-m\fR, \fB\-\-manual\fR=\fI\,TEKST\/\fR
nazwa podręcznika (Polecenia użytkownika, ...)
.TP
\fB\-S\fR, \fB\-\-source\fR=\fI\,TEKST\/\fR
pochodzenie programu (FSF, Debian, ...)
.TP
\fB\-L\fR, \fB\-\-locale\fR=\fI\,ŁAŃCUCH\/\fR
ustawienie lokalizacji (domyślnie "C")
.TP
\fB\-i\fR, \fB\-\-include\fR=\fI\,PLIK\/\fR
dołączenie materiału z `PLIKU'
.TP
\fB\-I\fR, \fB\-\-opt\-include\fR=\fI\,PLIK\/\fR
dołączenie materiału z `PLIKU', jeśli takowy istnieje
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,PLIK\/\fR
zapisanie wyjścia do `PLIKU'
.TP
\fB\-p\fR, \fB\-\-info\-page\fR=\fI\,TEKST\/\fR
nazwa podręcznika Texinfo
.TP
\fB\-N\fR, \fB\-\-no\-info\fR
pominięcie wskazania do podręcznika Texinfo
.TP
\fB\-l\fR, \fB\-\-libtool\fR
pominięcie `lt\-' z nazwy programu
.TP
\fB\-\-help\fR
wyświetlenie tego opisu i zakończenie pracy
.TP
\fB\-\-version\fR
wyświetlenie numeru wersji i zakończenie pracy
.PP
PROGRAM powinien przyjmować opcje `\-\-help' oraz `\-\-version' i wypisywać
informacje na standardowe wyjście, aczkolwiek można podać alternatywne
sposoby działania przy pomocy:
.TP
\fB\-h\fR, \fB\-\-help\-option\fR=\fI\,ŁAŃCUCH\/\fR
łańcuch opcji pomocy
.TP
\fB\-v\fR, \fB\-\-version\-option\fR=\fI\,ŁAŃCUCH\/\fR
łańcuch opcji wersji
.TP
\fB\-\-version\-string\fR=\fI\,ŁAŃCUCH\/\fR
łańcuch wersji
.TP
\fB\-\-no\-discard\-stderr\fR
dołączenie stderr przy analizie wyjścia
.SH "DOŁĄCZANE PLIKI"
Do generowanego pliku można dołączyć dodatkowy materiał przy pomocy
opcji
.B \-\-include
i
.BR \-\-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
\fIinne\fR
ŚRODOWISKO
PLIKI
PRZYKŁADY
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.
Umieszczenie tekstu wewnątrz sekcji może być explicite wymuszone poprzez
użycie składni:
.RI [< sekcja ],
.RI [= sekcja ]
lub
.RI [> sekcja ]
w celu umieszczenia dodatkowego tekstu odpowiednio przed, zamiast lub za
domyślnym wyjściem.
.SH DOSTĘPNOŚĆ
Najnowsza wersja tego oprogramowania jest dostępna pod:
ftp://ftp.gnu.org/gnu/help2man/
.SH AUTOR
Program napisał Brendan O'Dea <bod@debian.org>
.SH "ZGŁASZANIE BŁĘDÓW"
Błędy prosimy zgłaszać na adres <bug\-help2man@gnu.org>.
.SH COPYRIGHT
Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009,
2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2020, 2021, 2022 Free Software
Foundation, Inc.
.br
Ten program jest wolnodostępny; 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.
.SH "ZOBACZ TAKŻE"
Pełna dokumentacja dla programu
.B help2man
jest utrzymywana jako podręcznik Texinfo. Jeśli programy
.B info
oraz
.B help2man
są właściwie zainstalowane, polecenie
.IP
.B info help2man
.PP
powinno udostępnić kompletny podręcznik.
|
