crear archivos de manual

[Horst H. von Brand]

Rene Parrado <rene.parrado en gmail.com> wrote:
> Amigos, he realizado una pequeña aplicacion para mi oficina, para la
> cual desearia poner a disposicion un pequeño manual, que pueda ser
> accedido con la instruccion man de cualquier linux, mi pregunta es
> como puedo:
> 
> 1. hacer el archivo del manual, que herramienta se hace uso para esto?

El formato de los man usa el paquete man(7) de troff(1). Puedes escribirlo
con un editor de texto cualquiera. Si, es un parto hacerlo directamente.

La otra opcion es usar algo como asciidoc(1), que usa un markup muy simple
y que puede generar varios formatos de salida (entre ellos paginas de
manual). Revisa <http://www.methods.co.nz/asciidoc> para los escabrosos
detalles, y (obviamente) los manuales de tu distribucion.

> 2. como instalarlo en los equipos para que los usuarios puedan hacer
> uso de el (ej: man miaplicacion)

Debiera instalarse junto con la aplicacion. Revisa como otros paquetes
hacen eso en tu distribucion particular.

Generalmente basta copiar xyz.1.gz (comprimido con gzip(1)) a
/usr/share/man/man1, y correr makehwatis(8) (aunque esto generalmente se
corre igual en forma periodica). Ojo, eso es lo tipico en Linux (segun
FHS), pero podrian estar ocultos en otro lugar. Para verificar si el
archivo esta bien, generalmente less(1) esta configurado para mostrar eso
correctamente.  Prueba con algo como /usr/share/man/man1/ls.1.gz

Notese que en lo anterior el "1" es la seccion del manual (comandos de uso
comun), tal vez debiera ir en la seccion "l" (agregados locales).


Por favor, antes de hacer nada revisa _bien_ los manuales respectivos,
puedes dejar las cosas sumamente dan~adas si no sabes lo que haces (o lo
haces sin cuidado).
-- 
Dr. Horst H. von Brand                   User #22616 counter.li.org
Departamento de Informatica                    Fono: +56 32 2654431
Universidad Tecnica Federico Santa Maria             +56 32 2654239
Casilla 110-V, Valparaiso, Chile 2340000       Fax:  +56 32 2797513