Могу ли я создать страницу руководства для скрипта?

Question

Возможный дубликат:
Как добавить записи на страницу руководства для моих собственных электроинструментов?

Большинство (если не все) команд Linux имеют свои страницы руководства, в которых описываются параметры их использования и т. д. Могу ли я создать аналогичную страницу руководства для своих собственных скриптов bash?

Answer 1

Страницы руководства представляют собой man 7 roffдокументы в формате roff (см. ).

• Вы можете написать это от руки.
• Вы можете использоватьhelp2manчтобы сгенерировать его из выходных данных справки вашего скрипта.
• Вы можете написать его на языке разметки и использовать специальный инструмент для преобразования его в man:
  • a2x(изасцидокпакет) дляAsciiDoc
  • grutatxtдляGrutatxt
  • pod2man(изперлпакет) дляПОД
  • rst2man(изdocutilsпакет) дляреструктурированныйтекст
  • txt2tagsдляtxt2tags
  • Мантастик(веб-сервис Heroku) дляУценка

Answer 2

Да, можно. Страницы руководства написаны какнроффФайлы.
Каталог /usr/local/man — это место, которое обычно используется для любых локально установленных пакетов/файлов.
Вы можете посмотреть примеры, просмотрев существующие страницы руководства (которые, скорее всего, нужно будет сначала распаковать), также прочитайтемужчина.
В настоящее время многие пользователи предпочитают groff nroff, man groffчтобы начать