Posso criar uma página man para um script? [duplicado]

Question

A maioria dos comandos Linux (se não todos) tem suas páginas man, que descrevem suas opções de uso, etc. Posso criar uma página man similar para meus próprios scripts bash?

    

Answer 1

As páginas man são roff (veja man 7 roff ) documentos formatados.

• Você pode escrever à mão.
• Você pode usar help2man para gerá-lo a partir da saída de ajuda do seu script.
• Você pode escrevê-lo em uma linguagem de marcação e usar uma ferramenta dedicada para convertê-lo em man:
  • a2x (do pacote asciidoc ) para AsciiDoc
  • grutatxt para Grutatxt
  • pod2man (do pacote perl ) para o POD
  • rst2man (do pacote docutils ) para reStructuredText
  • txt2tags para txt2tags
  • Mantastic (um serviço da web Heroku) para Markdown

Answer 2

Sim, você pode. As man pages são escritas como arquivos nroff .
O diretório / usr / local / man é o local normalmente usado para quaisquer pacotes / arquivos instalados localmente.
Você pode examinar exemplos observando as páginas de manual existentes (que provavelmente precisarão ser descompactadas primeiro), e também leia man

Atualmente muitos usuários preferem groff para nroff, man groff para começar