kmx git

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.41.2.
.TH HELP2MAN "1" "14.04.2013" "help2man 1.41.2" "Пользовательские команды"
.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
можно получить доступ к полному справочнику.
gnu/help2man/help2man.ru.1

Commit

help2man.ru.1
