help2man.ru.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.46.6.
   2 .TH HELP2MAN "1" "26.04.2015" "help2man 1.46.6" "Пользовательские команды"
   3 .SH ИМЯ
   4 help2man \- справочная страница для help2man 1.46.6
   5 .SH ОБЗОР
   6 .B help2man
   7 [\fI\,ПАРАМЕТР\/\fR]... \fI\,ИСПОЛНЯЕМЫЙ_ФАЙЛ\/\fR
   8 .SH ОПИСАНИЕ
   9 help2man генерирует справочную страницу исходя из результатов \fB\-\-help\fR и \fB\-\-version\fR.
  10 .TP
  11 \fB\-n\fR, \fB\-\-name\fR=\fI\,СТРОКА\/\fR
  12 описание для параграфа ИМЯ
  13 .TP
  14 \fB\-s\fR, \fB\-\-section\fR=\fI\,РАЗДЕЛ\/\fR
  15 номер раздела справочной страницы (1, 6, 8)
  16 .TP
  17 \fB\-m\fR, \fB\-\-manual\fR=\fI\,ТЕКСТ\/\fR
  18 имя справочника (Пользовательские команды, ...)
  19 .TP
  20 \fB\-S\fR, \fB\-\-source\fR=\fI\,ТЕКСТ\/\fR
  21 источник программы (FSF, Debian, ...)
  22 .TP
  23 \fB\-L\fR, \fB\-\-locale\fR=\fI\,СТРОКА\/\fR
  24 задать локаль (по умолчанию «C»)
  25 .TP
  26 \fB\-i\fR, \fB\-\-include\fR=\fI\,ФАЙЛ\/\fR
  27 включить материал из ФАЙЛА
  28 .TP
  29 \fB\-I\fR, \fB\-\-opt\-include\fR=\fI\,ФАЙЛ\/\fR
  30 включить материал из ФАЙЛА, если он есть
  31 .TP
  32 \fB\-o\fR, \fB\-\-output\fR=\fI\,ФАЙЛ\/\fR
  33 записать результат в ФАЙЛ
  34 .TP
  35 \fB\-p\fR, \fB\-\-info\-page\fR=\fI\,ТЕКСТ\/\fR
  36 имя справочника Texinfo
  37 .TP
  38 \fB\-N\fR, \fB\-\-no\-info\fR
  39 не выдавать указатель на справочник Texinfo
  40 .TP
  41 \fB\-l\fR, \fB\-\-libtool\fR
  42 исключить lt\- из имени программы
  43 .TP
  44 \fB\-\-help\fR
  45 показать эту справку и закончить работу
  46 .TP
  47 \fB\-\-version\fR
  48 показать номер версии и закончить работу
  49 .PP
  50 ИСПОЛНЯЕМЫЙ_ФАЙЛ должен принимать параметры \fB\-\-help\fR и \fB\-\-version\fR и выдавать
  51 результат в стандартный вывод, но можно указать альтернативные параметры:
  52 .TP
  53 \fB\-h\fR, \fB\-\-help\-option\fR=\fI\,СТРОКА\/\fR
  54 строка параметра для получения справки
  55 .TP
  56 \fB\-v\fR, \fB\-\-version\-option\fR=\fI\,СТРОКА\/\fR
  57 строка параметра для получения версии
  58 .TP
  59 \fB\-\-version\-string\fR=\fI\,СТРОКА\/\fR
  60 строка версии
  61 .TP
  62 \fB\-\-no\-discard\-stderr\fR
  63 анализировать stderr при разборе
  64 результатов параметра
  65 .SH "1428\0"
  66 help2man \- генерирует простую справочную страницу
  67 .SH "ВКЛЮЧЁННЫЕ ФАЙЛЫ"
  68 В генерируемый результат может быть включён дополнительный материал
  69 с помощью параметра
  70 .B \-\-include
  71 и
  72 .BR \-\-opt\-include .
  73 Формат прост:
  74
  75     [раздел]
  76     текст
  77
  78     /шаблон/
  79     текст
  80
  81 Блоки *roff текста вставляются в результат дословно или в
  82 начало заданного
  83 .BI [ раздела ]
  84 (регистр неважен), или после параграфа, подходящего под
  85 .BI / шаблон /\fR.
  86
  87 В шаблонах используется синтаксис регулярных выражений Perl, и они могут
  88 указываться после модификаторов
  89 .IR i ,
  90 .I s
  91 или
  92 .I m
  93 (см.
  94 .BR perlre (1)).
  95
  96 Строки перед первым разделом или шаблоном, который начинается с «\-»
  97 обрабатываются как параметры. Всё остальное просто игнорируется и может
  98 быть использованы как комментарии, ключи RCS и т.д.
  99
 100 Порядок вывода разделов (для включённых):
 101
 102     ИМЯ
 103     ОБЗОР
 104     ОПИСАНИЕ
 105     ПАРАМЕТРЫ
 106     ОКРУЖЕНИЕ
 107     ФАЙЛЫ
 108     ПРИМЕРЫ
 109     \fIдругой\fR
 110     АВТОР
 111     СООБЩЕНИЯ ОБ ОШИБКАХ
 112     COPYRIGHT
 113     СМОТРИТЕ ТАКЖЕ
 114
 115 Любые появляющиеся во включаемом файле разделы
 116 .B [ИМЯ]
 117 или
 118 .B [ОБЗОР]
 119 будут заменены на автоматически создаваемые
 120 (хотя вы всё равно можете перезаписать первый
 121 с помощью параметра
 122 .B \-\-name
 123 ).
 124
 125 Другие разделы добавляются к автоматически созданным
 126 стандартным разделам, указанным ранее, или включаются на место
 127 .I другого
 128 (выше) в порядке, в котором они расположены во включаемом файле.
 129
 130 Текст можно размещать внутри раздела с помощью:
 131 .RI [< раздел ],
 132 .RI [= раздел ]
 133 или
 134 .RI [> раздел ]
 135 (для размещения дополнительного текста перед, вместо или после
 136 вывода по умолчанию, соответственно).
 137 .SH ДОСТУПНОСТЬ
 138 Последняя версия этого дистрибутива доступна под адресу:
 139
 140     ftp://ftp.gnu.org/gnu/help2man/
 141 .SH АВТОР
 142 Автор: Брэндон О'Ди (Brendan O'Dea) <bod@debian.org>
 143 .SH "СООБЩЕНИЯ ОБ ОШИБКАХ"
 144 Об ошибках сообщайте по адресу: <bug\-help2man@gnu.org>.
 145 .SH COPYRIGHT
 146 Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010,
 147 2011, 2012, 2013, 2014, 2015 Free Software Foundation, Inc.
 148 .br
 149 Это свободное ПО; условия копирования см. в исходном коде.
 150 Нет НИКАКИХ ГАРАНТИЙ; даже подразумеваемыми гарантиями
 151 КОММЕРЧЕСКОЙ ЦЕННОСТИ и ПРИГОДНОСТИ ДЛЯ КОНКРЕТНОЙ ЦЕЛИ.
 152 .SH "СМОТРИТЕ ТАКЖЕ"
 153 Полная документация на
 154 .B help2man
 155 ведётся в справочнике Texinfo. Если программы
 156 .B info
 157 и
 158 .B help2man
 159 установлены, то по команде
 160 .IP
 161 .B info help2man
 162 .PP
 163 можно получить доступ к полному справочнику.