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
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.10.
.TH HELP2MAN "1" "03.06.12" "help2man 1.40.10" "Команди користувача"
.SH НАЗВА
help2man \— програма для створення простих сторінок довідника
.SH "КОРОТКИЙ ОПИС"
.B help2man
[\fIПАРАМЕТР\fR]... \fIВИКОНУВАНИЙ_ФАЙЛ\fR
.SH ОПИС
help2man створює сторінку довідника (man) на основі даних виконання програми з параметрами \fB\-\-help\fR та \fB\-\-version\fR.
.TP
\fB\-n\fR, \fB\-\-name\fR=\fIРЯДОК\fR
опис для розділу НАЗВА
.TP
\fB\-s\fR, \fB\-\-section\fR=\fIРОЗДІЛ\fR
номер розділу для сторінки довідника (1, 6, 8)
.TP
\fB\-m\fR, \fB\-\-manual\fR=\fIТЕКСТ\fR
назва довідника (Команди користувача...)
.TP
\fB\-S\fR, \fB\-\-source\fR=\fIТЕКСТ\fR
джерело програми (FSF, Debian, ...)
.TP
\fB\-L\fR, \fB\-\-locale\fR=\fIРЯДОК\fR
вибрати локаль (типове значення "C")
.TP
\fB\-i\fR, \fB\-\-include\fR=\fIФАЙЛ\fR
включити матеріали з ФАЙЛа
.TP
\fB\-I\fR, \fB\-\-opt\-include\fR=\fIФАЙЛ\fR
включити матеріали з ФАЙЛа, якщо такий існує
.TP
\fB\-o\fR, \fB\-\-output\fR=\fIФАЙЛ\fR
надіслати виведені дані до ФАЙЛа
.TP
\fB\-p\fR, \fB\-\-info\-page\fR=\fIТЕКСТ\fR
назва довідника Texinfo
.TP
\fB\-N\fR, \fB\-\-no\-info\fR
придушити посилання на підручник Texinfo
.TP
\fB\-l\fR, \fB\-\-libtool\fR
виключити «lt\-» з назви програми
.TP
\fB\-\-help\fR
показати ці довідкові дані, потім завершити роботу
.TP
\fB\-\-version\fR
показати дані щодо версії, потім завершити роботу
.PP
У ВИКОНУВАНОМУ_ФАЙЛІ має бути передбачено використання параметрів «\-\-help» та «\-\-version» з виведенням
даних до stdout. Ви можете внести зміни до цих типових вимог за допомогою таких параметрів:
.TP
\fB\-h\fR, \fB\-\-help\-option\fR=\fIРЯДОК\fR
рядок параметра виведення довідкових даних
.TP
\fB\-v\fR, \fB\-\-version\-option\fR=\fIРЯДОК\fR
рядок параметра виведення даних щодо версії
.TP
\fB\-\-version\-string\fR=\fIРЯДОК\fR
рядок версії
.TP
\fB\-\-no\-discard\-stderr\fR
використовувати дані зі stderr під час обробки виведених даних
.SH "ФАЙЛИ-ВКЛЮЧЕННЯ"
Включити додаткові матеріали до створеної сторінки можна за допомогою параметрів
.B \-\-include
та
.B \-\-opt\-include
Формат включених даних доволі простий:
[розділ]
текст
/шаблон/
текст
Блоки тексту *roff вставляються до виведених даних або на початку вказаного
.BI [ розділу ]
(без врахування регістру), або після абзацу, що відповідає
.BI / шаблону /\fR.
У шаблонах слід використовувати синтаксис формальних виразів
за ними можна вказувати модифікатори
.IR i ,
.I s
or
.I m
(див.
.BR perlre (1)).
Рядки перед першим розділом або шаблоном, які починаються з набору символів «\-»,
вважаються визначеннями параметрів. Всі інші такі рядки буде проігноровано,
ними можна скористатися для коментування, ключових слів RCS тощо.
Порядок виведення розділів (для включених розділів):
НАЗВА
КОРОТКИЙ ОПИС
ОПИС
ПАРАМЕТРИ
СЕРЕДОВИЩЕ
ФАЙЛИ
ПРИКЛАДИ
\fIінше\fR
АВТОР
Як надіслати звіт про вади
Авторські права
ТАКОЖ ПЕРЕГЛЯНЬТЕ
Будь-які розділи
.B [НАЗВА]
або
.B [КОРОТКИЙ ОПИС]
вказані у включеному файлі, замінять собою відповідні розділи,
створені у автоматичному режимі. Ви можете зберегти перший з цих
розділів за допомогою параметра
.B --name
якщо захочете.
Інші розділи буде додано перед автоматично створеними даними стандартних
розділів, вказаних вище, або буде включено до
.I іншого
(вище) у порядку, у якому їх вказано у файлі-включенні.
.SH "ДОСТУП ДО ПРОГРАМИ"
Найсвіжішу версію цього пакунка можна знайти у інтернеті:
ftp://ftp.gnu.org/gnu/help2man/
.SH "Як надіслати звіт про вади"
Про вади повідомляйте на адресу <bug\-help2man@gnu.org>.
.PP
© Free Software Foundation, Inc., 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, 2011, 2012
Це програмне забезпечення є вільним, умови копіювання викладено у його початкових кодах. Умовами ліцензування програми НЕ передбачено жодних гарантій, зокрема гарантій працездатності або придатності для певної мети.
.PP
Автором програми є Brendan O'Dea <bod@debian.org>
.SH "ТАКОЖ ПЕРЕГЛЯНЬТЕ"
Повноцінну документацію з
.B help2man
можна знайти у довіднику Texinfo. Якщо у вашій системі встановлено
.B info
та
.B help2man
за допомогою команди
.IP
.B info help2man
.PP
ви зможете отримати доступ до повноцінного підручника.
|
