help2man

help2man è uno strumento per la generazione automatica di semplici pagine di manuale di output del programma. Esso è destinato a fornire un modo semplice per gli autori di software di includere una pagina di manuale nella loro distribuzione, senza dover mantenere quel documento.
Dato un programma che produce --help resonably standard --version uscite, help2man tenterà di ri-organizzare che la produzione in qualcosa che assomiglia ad una pagina di manuale.
Invocare help2man
Il formato per l'esecuzione del programma help2man è:
 
   help2man [opzione] ... eseguibile
help2man supporta le seguenti opzioni:
stringa -n
--name = string
Utilizzare stringa come la descrizione per il paragrafo NOME della pagina di manuale.
Per impostazione predefinita (per mancanza di meglio) questo paragrafo contiene pagina di manuale per la versione del programma.
Questa opzione sovrascrive una sezione includere file [nome] (cfr compreso il testo).
sezione -s
--section sezione
Utilizzare sezione come la sezione per la pagina di manuale. La sezione di default è 1.
manuale -m
--manual = manuale
Impostare il nome della sezione manuale per sezione, usata come intestazione centrata per la pagina manuale. Per impostazione predefinita, l'utente Comandi viene utilizzato per le pagine nella sezione 1, Giochi per sezione 6 esamp {Sistema Administration Utilities} per le sezioni 8 e 1M.
Fonte -S
--source = fonte
La sorgente di programma viene utilizzato come piè pagina, e spesso contiene il nome dell'organizzazione o un insieme di cui il programma è parte. Per impostazione predefinita, il valore è il nome del pacchetto e la versione.
-i file
--include = File
Includere materiale da file (vedere Compreso il testo).
-i File
--opt-includere = File
Una variante di --include per uso in modalità di pattern Makefile che non richiede il file di esistere.
-o file
--output = File
Inviare l'output a un file piuttosto che stdout.
-N
--no-info
Sopprimere l'inclusione di un VEDERE ANCHE paragrafo dirigere il lettore alla documentazione Texinfo.
--Aiuto
--version
Visualizza aiuto o informazioni sulla versione.
Per impostazione predefinita help2man passa le opzioni --help e --version standard al eseguibile anche se le alternative possono essere specificati utilizzando:
opzione -h
--help-option = opzione
stringa di opzione aiuto
opzione -v
--version-option = opzione
stringa di opzione versione