¿Cuál es la mejor manera de crear páginas man? ¿Debo escribir usando las macros estándar del hombre, o hay algún paquete listo disponible ahora que tome algún tipo de fuente XML-ified y pueda generar páginas man, HTML, ASCII, y qué no?¿La mejor manera de crear páginas man?
Gracias
Para mi programa atinout He estado usando ronn que le permite escribir páginas de manual en un formato muy, muy legible como la sintaxis. Estoy extremadamente feliz con ello.
atinout(1) -- Send AT commands to modem, capturing the response
===============================================================
## SYNOPSIS
`atinout` <input_file>|`-` <modem_device> <output_file>|`-`<br>
`atinout` `--version`<br>
`atinout` `--usage`<br>
`atinout` `--help`<br>
## DESCRIPTION
**Atinout** reads a list of AT commands. It sends those commands one by one
to the modem, waiting for the final result code for the
currently running command before continuing with the next command in
the list. The output from the commands is saved.
...
¡Eso es genial! – vy32
Aunque, ¿cómo se distribuye un script de configuración que ejecuta automáticamente 'atinout'? – vy32
¿Quiere decir "... automáticamente ejecuta ronn"? Bueno, yo no. Ambos sombreados no tienen una secuencia de comandos de configuración y también distribuyo una entrada preestablecida como entrada.1 para que Ronn no sea una dependencia de compilación sólida (solo si quieres modificar la página de manual si la necesitas). – hlovdal
Doxygen es lo que busca. Tenga en cuenta que está diseñado para documentar el código fuente, pero puede adaptarlo fácilmente.
También puede generar documentación html, pdf y latex.
Doxygen es un sistema poderoso, pero no tengo claro cómo puedo emitir buenas páginas de comando para opciones de línea de comandos y cosas así. – vy32
Ya. Probablemente necesites algo más. –
Puede hacer que doxygen genere páginas formateadas por el hombre configurando GENERATE_MAN y luego opcionalmente MAN-OUTPUT (para establecer la ubicación de la salida) en el archivo de configuración doxygen: http://www.doxygen.nl/config.html#cfg_man_output Como se menciona en los documentos, si deja en blanco el valor de salida del hombre, se colocarán las páginas man en un subdirectorio denominado 'man' – DEzra
Si está buscando escribir una vez y generar diferentes formatos de salida como páginas de manual, HTML, texto plano o incluso PDF, entonces docbook debería funcionar mejor.
docbook no genera páginas man. Puede ingerirlos, pero no producirlos. – vy32
Creo que shadow-utils lo usa con éxito, algo así como "xsltproc -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/profile-docbook.xsl $ FILE" –
He utilizado anteriormente la versión GNU de nroff llamada groff para escribir páginas man.
Interesante artículo de introducción en él aquí:
+1 aunque no es realmente la herramienta para * escribir * tanto como formatearlos. –
verdadero, buen punto :-) – DEzra
Una herramienta que se utiliza comúnmente en la comunidad Tcl es doctools que puede producir un subconjunto restringido (pero útil) del formato de página de manual, adecuado para la representación con groff o nroff. También puede generar texto sin formato y HTML directamente.
@ vy32: ¿qué terminaste usando finalmente? – Lazer
Terminé haciéndolo en nroff. – vy32