Repository 32bit  Forum
Repository 64bit  Wiki

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

Da Slacky.eu.
(Introduzione)
(Le rubriche)
Riga 19: Riga 19:
= Presentazione =
= Presentazione =
== Le rubriche ==
== Le rubriche ==
  +
queste sone le rubriche principali di un pagina di manuale :
  +
* Nome
  +
Nome del programma usato.
  +
* Synopsis
  +
qui si trovano la sintassi del comando del programma, le opzioni e i i parametri.
  +
* Description
  +
Utilizzazione del programma.
  +
* Options
  +
Tutte le opzioni usate dal programma e la loro descrizione.
  +
* Exemples
  +
Esempio d'utilizzazione dell'applicazione.
  +
* Autore
  +
La persona che ha realizzazato l'applicazione.
  +
* Bugs
  +
Permette di segnalare in caso di errore.
  +
* Copyright
  +
I diritti di autore.
  +
  +
* Disponibilità
  +
Generalmente il sito in cui è ossibile scaricare l'applicazione.
  +
* Files
  +
Lista dei file utilizzati dall'applicazione.
  +
* See also
  +
Elenca i programma che hanno un link diretto con l'applicazione.
  +
* History
  +
Storia delle modifiche del programma.
  +
== Le macro ==
== Le macro ==
== Il comando groff ==
== Il comando groff ==

Versione delle 14:56, 14 ott 2006

Indice

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

queste sone le rubriche principali di un pagina di manuale :

  • Nome

Nome del programma usato.

  • Synopsis

qui si trovano la sintassi del comando del programma, le opzioni e i i parametri.

  • Description

Utilizzazione del programma.

  • Options

Tutte le opzioni usate dal programma e la loro descrizione.

  • Exemples

Esempio d'utilizzazione dell'applicazione.

  • Autore

La persona che ha realizzazato l'applicazione.

  • Bugs

Permette di segnalare in caso di errore.

  • Copyright

I diritti di autore.

  • Disponibilità

Generalmente il sito in cui è ossibile scaricare l'applicazione.

  • Files

Lista dei file utilizzati dall'applicazione.

  • See also

Elenca i programma che hanno un link diretto con l'applicazione.

  • History

Storia delle modifiche del programma.

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

Strumenti personali
Namespace

Varianti