Pregunta

¿Cuál es la mejor forma de páginas de autor por el hombre? ¿Debo escribir usando las macros de man estándar, o hay algún paquete inteligente disponible ahora que lleva algún tipo de páginas man de origen y salida lata XML-ified, HTML, ASCII, y lo que no?

Gracias

¿Fue útil?

Solución

Para mi programa atinout He estado usando Ronn que le permite escribir páginas de manual en una reducción del precio muy, muy fácil de leer como sintaxis. Estoy muy contento con él.

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.
...

ver la página completa aquí .

Otros consejos

He utilizado previamente la versión GNU de nroff llamada Groff a las páginas de manual de escritura.

Niza introducción artículo sobre ello aquí:

http://www.linuxjournal.com/article/1158

Doxygen es lo que busca. Tenga en cuenta que está diseñado para el código fuente del documento, pero que podría fácilmente adaptarse a él.

Puede generar HTML, PDF, y la documentación de látex también.

Si usted está buscando en la escritura de una vez y la generación de diferentes formatos de salida tales como páginas de manual, HTML, TXT normal, o incluso PDF, a continuación, docbook debería funcionar mejor.

Una herramienta que se utiliza comúnmente en la comunidad Tcl es doctools que puede producir un restringida (pero útil) subconjunto del formato de página de manual, adecuados para hacer con groff o nroff. También puede generar tanto en texto plano y HTML directamente.

Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top