HELP2MAN
Section: Пользовательские команды (1)
Updated: 28.02.2018
Page Index
ИМЯ
help2man - генерирует простую справочную страницу
ОБЗОР
help2man
[
,ПАРАМЕТР/]...
,ИСПОЛНЯЕМЫЙ_ФАЙЛ/
ОПИСАНИЕ
help2man генерирует справочную страницу исходя из результатов
--help и
--version.
- -n, --name=,СТРОКА/
-
описание для параграфа ИМЯ
- -s, --section=,РАЗДЕЛ/
-
номер раздела справочной страницы (1, 6, 8)
- -m, --manual=,ТЕКСТ/
-
имя справочника (Пользовательские команды, ...)
- -S, --source=,ТЕКСТ/
-
источник программы (FSF, Debian, ...)
- -L, --locale=,СТРОКА/
-
задать локаль (по умолчанию «C»)
- -i, --include=,ФАЙЛ/
-
включить материал из ФАЙЛА
- -I, --opt-include=,ФАЙЛ/
-
включить материал из ФАЙЛА, если он есть
- -o, --output=,ФАЙЛ/
-
записать результат в ФАЙЛ
- -p, --info-page=,ТЕКСТ/
-
имя справочника Texinfo
- -N, --no-info
-
не выдавать указатель на справочник Texinfo
- -l, --libtool
-
исключить lt- из имени программы
- --help
-
показать эту справку и закончить работу
- --version
-
показать номер версии и закончить работу
ИСПОЛНЯЕМЫЙ_ФАЙЛ должен принимать параметры --help и --version и выдавать
результат в стандартный вывод, но можно указать альтернативные параметры:
- -h, --help-option=,СТРОКА/
-
строка параметра для получения справки
- -v, --version-option=,СТРОКА/
-
строка параметра для получения версии
- --version-string=,СТРОКА/
-
строка версии
- --no-discard-stderr
-
анализировать stderr при разборе
результатов параметра
ВКЛЮЧЁННЫЕ ФАЙЛЫ
В генерируемый результат может быть включён дополнительный материал
с помощью параметра
--include
и
--opt-include.
Формат прост:
[раздел]
текст
/шаблон/
текст
Блоки *roff текста вставляются в результат дословно или в
начало заданного
[раздела]
(регистр неважен), или после параграфа, подходящего под
/шаблон/.
В шаблонах используется синтаксис регулярных выражений Perl, и они могут
указываться после модификаторов
i,
s
или
m
(см.
perlre(1)).
Строки перед первым разделом или шаблоном, который начинается с «-»
обрабатываются как параметры. Всё остальное просто игнорируется и может
быть использованы как комментарии, ключи RCS и т.д.
Порядок вывода разделов (для включённых):
ИМЯ
ОБЗОР
ОПИСАНИЕ
ПАРАМЕТРЫ
ОКРУЖЕНИЕ
ФАЙЛЫ
ПРИМЕРЫ
другой
АВТОР
СООБЩЕНИЯ ОБ ОШИБКАХ
COPYRIGHT
СМОТРИТЕ ТАКЖЕ
Любые появляющиеся во включаемом файле разделы
[ИМЯ]
или
[ОБЗОР]
будут заменены на автоматически создаваемые
(хотя вы всё равно можете перезаписать первый
с помощью параметра
--name
).
Другие разделы добавляются к автоматически созданным
стандартным разделам, указанным ранее, или включаются на место
другого
(выше) в порядке, в котором они расположены во включаемом файле.
Текст можно размещать внутри раздела с помощью:
[<раздел],
[=раздел]
или
[>раздел]
(для размещения дополнительного текста перед, вместо или после
вывода по умолчанию, соответственно).
ДОСТУПНОСТЬ
Последняя версия этого дистрибутива доступна под адресу:
ftp://ftp.gnu.org/gnu/help2man/
АВТОР
Автор: Брэндон О'Ди (Brendan O'Dea) <
bod@debian.org>
СООБЩЕНИЯ ОБ ОШИБКАХ
Об ошибках сообщайте по адресу: <
bug-help2man@gnu.org>.
COPYRIGHT
Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017 Free Software Foundation, Inc.
Это свободное ПО; условия копирования см. в исходном коде.
Нет НИКАКИХ ГАРАНТИЙ; даже подразумеваемыми гарантиями
КОММЕРЧЕСКОЙ ЦЕННОСТИ и ПРИГОДНОСТИ ДЛЯ КОНКРЕТНОЙ ЦЕЛИ.
СМОТРИТЕ ТАКЖЕ
Полная документация на
help2man
ведётся в справочнике Texinfo. Если программы
info
и
help2man
установлены, то по команде
-
info help2man
можно получить доступ к полному справочнику.