MAN(1) | Utility per le Pagine di Manuale | MAN(1) |
man - un'interfaccia ai manuali di riferimento in linea
man [-c|-w|-tZ]
[-H[browser]] [-Tdispositivo]
[-X[dpi]] [-adhu7V] [-i|-I] [-m
sistema[,...]] [-L locale] [-p stringa]
[-C file] [-M percorso] [-P
paginatore] [-r prompt] [-S lista]
[-e estensione] [[sezione]
pagina ...] ...
man -l [-7] [-tZT] [-H[browser]]
[-Tdispositivo] [-X[dpi]] [-p
stringa] [-P paginatore] [-r prompt]
file ...
man -k [apropos opzioni] espr_reg ...
man -f [whatis opzioni] pagina ...
man è il paginatore dei manuali del sistema. Di solito ognuno degli argomenti pagina dati a man è il nome di un programma, di un'utility o di una funzione. La pagina di manuale associata con ognuno di questi argomenti è poi trovata e mostrata. Una sezione, se fornita, indirizzerà man a guardare solo in quella sezione del manuale. L'azione predefinita è di ricercare in tutte le sezioni disponibili seguendo un ordine prestabilito e di mostrare solo la prima pagina trovata, anche se pagina esiste in diverse sezioni.
La seguente tabella mostra i numeri delle sezioni del manuale seguiti dai tipi di pagine che contengono
1 | Programmi eseguibili e comandi della shell |
2 | Chiamate al sistema (funzioni fornite dal kernel) |
3 | Chiamate alle librerie (funzioni all'interno delle librerie di sistema) |
4 | File speciali (di solito trovabili in /dev) |
5 | Formati dei file e convenzioni p.es. /etc/passwd |
6 | Giochi |
7 | Pacchetti di macro e convenzioni p.es. man(7), groff(7). |
8 | Comandi per l'amministrazione del sistema (solitamente solo per root) |
9 | Routine del kernel [Non standard] |
Una pagina di manuale consta di diverse parti.
Queste possono essere etichettate NOME (NAME), SINTASSI (SYNOPSIS), DESCRIZIONE (DESCRIPTION), OPZIONI (OPTIONS), FILE (FILES), VEDERE ANCHE (SEE ALSO), PROBLEMI (BUGS) e AUTORE (AUTHOR).
Le seguenti convenzioni si applicano alla sezione SINTASSI e possono essere usate come una guida per le altre sezioni.
testo in grassetto | scrivere esattamente come mostrato. |
testo in corsivo | rimpiazzare con un argomento appropriato. |
[-abc] | ognuno o tutti gli argomenti all'interno di [ ] sono opzionali. |
-a|-b | opzioni separate da | non possono essere usate assieme. |
argomento ... | argomento è ripetibile. |
[espressione] ... | l'intera espressione all'interno di [ ] è ripetibile. |
L'illustrazione del comando o funzione è un modello che
dovrebbe corrispondere a tutte le possibili invocazioni. In alcuni casi
è preferibile illustrare diverse invocazioni che si escludono a
vicenda
come mostrato nella sezione SINTASSI di questa pagina di manuale.
Molte sono le opzioni disponibili per man in modo da fornire all'utente la maggior flessibilità possibile. Possono essere fatti cambiamenti al percorso di ricerca, all'ordine delle sezioni, al preprocessore per l'output, e ad altri comportamenti e operazioni elencati in dettaglio più avanti.
Se impostate, alcune variabili d'ambiente sono interrogate per determinare le funzionalità di man. È possibile impostare la variabile "omni comprensiva" $MANOPT ad una stringa qualsiasi nel formato della riga di comando, con l'eccezione che ogni spazio che sia parte integrante dell'argomento di un'opzione deve essere preceduto da un backslash (`\'). man analizzerà $MANOPT prima di analizzare la propria riga di comando. Quelle opzioni che richiedono un argomento, saranno ridefinite se le stesse opzioni si trovano anche nella riga di comando. Per annullare tutte le opzioni impostate in $MANOPT, può essere specificato -D come opzione iniziale della riga di comando. Ciò permette a man di "dimenticare" le opzioni specificate in $MANOPT sebbene debbano restare ancora valide.
Le utility per le pagine di manuale raggruppate nel pacchetto man-db fanno un uso intenso delle cache di index. Tali cache contengono informazioni come la posizione di ogni pagina di manuale nel filesystem e cosa contiene il relativo whatis (breve descrizione della pagina di manuale), inoltre permettono a man di cercare le pagine molto più velocemente rispetto ad una ricerca su file system per ogni pagine da cercare. Se richiesto tramite l'opzione -u man può verificare che tali cache rimangano consistenti, in modo da non dover lanciare manualmente del software per aggiornare le tradizionali basi di dati di whatis.
Se man non può trovare una base di dati index inizializzato da mandb per una particolare gerarchia di pagine di manuale, cercherà comunque la pagina di manuale richiesta sebbene sarà necessario un globbing dei file per effettuare la ricerca all'interno di quella gerarchia (N.d.T: con globbing [jargon] si intende l'espansione dei caratteri speciali all'interno di un nome costruito con wildcard - caratteri jolly). Invece se whatis o apropos non trovano la base di dati index, proveranno comunque a estrarre le informazioni dalla base di dati whatis tradizionale.
Queste utility supportano i file sorgente nroff compressi, che abbiano, di default, una fra le seguenti estensioni .Z, .z e .gz. È possibile trattare con qualsiasi estensione di file compresso, ma questa informazione deve essere nota al momento della compilazione. Inoltre, normalmente, qualsiasi pagina cat prodotta è compressa usando gzip. Ognuna delle gerarchie `globali' delle pagine di manuale, come /usr/share/man o /usr/X11R6/man, può avere una directory qualsiasi come gerarchia delle pagine cat. Tradizionalmente le pagine cat sono salvate sotto la stessa gerarchia delle pagine di manuale, ma per ragioni come quelle specificate nel Linux File System Standard (FSSTND), è meglio salvarle da qualche altra parte. Per i dettagli su come ciò sia possibile, si legga manpath(5). Per i dettagli sul perché fare ciò, si legga lo standard.
Con questo pacchetto è disponibile il ``supporto internazionale'': le pagine di manuale nella lingua nativa sono accessibili (se disponibili nel proprio sistema) usando le funzioni locale. Per attivare tale supporto, è necessario impostare $LC_MESSAGES e $LANG o qualche altra variabile d'ambiente dipendente dal sistema, alla propria lingua locale, solitamente specificata nel formato basato sul POSIX 1003.1:
<lingua>[_<zona>[.<set-di-caratteri>[,<versione>]]]
Se la pagina desiderata è disponibile nel proprio locale, sarà mostrata al posto della pagina standard (di solito in Inglese Americano).
Il supporto internazionale per i cataloghi di messaggi è un'altra caratteristica di questo pacchetto e può essere attivato, sempre se disponibile, nello stesso modo. Se si trova che le pagine di manuale e i cataloghi dei messaggi forniti con questo pacchetto non sono disponibili per la propria lingua e si vuole fornirli, si contatti il manutentore il quale coordinerà tali attività.
Per informazioni riguardanti altre caratteristiche ed estensioni disponibili con questo paginatore dei manuali, si leggano i documenti forniti con il pacchetto.
man cercherà la pagina di manuale desiderata all'interno delle cache delle basi di dati index. Se l'opzione -u viene specificata, è eseguita una verifica della consistenza della cache per assicurarsi che le basi di dati riflettano accuratamente il filesystem. Non è generalmente necessario eseguire mandb dopo che le cache sono state create inizialmente, finché una di questa non sia in qualche modo corrotta. Il controllo della cache su sistemi con molte pagine di manuale può essere piuttosto lungo; per questo non viene svolto automaticamente, ma gli amministratori di sistema possono esseguire mandb settimanalmente per aggiornare la base di dati. Per superare eventuali problemi causati da cache non aggiornate man passa automaticamente al `file globbing' se una ricerca nella cache non ha esito, allo stesso modo di quando la cache non è presente.
Una volta che una pagina di manuale è stata localizzata, è eseguita una verifica per scoprire se il relativo file `cat' preformattato esiste già e se è più recente del file nroff. Se è così, questo file preformattato è (di solito) decompresso e poi visualizzato tramite un paginatore. Il paginatore può essere specificato in diversi modi oppure viene usato quello predefinito (si veda l'opzione -P per i dettagli). Se non c'è la pagina cat o è più vecchia del file nroff, quest'ultimo è filtrato attraverso vari programmi ed è mostrato immediatamente.
Se può essere prodotto un file cat (esiste la relativa directory cat e ha i permessi appropriati), man comprimerà e salverà il file cat in background.
Quanti e quali filtri usare viene determinato in svariati modi. Per prima cosa è interrogata l'opzione della riga di comando -p o la variabile d'ambiente $MANROFFSEQ. Se -p non è usata e la variabile d'ambiente non è impostata, viene analizzata la riga iniziale del file troff per cercare una "stringa preprocessore". Per contenere una stringa preprocessore valida, la prima riga deve assomigliare a
'\" <stringa>
dove stringa può essere una combinazione qualsiasi delle lettere descritte più avanti dall'opzione -p.
Se nessuno dei metodi suddetti fornisce informazioni sui filtri, ne è usato un insieme predefinito.
Una pipeline di formattazione è creata dai filtri al formattatore primario (nroff o [tg]roff con -t) ed eseguita. Alternativamente, se esiste un programma eseguibile mandb_nfmt (o mandb_tfmt con -t) nella radice dell'albero dei manuali, questo è eseguito. Gli viene passato il file sorgente del manuale, la stringa preprocessore, ed eventualmente il dispositivo specificato come argomento di -T o -E.
Le opzioni che non richiedono argomenti, duplicate nelle riga di comando, in $MANOPT, o in entrambe sono dannose. Per le opzioni che richiedono un argomento, ogni duplicazione annullerà il valore del precendente argomento.
Un percorso specificato come manpath deve essere la radice di una gerarchia di pagine di manuali strutturate in sezioni come descritto nel manuale di man-db (nella sezione "The manual page system"). Per vedere le pagine di manuali esterne a questa gerarchia, si usi l'opzione -l .
Pagina di Manuale nome(sez) riga x
dove nome denota il nome della pagina di manuale, sez denota la sezione in cui è stata trovata e x è il numero di riga corrente. Ciò è ottenuto usando la variabile d'ambiente $LESS.
Fornendo l'opzione -r seguita da una stringa si può modificare il prompt predefinito. La stringa può contenere il testo $MAN_PN il quale sarà espanso nel nome della pagina di manuale corrente e il nome della sua sezione racchiuso tra `(' e `)'. La stringa usata per produrre il default potrebbe essere espressa come
\ Pagina\ di\ Manuale\ \$MAN_PN\ ?ltriga\ %lt?L/%L.:
byte\ %bB?s/%s..?\ (FINE):?pB %pB\\%..
È stata spezzata in due righe solo per migliorarne la leggibilità. Per il suo significato si veda la pagina di manuale less(1). La stringa di prompt per prima cosa è valutata dalla shell. Perciò le doppie virgolette `"', le virgolette rovesce ``' e i backslash `\' devono essere preceduti da `\'. La stringa di prompt potrebbe terminare con un `\$' il quale può essere seguito da ulteriori opzioni per less. Di default man imposta le opzioni -ix8.
Se si vuole eliminare completamente la gestione del prompt da parte di man si faccia uso della variabile d'ambiente $MANLESS descritta sotto.
Descrizione | Ottale | latin1 | ascii |
trattino di continuazione | 255 | ‐ | - |
bullet (middle dot) | 267 | • | o |
accento acuto | 264 | ´ | ' |
segno di moltiplicazione | 327 | × | x |
Se la colonna latin1 è visualizzata correttamente, il proprio terminale può essere configurato per i caratteri latin1 e questa opzione non è necessaria. Se le colonne latin1 e ascii sono identiche, si sta leggendo questa pagina usando questa opzione oppure man non l'ha formattata usando il descrittore di dispositivo latin1. Se manca la colonna latin1 o è corrotta, può essere necessario visualizzare le pagine di manuale usando questa opzione.
Questa opzione è ignorata quando si usano le opzioni -t, -H, -T o -Z e può essere inutile per nroff diversi dalla versione GNU.
-m sistema[,...], --systems=sistema[,...]
Il sistema specificato può essere una combinazione di nomi di sistemi operativi separati da virgole. Per includere una ricerca fra le pagine di manuale del sistema operativo nativo, si includa il nome di sistema man nella stringa argomento. Usando questa opzione verrà ignorata la variabile d'ambiente $SYSTEM.
mandb(8), manpath(1), manpath(5), apropos(1), whatis(1), catman(8), less(1), nroff(1), troff(1), groff(1), zsoelim(1), setlocale(3), man(7), ascii(7), latin1(7), la pagina del pacchetto man-db, FSSTND.
1990, 1991 - Originalmente scritta da John W. Eaton (jwe@che.utexas.edu).
23 Dicembre 1992: Rik Faith (faith@cs.unc.edu) applica le soluzioni ai problemi fornite da Willem Kasdorp (wkasdo@nikhefk.nikef.nl).
30 Aprile 1994 - 23 Febbraio 2000: Wilf. (G.Wilford@ee.surrey.ac.uk) ha iniziato lo sviluppo e il mantenimento di questo pacchetto con l'aiuto di un po' di gente.
30 Ottobre 1996 - 30 Marzo 2001: Fabrizio Polacco <fpolacco@debian.org> mantiene e migliora questo pacchetto per il progetto Debian, con l'aiuto di tutta la comunità.
31 Marzo 2001 - presente: Colin Watson <cjwatson@debian.org>
Traduzione di Bortolozzo Giovanni (borto@pluto.linux.it) Aggiornamento di Giuseppe Sacco <eppesuig@debian.org>
2021-02-08 | 2.9.4 |