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