Posso criar uma página de manual para um script?

Question

Possível duplicata:
Como posso adicionar entradas de página de manual para minhas próprias ferramentas elétricas?

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

Answer 1

man 7 roffAs páginas de manual são documentos formatados em roff (consulte Recursos ).

• Você pode escrever à mão.
• Você pode usarhelp2manpara 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 para man:
  • a2x(deasciidocpacote) paraAsciiDoc
  • grutatxtparaGrutatxt
  • pod2man(deperlpacote) paraPOD
  • rst2man(dedocumentospacote) paraTexto reestruturado
  • txt2tagsparatxt2tags
  • Mantástico(um serviço web Heroku) paraRemarcação

Answer 2

Sim você pode. As páginas de manual são escritas comonroffarquivos.
O diretório /usr/local/man é o local normalmente usado para quaisquer pacotes/arquivos instalados localmente.
Você pode ver exemplos observando as páginas de manual existentes (que provavelmente precisarão ser descompactadas primeiro), leia tambémhomem.
Atualmente muitos usuários preferem groff a nroff, man groffpara começar