| Guida sulla ricerca delle informazioni in Linux (testo in lavorazione): | ||
|---|---|---|
| Indietro | Capitolo 5. Accesso alla documentazione dei programmi | Avanti |
Conosciuti anche come manual pages o abbreviato manpag, è la documentazione di riferimento, non raramente breve, schematica e priva d'esempi (lacuna coperta da altra documentazione come quella in TexInfo, cfr. par. successivo; o da altri file disponibili nei pressi di /usr/doc/nome_programma), che viene a essere disponibile per quasi ogni comando e programma presente nell'elaboratore, per file di configurazione e altro ancora. Le informazioni offerte sono presentate con fondamentalmente una strutturazione fissa d'ordine e di contenuti, i seguenti sono frammenti delle pagine che descrivono man, il visualizzatore base (meglio descritto in seguito), richiedibile con # man man):
(NAME) man - un'interfaccia ai manuali di riferimento in linea
Breve descrizione del programma in una sola riga. whatis (equivalente a man -f) e apropos (man -k) si servono di una base di dati in cui sono raccolte queste informazioni.
Le modalità con cui può essere richiesto il programma. È uno standard: le opzioni si distinguono da un doppio trattino con adiacente parola intera (es. --extract) o da un trattino più un singolo carattere (es. -m), l'argomento viene indicato con un nome quando l'opzione lo richiede (es. -m sistema), le opzioni e gli argomenti elencati fra parentesi quadre sono opzionali, i tre punti (...) indicano che è possibile introdurre più di un elemento, la barra | delimita un gruppo di elementi che si escludono a vicenda.
(DESCRIPTION) man è il paginatore dei manuali del sistema. Di solito ognuno degli argomenti pagina dati a man è il nome di un programma (eccetera...)
Descrizione lunga del programma.
(OPTIONS) -l, --local-file Attiva il modo `locale'. Formatta e visualizza file di manuale locali invece di effettuare una ricerca (eccetera...)
In dettaglio vengono spiegate ogni opzione del programma disponibile.
(SEE ALSO) mandb(8), manpath(1), manpath(5), apropos(1), whatis(1)
Sezione utile per una maggiore visione d'insieme dei programmi che hanno in qualche modo a che vedere con il programma esaminato.
(FILES)
Elenco dei file correlati.
(BUGS)
Non sempre presente, ma da non trascurare per i programmi che abitualmente si usano. Gli errori di programmazione conosciuti o altri problemi.
(AUTHORS)
Verso la fine può essere presente dati sui realizzatori e quindi seguito dall'autore dell'eventuale traduzione con gli indirizzi per contattarli.
Ogni pagina verrà intercalata alla fine con una riga indicante il numero della versione a cui si riferisce il manuale, la data e il numero della pagina: 2.3.10 12 luglio 1995 1; all'inizio con una riga indicante l'identificativo del manuale e il titolo: man(1) Utility per le Pagine di Manuale.
Questo numero fra parentesi significa che la pagina è relativa alla prima sezione del manuale ed è solito parlare della documentazione di questo tipo scrivendo manuale(n), dove n è un numero da 1 a 8 che corrispondono a:
(1) Comandi e programmi per l'utente
(2) Chiamate di sistema (utenti avanzati)
(3) Funzioni di libreria (utenti avanzati)
(4) Dispositivi
(5) Formato di file
(6) Giochi
(7) Varie
(8) Comandi per l'amministrazione (utente root)
Per maggiori dettagli si può consultare man(1) e intro(n).
Il formato troff/groff permette una resa di stampa adeguata mediante una conversione in PostScript
I file si trovano solitamente compressi nel formato gzip (estensione gz)
Il comando base. Per la visualizzazione del testo dovrebbe automaticamente eseguire less, dunque valgono tutti i comandi per questo indicati.
Esempio di utilizzo:
visualizzerà il manuale fstab(5): # man fstab
visualizzerà tutti le manpage intro(n): # man -a intro
visualizzerà il manuale man(7) e non man(1) o man(5)# man 7 man
Per stampare in PostScript si può usare man -t manpagina | lpr -Pps
Requisiti: X-Window
Elementare versione grafica. Dopo aver cliccato sul pulsante Manual Page si aprirà una nuova finestra con due menu: Sections, permette di avere un elenco dei manuali in linea a secondo la sezione di cui fanno parte; Options ha diverse funzioni, fra queste una per impostare una ricerca di altri manuali in linea e un'altra per aprire un nuova finestra come questa.
Pare non si possa richiamare la manpage da riga di comando.
Requisiti: X-Window, Tcl, rman
Versione di riferimento: 1.8
ftp://ftp.cs.berkeley.edu/people/phelps/ucb/tcltk
TkMan è un visualizzatore con una interfaccia grafica che offre una visualizzazione configurabile (caratteri, colori, etc), una gestione più complessa del testo (il mouse è utilizzabile per la selezione del testo da copiare, il tasto centrale del mouse permette di muovere il testo senza servirsi dei tasti cursore o della barra laterale) e della ricerca sul testo rispetto a xman. Inoltre permette di tornare indietro alla pagina già vista nella posizione lasciata, come un browser web, ricorda i manuali già visitati, cerca di agganciare collegamenti con ogni parola del testo alle pagine di manuale, ad esempio cliccando sulla parola locale nel testo di una qualsiasi manuale, sarà visualizzata la pagina del manuale in linea di locale. In unione con glimpse prevede anche la ricerca su tutti i contenuti dei manuali di riferimento in linea.
vmanpg (manuali in linea in versione grafica senza X-Window)