WHATIS(1) Utilitaires de l'afficheur des pages de manuel WHATIS(1)
NOM
whatis - Afficher une ligne de description des pages de manuel
SYNOPSIS
whatis [-dlv?V] [-r|-w] [-s liste] [-m systeme[,...]] [-M chemin] [-L
locale] [-C fichier] nom ...
DESCRIPTION
Chaque page de manuel comporte une description courte. whatis recherche
des pages de manuel dont le nom correspond a nom et affiche leur
description courte.
nom peut contenir des jokers (wildcards) avec l'option -w ou etre une
expression rationnelle avec l'option -r. Lors de l'utilisation de ces
options, il peut etre necessaire de placer nom entre guillemets ou de
proteger par << \ >> les caracteres speciaux afin d'empecher
l'interpreteur de commandes de les developper.
Les bases de donnees d'indexation sont exploitees lors de la recherche,
et sont mises a jour par le programme mandb. Suivant votre
installation, ce peut etre execute periodiquement a l'aide de cron, ou
par vous-meme apres l'installation de nouvelles pages de manuel. Pour
creer une base de donnees texte whatis conforme a l'ancien modele,
d'apres la base de donnees d'indexation correspondante, saisissez la
commande :
whatis -M chemin_des_pages -w '*' | sort > chemin_des_pages/whatis
Dans cette expression, chemin_des_pages est le chemin d'acces a la
structure hierarchique de pages de manuel, telle que /usr/man.
OPTIONS
-d, --debug
Affiche les informations de mise au point.
-v, --verbose
Affiche des messages d'avertissement etendus.
-r, --regex
Interprete chaque nom comme une expression rationnelle. La
recherche aboutit si nom correspond a une partie quelconque du
nom de la page. Cette option ralentit legerement whatis en
raison de la methode de recherche dans les bases de donnees
d'indexation.
-w, --wildcard
Interprete chaque nom comme un motif contenant des jokers
(wildcards) comprehensibles par l'interpreteur de commandes.
Pour qu'une correspondance soit trouvee, le motif nom doit
correspondre au nom complet de la page de manuel. Cette option
ralentit legerement whatis en raison de la methode de recherche
dans les bases de donnees d'indexation.
-l, --long
Ne reduit pas l'affichage a la largeur du terminal. Normalement
la sortie sera tronquee a la largeur du terminal pour eviter des
resultats deplaisants avec des sections NOM mal ecrites.
-s liste, --sections=liste, --section=liste
La recherche est limitee aux sections de manuel indiquees. liste
est une liste de sections separees par des deux-points ou des
virgules. Si une des entrees de la liste est une section simple,
par exemple << 3 >>, alors la liste des descriptions affichees
inclura les pages des sections << 3 >>, << 3perl >>, << 3x >>,
et ainsi de suite. Par contre, si une des entrees de la liste
est plus precise, par exemple << 3perl >>, alors la liste
n'inclura que les pages de cette partie de section.
-m systeme[,...], --systems=systeme[,...]
If this system has access to other operating systems' manual
page names, they can be accessed using this option. To search
NewOS's manual page names, use the option -m NewOS.
Le systeme indique peut etre une suite de noms de systemes
d'exploitation, separes par des virgules. Pour inclure une
recherche sur le nom des pages de manuel du systeme natif, il
faut inclure le nom systeme << man >> dans la chaine fournie en
argument. Cette option remplacera la variable d'environnement
$SYSTEM.
-M liste_de_chemins, --manpath=liste_de_chemins
Indique une liste de structures hierarchiques de pages de
manuel, separees par des deux-points, a utiliser lors des
recherches. Par defaut, whatis utilise la variable
d'environnement $MANPATH, a moins qu'elle ne soit vide ou n'ait
ete supprimee. Dans ce cas, il determine la liste appropriee des
chemins d'acces aux pages de manuel en se basant sur la variable
d'environnement $PATH. Cette option remplace le contenu de
$MANPATH.
-L locale, --locale=locale
whatis determine habituellement la locale (NdT : la langue ou le
dialecte) actuelle par un appel a la fonction C setlocale(3) qui
consulte diverses variables d'environnement, y compris
$LC_MESSAGES et $LANG. Pour remplacer temporairement la valeur
definie, utilisez cette option. Elle fournit directement a
whatis la chaine de caracteres representant la locale. Notez que
cette valeur ne prendra effet qu'a partir de la recherche des
pages. Par consequent, les autres affichages, tels que les
messages d'aide, seront toujours montres dans la langue
initialement determinee.
-C fichier, --config-file=fichier
Use this user configuration file rather than the default of
~/.manpath.
-?, --help
Affiche un message d'aide et s'arrete.
--usage
Affiche un court mode d'emploi et s'arrete.
-V, --version
Affiche le numero de version.
CODE DE RETOUR
0 Programme execute sans erreur.
1 Erreur d'utilisation, de syntaxe ou de fichier de configuration.
2 Erreur d'execution.
16 Rien n'a ete trouve selon les criteres indiques.
ENVIRONNEMENT
SYSTEM Si $SYSTEM est definie, l'effet sera le meme que si on l'avait
indiquee comme argument de l'option -m.
MANPATH
Si $MANPATH est definie, sa valeur est interpretee comme une
liste d'elements, separes par des deux-points, representant les
chemins d'acces aux structures hierarchiques de pages de manuel.
See the SEARCH PATH section of manpath(5) for the default
behaviour and details of how this environment variable is
handled.
MANWIDTH
Si $MANWIDTH est definie, sa valeur est utilisee comme largeur
de terminal (voir l'option --long). Sinon, la largeur du
terminal sera calculee d'apres les valeurs de $COLUMNS et
ioctl(2) s'il est disponible, soit a 80 colonnes si aucune
indication n'est trouvee.
FICHIERS
/usr/share/man/index.(bt|db|dir|pag)
Base de donnees d'indexation globale habituelle.
/var/cache/man/index.(bt|db|dir|pag)
Base de donnees d'indexation globale, conforme a FHS.
/usr/share/man/.../whatis
Base de donnees texte whatis traditionnelle.
VOIR AUSSI
apropos(1), man(1), mandb(8)
AUTEUR
Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).
BOGUES
https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db
TRADUCTION
Cette traduction est maintenue a l'aide de l'outil po4a
par l'equipe francophone de traduction de
Debian.
Valery Perrin le 2 janvier 2006. David
Prevot et l'equipe francophone de traduction de
Debian (2010).
Veuillez signaler toute erreur de traduction en ecrivant a
ou par un rapport de bogue sur le
paquet man-db.
Vous pouvez toujours avoir acces a la version anglaise de ce document
en utilisant la commande << man -L C >>.
2.12.1 2024-04-05 WHATIS(1)