Qual è il modo migliore per creare pagine man? Dovrei scrivere usando le macro man standard, oppure c'è un pacchetto intelligente ora disponibile che prende una sorta di sorgente XML-ified e può generare pagine man, HTML, ASCII e cosa no?Il modo migliore per creare pagine man?
Grazie
Per il mio programma atinout ho utilizzato ronn che consente di scrivere pagine man in un markdown molto, molto leggibile come la sintassi. Ne sono estremamente felice.
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.
...
Questo è davvero bello! – vy32
Sebbene, come si distribuisce uno script configure che esegue automaticamente "atinout'? – vy32
Intendi "... esegui automaticamente ronn"? Beh, io no. Sia atinout che cappello non ha uno script configure e anch'io distribuisco un premado atinout.1 in modo che ronn non sia una dipendenza hard build (solo se vuoi modificare la pagina man ne hai bisogno). – hlovdal
Doxygen è quello che stai cercando. Ricorda che è progettato per documentare il codice sorgente ma potresti facilmente adattarlo.
Può generare anche documentazione html, pdf e lattice.
Doxygen è un sistema potente, ma non mi è chiaro come ottengo l'emissione di pagine man simpatiche per le opzioni da riga di comando e così via. – vy32
Ya. Probabilmente hai bisogno di qualcos'altro. –
È possibile ottenere doxygen per l'output di pagine in formato uomo impostando GENERATE_MAN e quindi MAN-OUTPUT (per impostare la posizione dell'output) nel file di configurazione doxygen: http://www.doxygen.nl/config.html#cfg_man_output Come accennato in documenti, se si lascia vuoto il valore di output man, per impostazione predefinita metterà le pagine man sotto una sottodir denominata 'man'. – DEzra
Se si sta cercando di scrivere una volta e di generare diversi formati di output come manpage, HTML, txt semplice o anche PDF, quindi docbook dovrebbe funzionare meglio.
docbook non produce pagine man. Può ingerirli, ma non produrli. – vy32
Penso che shadow-utils lo usi con successo, qualcosa come "xsltproc -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/profile-docbook.xsl $ FILE" –
Ho già usato la versione GNU di nroff chiamata groff per scrivere pagine man.
articolo intro Nizza su di esso qui:
+1 anche se non è davvero lo strumento per * scriverli * tanto quanto formattarli. –
vero, buon punto :-) – DEzra
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. Può anche generare direttamente sia testo normale che HTML.
@ vy32: cosa hai finito per usare finalmente? – Lazer
Ho finito per farlo in nroff. – vy32