Linux Man Page Howto

Jens Schweikhardt

howto@schweikhardt.net

Pradeep Padala - Conversion from HTML to DocBook v4.1.

v0.1, 2002-09-07

Diario delle revisioni
Revisione 0.12002-09-07Corretto da: ppadala
Conversion from HTML to Docbook v4.1

$Id: Man-Page.sgml,v 1.2 2002/12/15 17:51:43 schweikh Exp schweikh $

[Traduzione di Fabio Teatini - teafab @ pluto.linux.it] Questo HOWTO descrive ciò che bisogna sapere per scrivere la documentazione in linea (cioè le cosiddette pagine man o pagine di manuale) e per renderla accessibile tramite il comando man(1). Lungo tutto questo HOWTO useremo il termine "manuale" riferendoci semplicemente alle pagine man, senza indulgere in doppi sensi di carattere sessuale.

Sommario
1. Qualche considerazione sulla documentazione
2. Come si accede alle pagine man?
3. Quale dovrebbe essere l'aspetto di una pagina man formattata?
4. Come è possibile documentare più programmi/funzioni all'interno di un'unica pagina man?
5. Quale pacchetto di macro dovrei utilizzare?
6. Quali preprocessori posso utilizzare?
7. Dovrei distribuire il sorgente e/o la documentazione già formattata?
8. Quali sono le convenzioni sui font?
9. Come affinare una pagina man
10. Come è possibile ottenere una pagina man in formato testo senza tutti quei ^H^_ ?
11. Come si può ottenere una pagina man in formato PostScript di elevata qualità?
12. Come far funzionare correttamente `apropos' e `whatis'?
13. Diritto d'autore
14. Ringraziamenti
15. Storia dell'HOWTO
  Avanti
  Qualche considerazione sulla documentazione