¿Puedo crear una página de manual para un script?

Question

Posible duplicado:
¿Cómo puedo agregar entradas de la página de manual para mis propias herramientas eléctricas?

La mayoría (si no todos) los comandos de Linux tienen sus páginas de manual que describen sus opciones de uso, etc. ¿Puedo crear una página de manual similar para mis propios scripts de bash?

Answer 1

Las páginas de manual son documentos con formato roff (ver man 7 roff).

• Puedes escribirlo a mano.
• Puedes usarhelp2manpara generarlo a partir de la salida de ayuda de su script.
• Puedes escribirlo en un lenguaje de marcado y usar una herramienta dedicada para convertirlo a man:
  • a2x(desde elasciidocpaquete) paraAsciiDoc
  • grutatxtparaGrutatxt
  • pod2man(desde elperlapaquete) paraVAINA
  • rst2man(desde eldocumentospaquete) paratexto reestructurado
  • txt2tagsparatxt2etiquetas
  • mantastic(un servicio web de Heroku) paraReducción

Answer 2

Sí tu puedes. Las páginas de manual están escritas comonroffarchivos.
El directorio /usr/local/man es la ubicación que normalmente se utiliza para cualquier paquete/archivo instalado localmente.
Puede ver ejemplos consultando las páginas de manual existentes (que probablemente deberán descomprimirse primero), lea tambiénhombre.
Actualmente, muchos usuarios prefieren groff a nroff man groffpara empezar .