HELP2MAN(1) Comandi utente HELP2MAN(1)

help2man - genera una semplice pagina di manuale

help2man [OPZIONE]... ESEGUIBILE

"help2man" genera una pagina man dall'output di "--help" e "--version".

Descrizione per il paragrafo NOME
Numero di sezione per la pagina di manuale (1, 6, 8)
Nome del manuale (Comandi utente, ...)
Provenienza del programma (FSF, Debian, ...)
Seleziona la localizzazione (predefinita "C")
Include il materiale proveniente dal "FILE"
Include il materiale proveniente dal "FILE" se esiste
Invia l'output su "FILE"
Nome del manuale Texinfo
Elimina il riferimento al manuale Texinfo
Esclude "lt-" dal nome del programma
Stampa questo aiuto ed esce
Stampa il numero di versione ed esce

L'ESEGUIBILE dovrebbe accettare le opzioni "--help" e "--version" e produrre output su stdout sebbene le alternative possano essere specificate usando:

Stringa con opzione alternativa per l'aiuto
Stringa con opzione alternativa per la versione
Stringa della versione
Include lo stderr nell'analisi dell'output dell'opzione

Nell'output generato possono essere inclusi materiali aggiuntivi con le opzioni --include e --opt-include. Il formato è semplice:


[sezione]
testo


/modello/
testo

Blocchi di testo letterale *roff sono inseriti all'interno dell'output all'inizio della [sezione] fornita (ignorando la differenza tra maiuscole e minuscole) oppure dopo un paragrafo che corrisponde al /modello/.

I modelli usano la sintassi delle espressioni regolari Perl e possono essere seguiti dai modificatori i, s oppure m (consultare perlre(1)).

Le righe precedenti la prima sezione o i modelli che iniziano con "-" sono elaborati come opzioni. Qualsiasi altra cosa è ignorata in silenzio e può essere usata per commenti, parole chiave RCS e simili.

L'ordine di output delle sezioni (per quelle incluse) è:


NOME
SINTASSI
DESCRIZIONE
OPZIONI
altre
VARIABILI D'AMBIENTE
FILE
ESEMPI
AUTORE
SEGNALAZIONE BUG
COPYRIGHT
VEDERE ANCHE

Qualsiasi sezione [NOME] o [SINTASSI] che compare nel file di inclusione andrà a sostituire quelle che sarebbero prodotte automaticamente (anche se è sempre possibile annullare le prime con --name se necessario).

Altre sezioni sono inserite prima di quelle automaticamente prodotte in output per le sezioni standard fornite precedentemente, oppure sono incluse in altre (come sopra) nell'ordine riscontrato nel file di inclusione.

Placement of the text within the section may be explicitly requested by using the syntax [<section], [=section] or [>section] to place the additional text before, in place of, or after the default output respectively.

L'ultima versione di questa distribuzione è disponibile online su:


ftp://ftp.gnu.org/gnu/help2man/

Scritto da Brendan O'Dea <bod@debian.org>

Segnalare i bug a <bug-help2man@gnu.org>.

Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2020, 2021, 2022 Free Software Foundation, Inc.
Questo è software libero; si vedano i sorgenti per le condizioni di copia. NON c'è alcuna garanzia; neppure di COMMERCIABILITÀ o di IDONEITÀ A UNO SCOPO PARTICOLARE.

L'intera documentazione di help2man è mantenuta come un manuale Texinfo. Se i programmi info e help2man sono installati correttamente, il comando

info help2man

dovrebbe dare accesso al manuale completo.

aprile 2022 GNU help2man 1.49.2