1.4. Parametro "--help", comandi whatis e apropos

Ad ogni programma dell'elaboratore sarà quasi sempre possibile passare via shell il parametro --help (o, a volte, -h o anche, più raro, -?) per avere una breve schematica descrizione delle opzioni disponibili. Informazioni simili possono anche appariranno qualora non vengano immessi dei parametri richiesti al fine dell'esecuzione del programma.

# rm --help
Uso: rm [OPZIONE]... FILE...
Rimuove (unlink) il/i FILE.
 
  -d, --directory       fa unlink della directory, anche se non è vuota
                        (solo per il super-user)
  -f, --force           ignora i file non esistenti, non chiede mai conferma
  -i, --interactive     chiede conferma prima di ogni cancellazione
  -r, -R, --recursive   rimuove ricorsivamente il contenuto delle directory
  -v, --verbose         spiega cosa sta facendo
      --help            mostra questo aiuto ed esce
      --version         stampa le informazioni sulla versione ed esce
 
Segnalate i bug a <bug-fileutils@gnu.org>.

Un conciso modo per avere informazioni su un programma è whatis (che cos'è). Utilizzandolo si potrà visualizzare una breve spiegazione su ciò di cui si occupa il programma che viene specificato.

Esempio 1-2. whatis, cosa sono cp e whereis

# whatis cp
cp (1)               - copia file
# whatis whereis
whereis (1)          - locate the binary, source, and manual page files for a command

Nell'Esempio 1-3 vengono chiesti al programma spiegazioni su tutti i programmi inizianti per una lettera in particolare (g) sulla directory corrente (/usr/bin).

Esempio 1-3. whatis, un elenco di spiegazioni

/usr/bin# whatis g*
grep (1)             - stampa le righe che corrispondono ad un modello
gunzip (1)           - comprime e decomprime i file
gzip (1)             - comprime e decomprime i file

Comportamento che si ottiene mediante l'asterisco (*), che viene interpretato dalla shell come un suo carattere speciale: internamente fa una ricerca su disco, vede quali sono i file che corrispondono alla ricerca e quindi esegue il programma che è stato indicato. In questo caso equivale ad immettere un whatis grep gunzip gzip. Maggiori informazioni si potranno trovare nel Capitolo 2, Modelli di occorrenza (o pattern matching).

Si può fare una ricerca nell'insieme di programmi e descrizioni breve mediante apropos (a proposito di).

# apropos news

Ad esempio si può provare a cercare fra i programmi installati quali hanno a che vedere con i "newsgroup", le aree di discussione Usenet.

# apropos -e format

Oppure

I due comandi whatis e apropos fanno riferimento al relativo manuale in linea dei programmi, da qui estraggono la riga contenente la breve descrizione. Semmai succeda che vi sia il programma ma manchi il corrispondente manuale, allora whatis darà per errore "niente di appropriato", apropos non potrà considerarlo nella ricerca. Per maggiori informazioni sui manuali di riferimento in linea si può vedere la Sezione 5.2.