man

Il problema di lavorare con la shell di Linux è la sterminata vastità di comandi a disposizione e, all'interno di ciascuno di questi comandi, la vastità delle opzioni disponibili. Davvero impossibile ricordare tutto! Ecco che Linux aiuta l'utente, mettendo a disposizione una vastissima guida, nella quale sono riportati tutti i comandi disponibili e, per ciascun comando, la sintassi esatta da utilizzare. Ogni programma ed ogni package che viene installato nel sistema, infatti, è accompagnato dalle sue pagine di manuale. Le pagine di manuale, solitamente, sono scritte direttamente dall'autore o dagli autori del programma al quale si riferiscono. L'insieme di queste pagine di aiuto è chiamato:

	manual pages

o pagine di manuale, abbreviate, spesso, nella locuzione:

	man pages

Niente di straordinario, quindi, se il comando per poter consultare queste pagine di manuale si chiami:

	man

Il comando man deve essere seguito dal nome del comando, del quale stiamo cercando le informazioni. Per avere informazioni sul comando man, per esempio, eseguite:

	man man

Il comando man stampa a video l'output, utilizzando l'impaginazione del comando less. Quindi, per passare da una pagina all'altra, sarà sufficiente premere la barra spaziatrice, mentre per uscire dal manuale, basterà premere il tasto:

	q

Per conoscere tutte le opzioni disponibili per il comando less, cercare le pagine di manuale:

	man less

Il comando man è solo in grado di restituirci le pagine di manuale di un determinato e noto comando. Se non si conosce il comando che si sta cercando, è possibile effettuare una ricerca per parola chiave, utilizzando il comando:

	apropos parola_chiave

equivalente al comando:

	man -k parola_chiave
	man --apropos parola_chiave

Ogni pagina di manuale ha disponibile al suo interno una breve descrizione. Il comando apropos ricerca in queste descrizioni, oltre che nei nomi, le istanze della parola chiave cercata. La parola chiave cercata può essere una parola intera ( o una locuzione, chiusa tra le virgolette ):

	apropos -e echo
	apropos --exact echo
	apropos -e 'send l2cap'
	apropos --exact 'send l2cap'

oppure un'espressione regolare:

	apropos -r ^e.*o$
	apropos --regex ^e.*o$

oppure un pattern, in stile shell, che accetta i caratteri jolly ( wildcard ):

	apropos -w e*o
	apropos --wildcard e??o

In quali directory i comandi man e apropos cercano i file dei manuali? I percorsi da utilizzare sono memorizzati nella variabile d'ambiente $MANPATH, oppure nel file di configurazione del comando mandb:

  /etc/manpath.config

In entrambi i casi, per conoscere i percorsi utilizzati nella ricerca dei manuali, è sufficiente eseguire il comando:

	manpath

	manpath -c
	manpath --catpath

	manpath -g
	manpath --global

Le cosiddette " cat page " sono pagine di manuale preformattate, che, generalmente, sono più veloci da visualizzare rispetto alle pagine di manuale originali, ma richiedono ulteriore spazio per essere memorizzate. La decisione di supportare le cat page è dell'amministratore locale, il quale deve fornire anche le directory adatte per contenerle ( catpath ). Il comando manpath legge, per determinare i percorsi di ricerca, la variabile MANPATH ed il file di configurazione del comando mandb. Nella maggior parte dei casi, le pagine di manuale sono contenute in file di testo compressi:

  apropos.1.gz
  chage.1.gz
  chfn.1.gz

nelle directory:

	/usr/share/man
	/usr/local/share/man

Per sapere in quale file si trova la pagina di manuale di uno specifico comando, utilizzare l'opzione -w di man:

	man -w echo
	man --where echo
	man --location echo

oppure, utilizzare il comando whereis:

	whereis echo

che stampa a video la posizione del file eseguibile e dei file di guida. L'opzione:

		whereis -b echo

cerca solo i file binari;

		whereis -s echo

cerca solo i file sorgente;

		whereis -m echo

cerca solo i file di manuale. Per verificare, invece, se esiste una pagina CAT del manuale e dove si trova utilizzare l'opzione -W:

	man -W echo
	man --where-cat echo
	man --location-cat echo

Il comando:

	mandb

crea o aggiorna le cache index delle pagine di manuale. Le cache contengono importanti informazioni sullo stato corrente del sistema di pagine di manuale, quali: dove trovare ciascuna pagina di manuale, cosa, ciascuna pagina del manuale, contiene nel record riservato al comando whatis ( la descrizione del comando sintetizzata in una sola riga ). Grazie alle cache, il comando man può svolgere il suo lavoro in modo molto più rapido ed efficiente, evitando di scorrere l'intero filesystem, in cerca di una pagina di manuale. I file di cache sono file chiamati index, il cui suffisso dipende dal sistema operativo in cui vengono installati:

       Nome                Tipo          Asinc   NomeFile
       ──────────────────────────────────────────────────────────
       Berkeley db         Binary tree   Sì      index.bt
       GNU gdbm v >= 1.6   Hashed        Sì      index.db
       GNU gdbm v <  1.6   Hashed        No      index.db
       UNIX ndbm           Hashed        No      index.(dir|pag)

Si trovano, normalmente, nella cache di sistema:

/var/cache/man/index.db
/var/cache/man/it/index.db
/var/cache/man/de/index.db

Di default, mandb proverà ad aggiornare le basi di dati precedentemente create. Se una base di dati non esiste, viene creata. L'opzione -c:

	mandb -c
	mandb --create

forza mandb a cancellare le basi di dati precedenti e ricrearle. Ciò potrebbe essere necessario se una base di dati è rovinata o se un nuovo schema di immagazzinamento di dati verrà introdotto in futuro. L'opzione -s:

	mandb -s
	mandb --no-straycats

chiede a mandb di non perdere tempo a cercare o ad aggiungere informazioni ai database riguardanti le pagine di manuale delle quali non esiste il file sorgente ( tali pagine di manuale sono dette in gergo stray cat, o gatti randagi ). Infine, l'opzione -u:

	mandb -u
	mandb --user-db

crea solo le basi di dati dell'utente, anche se quest'ultimo ha i permessi per creare le basi di dati globali. Ora che sappiamo da dove il comando man preleva le sue informazioni, vediamo alcune sue funzionalità. Abbiamo detto che, per visualizzare una pagina di manuale, è sufficiente specificare quale comando stiamo cercando:

	man passwd

Ci sono casi, come quello appena mostrato, in cui ad un comando sono state dedicate più pagine, all'interno del Manuale. Questo accade perchè il Manuale è composto da più sezioni ed un comando può esistere in più versioni. Le sezioni in cui è suddiviso il manuale sono:

  1 => Programmi utente e comandi di shell
  2 => System Call (funzioni fornite dal kernel)
  3 => Chiamate alle librerie
  4 => File di periferica ( esempio: /dev/file1 )
  5 => Descrizione dei vari formati di file
  6 => Giochi
  7 => Vari (Macro, convenzioni, regex)
  8 => Comandi per l'amministrazione del sistema (root)
  9 => Routine del kernel [Non standard]

Se, con il comando man, non si specifica alcuna sezione particolare e se il comando esiste in più di una sezione, il comando man restituirà il primo comando trovato:

	man passwd

PASSWD(1)

NOME
       passwd - cambia la password utente

SINOSSI
       passwd [opzioni] [LOGIN]

DESCRIZIONE
............

In questo caso, il comando man ha restituito il comando passwd, trovato nella sezione 1 ( Programmi utente e comandi di shell ). Ma, passwd, oltre ad essere un comando, è anche un nome di un file, vitale per il sistema Linux:

	/etc/passwd

Se quello che stiamo cercando è il file, sapendo che la descrizione dei file è contenuta nella sezione 5, sarà sufficiente specificare al comando man il numero della sezione desiderata:

	man 5 passwd

ed otterremo la descrizione del file passwd:

PASSWD(5)

NOME
       passwd - the password file

DESCRIZIONE

Se volessimo leggere tutte le pagine dedicate ad un comando, presenti in tutte le sezioni, basterà specificare l'opzione -a al comando man:

	man -a passwd
	man --all passwd

Per passare da una sezione all'altra, sarà sufficiente premere il tasto di uscita:

	q

Per avere la lista dei file del manuale dedicate al comando:

	man -aw passwd
	man --all --where passwd

Per leggere, invece, la breve descrizione ( una riga ) di ciascuna pagina di manuale, dedicata ad un comando, è possibile usare il comando whatis:

	whatis passwd

Come per il comando apropos, il nome del comando può essere una espressione regolare:

	whatis -r ^pa.*d$
	whatis --regex ^pa.*d$

oppure un pattern, in stile shell, che accetta i caratteri jolly ( wildcard ):

	whatis -w pa???d
	whatis --wildcard pa???d