Creazione di una man page sotto Linux: differenze tra le versioni

Da Slacky.eu.
(Avvertenza)
(Introduzione)
(Nessuna differenza)

Versione delle 13:49, 14 ott 2006

Sommario

Una pagina di manuale detta « man » è l'elemento indispensabile di un programma. In effetti, essa fornisce le informazioni essenziali riguardo l'uso di un programma e necessita poco spazio sul disco. questo articolo vi permetterà di realizzare la votra pagina di manuale molto velocemente.

Avvertenza

Questo articolo non è destinato a spiegarvi l'uso di ogni macro macro, per maggiori informazioni,consultare la pagina di manuale denomminata groff_man(7)

Introduzione

Un buon programma è sempre munito di una documentazione. in effetti il manuale è l'elemento essenziale e indispensabile per l'utente finale. Imaginate la prima reazione di un utente se quello si trova nell'incapacita di capirne il funczionnamento !!! Scrivere un manuale d'uso, è semplice, occupa pochissimo spazio, possibilità di converzione nei formati correnti. Iniziamo questo How-To con la presentazione di una pagina di manuale " man page".

Presentazione

Le rubriche

Le macro

Il comando groff

Lo script nroff

Il comando man2html

Esempio pratico

Stesura del manuale

Risultato finale

Conversione in formati diversi

Bibliografia

Conclusione

Glossario