НАЗВА
help2man - програма для створення простих сторінок довідника
КОРОТКИЙ ОПИС
help2man [ПАРАМЕТР]... ВИКОНУВАНИЙ_ФАЙЛ
ОПИС
help2man
створює
сторінку
довідника
(man) на
основі
даних
виконання
програми
з
параметрами
--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»
з
виведенням
даних до stdout.
Ви можете
внести
зміни до
цих
типових
вимог за
допомогою
таких
параметрів:
-h,
--help-option=РЯДОК
рядок параметра виведення довідкових даних
-v, --version-option=РЯДОК
рядок параметра виведення даних щодо версії
--version-string=РЯДОК
рядок версії
--no-discard-stderr
використовувати дані зі stderr під час обробки виведених даних
ФАЙЛИ-ВКЛЮЧЕННЯ
Включити додаткові матеріали до створеної сторінки можна за допомогою параметрів --include та --opt-include Формат включених даних доволі простий:
[розділ]
текст
/шаблон/
текст
Блоки тексту *roff вставляються до виведених даних або на початку вказаного [розділу] (без врахування регістру), або після абзацу, що відповідає /шаблону/.
У шаблонах слід використовувати синтаксис формальних виразів за ними можна вказувати модифікатори i, s or m (див. perlre(1)).
Рядки перед першим розділом або шаблоном, які починаються з набору символів «-», вважаються визначеннями параметрів. Всі інші такі рядки буде проігноровано, ними можна скористатися для коментування, ключових слів RCS тощо.
Порядок виведення розділів (для включених розділів):
НАЗВА
КОРОТКИЙ
ОПИС
ОПИС
ПАРАМЕТРИ
інше
СЕРЕДОВИЩЕ
ФАЙЛИ
ПРИКЛАДИ
АВТОР
Як
надіслати
звіт про
вади
Авторські
права
ТАКОЖ
ПЕРЕГЛЯНЬТЕ
Будь-які розділи [НАЗВА] або [КОРОТКИЙ ОПИС] вказані у включеному файлі, замінять собою відповідні розділи, створені у автоматичному режимі. Ви можете зберегти перший з цих розділів за допомогою параметра --name якщо захочете.
Інші розділи буде додано перед автоматично створеними даними стандартних розділів, вказаних вище, або буде включено до іншого (вище) у порядку, у якому їх вказано у файлі-включенні.
Можна явним чином вимагати розташовування тексту у розділі за допомогою синтаксичної конструкції [<розділ], [=розділ] або [>розділ] для розташовування тексту перед, замість або після типових виведених даних, відповідно.
ДОСТУП ДО ПРОГРАМИ
Найсвіжішу версію цього пакунка можна знайти у інтернеті:
ftp://ftp.gnu.org/gnu/help2man/
Як надіслати звіт про вади
Про вади повідомляйте на адресу <bug-help2man [AT] gnu.org>.
© Free
Software Foundation, Inc., 1997, 1998, 1999, 2000, 2001,
2002, 2003, 2004, 2005, 2009, 2010, 2011, 2012, 2013, 2014,
2015, 2016, 2017, 2020, 2021, 2022
Це
програмне
забезпечення
є вільним,
умови
копіювання
викладено
у його
початкових
кодах.
Умовами
ліцензування
програми
НЕ
передбачено
жодних
гарантій,
зокрема
гарантій
працездатності
або
придатності
для
певної
мети.
Автором програми є Brendan O’Dea <bod [AT] debian.org>
ТАКОЖ ПЕРЕГЛЯНЬТЕ
Повноцінну документацію з help2man можна знайти у довіднику Texinfo. Якщо у вашій системі встановлено info та help2man за допомогою команди
info help2man
ви зможете отримати доступ до повноцінного підручника.