help2man является инструментом для автоматического создания простых ручных страницы из программного выхода. Он предназначен для обеспечения простой способ для программного обеспечения авторы включить ручной страницу в их распределении, не имея для поддержания этого документа.
Учитывая программу, которая производит стандартную resonably --help --version и выходы, help2man будет пытаться перестроить, что выход во что-то, который напоминает ручной страницу.
Вызов help2man
Формат запуска программы help2man является:
help2man [опция] ... исполняемый
help2man поддерживает следующие опции:
-n строка
--name = строка
Используйте строку в качестве описания для имени пункте ручного странице.
По умолчанию (за неимением лучшего) этот пункт содержит справочную страницу для версии программы.
Эта опция переопределяет включать файл [имя] раздел (см числе текста).
-s раздел
--section раздел
Используйте раздел как раздел для страницы человека. Раздел по умолчанию 1.
-m руководство
--manual = ручной
Установить имя вручную раздела к разделу, используемого в качестве центром заголовком для ручного странице. По умолчанию пользовательские команды используется для страницы в разделе 1, Игры для раздела 6 иsamp {Системное администрирование Utilities} для разделов 8 и 1M.
-S Источник
--source = источник
Источник программа используется в качестве нижнего колонтитула, и часто содержит название организации или набор которых программа является частью. По умолчанию значение имя пакета и версия.
-i файл
--include = файл
Включите материал из файла (см числе текста).
-Я Файл
--opt-файл включает =
Вариант --include для использования в Makefile правил шаблона, который не требует файл существует.
-o файл
--output = файл
Отправить вывод в файл, а не на стандартный вывод.
-N
--no-инфо
Подавить включение также пункт направляет читателя к документации Texinfo.
--Помогите
--версия
Показать помощь или информацию о версии.
По умолчанию help2man проходит стандартные --help --version и варианты к исполняемому хотя альтернативы могут быть указаны с помощью:
Опция -h
--help-вариант = опция
помощь строка опций
Опция -v
--version-вариант = опция
Версия вариант строка
Детали программы:
Версия: 1.36.4
Дата загрузки: 2 Jun 15
Тип распространения: Бесплатная
Популярность: 2
Комментарии не найдены