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
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.10.
.TH HELP2MAN "1" "03.06.2012" "help2man 1.40.10" "Пользовательские команды"
.SH ИМЯ
help2man \- генерирует простую справочную страницу
.SH ОБЗОР
.B help2man
[\fIПАРАМЕТР\fR]... \fIИСПОЛНЯЕМЫЙ_ФАЙЛ\fR
.SH ОПИСАНИЕ
help2man генерирует справочную страницу исходя из результатов \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
ИСПОЛНЯЕМЫЙ_ФАЙЛ должен принимать параметры \fB\-\-help\fR и \fB\-\-version\fR и выдавать
результат в стандартный вывод, но можно указать альтернативные параметры:
.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
и
.BR \-\-opt\-include .
Формат прост:
[раздел]
текст
/шаблон/
текст
Блоки *roff текста вставляются в результат дословно или в
начало заданного
.BI [ раздела ]
(регистр неважен), или после параграфа, подходящего под
.BI / шаблон /\fR.
В шаблонах используется синтаксис регулярных выражений Perl, и они могут
указываться после модификаторов
.IR i ,
.I s
или
.I m
(см.
.BR perlre (1)).
Строки перед первым разделом или шаблоном, который начинается с «\-»
обрабатываются как параметры. Всё остальное просто игнорируется и может
быть использованы как комментарии, ключи RCS и т.д.
Порядок вывода разделов (для включённых):
ИМЯ
ОБЗОР
ОПИСАНИЕ
ПАРАМЕТРЫ
ОКРУЖЕНИЕ
ФАЙЛЫ
ПРИМЕРЫ
\fIдругой\fR
АВТОР
СООБЩЕНИЯ ОБ ОШИБКАХ
COPYRIGHT
СМОТРИТЕ ТАКЖЕ
Любые появляющиеся во включаемом файле разделы
.B [ИМЯ]
или
.B [ОБЗОР]
будут заменены на автоматически создаваемые
(хотя вы всё равно можете перезаписать первый
с помощью параметра
.B --name
).
Другие разделы добавляются к автоматически созданным
стандартным разделам, указанным ранее, или включаются на место
.I другого
(выше) в порядке, в котором они расположены во включаемом файле.
.SH ДОСТУПНОСТЬ
Последняя версия этого дистрибутива доступна под адресу:
ftp://ftp.gnu.org/gnu/help2man/
.SH АВТОР
Автор: Брэндон О'Ди (Brendan O'Dea) <bod@debian.org>
.SH "СООБЩЕНИЯ ОБ ОШИБКАХ"
Об ошибках сообщайте по адресу: <bug\-help2man@gnu.org>.
.SH COPYRIGHT
Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010,
2011, 2012 Free Software Foundation, Inc.
.br
Это свободное ПО; условия копирования см. в исходном коде.
Нет НИКАКИХ ГАРАНТИЙ; даже подразумеваемыми гарантиями
КОММЕРЧЕСКОЙ ЦЕННОСТИ и ПРИГОДНОСТИ ДЛЯ КОНКРЕТНОЙ ЦЕЛИ.
.SH "СМОТРИТЕ ТАКЖЕ"
Полная документация на
.B help2man
ведётся в справочнике Texinfo. Если программы
.B info
и
.B help2man
установлены, то по команде
.IP
.B info help2man
.PP
можно получить доступ к полному справочнику.
|
