help2man.ru.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.3.
   2 .TH HELP2MAN "1" "31.03.2021" "GNU help2man 1.48.3" "Пользовательские команды"
   3 .SH ИМЯ
   4 help2man \- генерирует простую справочную страницу
   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 "ВКЛЮЧЁННЫЕ ФАЙЛЫ"
  66 В генерируемый результат может быть включён дополнительный материал
  67 с помощью параметра
  68 .B \-\-include
  69 и
  70 .BR \-\-opt\-include .
  71 Формат прост:
  72
  73     [раздел]
  74     текст
  75
  76     /шаблон/
  77     текст
  78
  79 Блоки *roff текста вставляются в результат дословно или в
  80 начало заданного
  81 .BI [ раздела ]
  82 (регистр неважен), или после параграфа, подходящего под
  83 .BI / шаблон /\fR.
  84
  85 В шаблонах используется синтаксис регулярных выражений Perl, и они могут
  86 указываться после модификаторов
  87 .IR i ,
  88 .I s
  89 или
  90 .I m
  91 (см.
  92 .BR perlre (1)).
  93
  94 Строки перед первым разделом или шаблоном, который начинается с «\-»
  95 обрабатываются как параметры. Всё остальное просто игнорируется и может
  96 быть использованы как комментарии, ключи RCS и т.д.
  97
  98 Порядок вывода разделов (для включённых):
  99
 100     ИМЯ
 101     ОБЗОР
 102     ОПИСАНИЕ
 103     ПАРАМЕТРЫ
 104     \fIдругой\fR
 105     ОКРУЖЕНИЕ
 106     ФАЙЛЫ
 107     ПРИМЕРЫ
 108     АВТОР
 109     СООБЩЕНИЯ ОБ ОШИБКАХ
 110     COPYRIGHT
 111     СМОТРИТЕ ТАКЖЕ
 112
 113 Любые появляющиеся во включаемом файле разделы
 114 .B [ИМЯ]
 115 или
 116 .B [ОБЗОР]
 117 будут заменены на автоматически создаваемые
 118 (хотя вы всё равно можете перезаписать первый
 119 с помощью параметра
 120 .B \-\-name
 121 ).
 122
 123 Другие разделы добавляются к автоматически созданным
 124 стандартным разделам, указанным ранее, или включаются на место
 125 .I другого
 126 (выше) в порядке, в котором они расположены во включаемом файле.
 127
 128 Текст можно размещать внутри раздела с помощью:
 129 .RI [< раздел ],
 130 .RI [= раздел ]
 131 или
 132 .RI [> раздел ]
 133 (для размещения дополнительного текста перед, вместо или после
 134 вывода по умолчанию, соответственно).
 135 .SH ДОСТУПНОСТЬ
 136 Последняя версия этого дистрибутива доступна под адресу:
 137
 138     ftp://ftp.gnu.org/gnu/help2man/
 139 .SH АВТОР
 140 Автор: Брэндон О'Ди (Brendan O'Dea) <bod@debian.org>
 141 .SH "СООБЩЕНИЯ ОБ ОШИБКАХ"
 142 Об ошибках сообщайте по адресу: <bug\-help2man@gnu.org>.
 143 .SH COPYRIGHT
 144 Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009,
 145 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2020, 2021 Free Software
 146 Foundation, Inc.
 147 .br
 148 Это свободное ПО; условия копирования см. в исходном коде.
 149 Нет НИКАКИХ ГАРАНТИЙ; даже подразумеваемыми гарантиями
 150 КОММЕРЧЕСКОЙ ЦЕННОСТИ и ПРИГОДНОСТИ ДЛЯ КОНКРЕТНОЙ ЦЕЛИ.
 151 .SH "СМОТРИТЕ ТАКЖЕ"
 152 Полная документация на
 153 .B help2man
 154 ведётся в справочнике Texinfo. Если программы
 155 .B info
 156 и
 157 .B help2man
 158 установлены, то по команде
 159 .IP
 160 .B info help2man
 161 .PP
 162 можно получить доступ к полному справочнику.