Il modo migliore per pagine Autore man?

Question

Qual è il modo migliore per le pagine man autore? Dovrei scrivere utilizzando le macro man standard, o c'è qualche pacchetto intelligente disponibile ora che prende una specie di origine e di destinazione può l'uomo pagine XML-ified, HTML, ASCII, e che cosa no?

Grazie

Answer 1

Per il mio programma atinout Sono stato con Ronn che consente di scrivere le pagine man in un markdown molto, molto leggibile come sintassi. Sono estremamente soddisfatto.

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

vedere l'intera pagina qui .

Answer 2

ho usato in precedenza la versione GNU di nroff chiamato groff alle pagine man di scrittura.

Nizza intro articolo su di esso qui:

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

Answer 3

Doxygen è quello che stai cercando. Tenete a mente che è stato progettato per il codice sorgente del documento, ma si potrebbe facilmente adattarsi.

Può generare HTML, PDF, e la documentazione lattice troppo.

Answer 4

Se siete alla ricerca a scrivere una sola volta e la generazione di diversi formati di output, come pagine di manuale, HTML, TXT pianura, o anche in formato PDF, quindi docbook dovrebbe funzionare meglio.

Answer 5

Uno strumento che viene comunemente utilizzato nella comunità Tcl è doctools che può produrre una ristretta (ma utile) sottoinsieme del formato man, adatto per il rendering con groff o nroff. Si può anche generare sia testo normale e HTML direttamente.