Man page - whatis(1)

Packages contains this manual

Available languages:

en fr pt_BR es it pl pt ko nl da tr sv ja uk id ru ro sr zh_CN de

Manual

WHATIS

NOM
SYNOPSIS
DESCRIPTION
OPTIONS
CODE DE RETOUR
ENVIRONNEMENT
FICHIERS
VOIR AUSSI
AUTEUR
BOGUES
TRADUCTION

NOM

whatis - Afficher une ligne de description des pages de manuel

SYNOPSIS

whatis [ -dlv?V ] [ -r | -w ] [ -s liste ] [ -m systĂšme [,...]] [ -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 Ă  nom et affiche leur description courte.

nom peut contenir des jokers ( wildcards ) avec l’option -w ou ĂȘtre une expression rationnelle avec l’option -r . Lors de l’utilisation de ces options, il peut ĂȘtre nĂ©cessaire de placer nom entre guillemets ou de protĂ©ger par « \ » les caractĂšres spĂ©ciaux afin d’empĂȘcher l’interprĂ©teur de commandes de les dĂ©velopper.

Les bases de donnĂ©es d’indexation sont exploitĂ©es lors de la recherche, et sont mises Ă  jour par le programme mandb . Suivant votre installation, ce peut ĂȘtre exĂ©cutĂ© pĂ©riodiquement Ă  l’aide de cron, ou par vous-mĂȘme aprĂšs l’installation de nouvelles pages de manuel. Pour crĂ©er une base de donnĂ©es texte whatis conforme Ă  l’ancien modĂšle, d’aprĂšs la base de donnĂ©es 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’accĂšs Ă  la structure hiĂ©rarchique 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 Ă©tendus.

-r , --regex

InterprĂšte chaque nom comme une expression rationnelle. La recherche aboutit si nom correspond Ă  une partie quelconque du nom de la page. Cette option ralentit lĂ©gĂšrement whatis en raison de la mĂ©thode de recherche dans les bases de donnĂ©es d’indexation .

-w , --wildcard

InterprĂšte chaque nom comme un motif contenant des jokers ( wildcards ) comprĂ©hensibles par l’interprĂ©teur de commandes. Pour qu’une correspondance soit trouvĂ©e, le motif nom doit correspondre au nom complet de la page de manuel. Cette option ralentit lĂ©gĂšrement whatis en raison de la mĂ©thode de recherche dans les bases de donnĂ©es d’indexation .

-l , --long

Ne rĂ©duit pas l’affichage Ă  la largeur du terminal. Normalement la sortie sera tronquĂ©e Ă  la largeur du terminal pour Ă©viter des rĂ©sultats dĂ©plaisants avec des sections NOM mal Ă©crites.

-s liste , --sections= liste , --section= liste

La recherche est limitĂ©e aux sections de manuel indiquĂ©es. liste est une liste de sections sĂ©parĂ©es par des deux-points ou des virgules. Si une des entrĂ©es de la liste est une section simple, par exemple « 3 », alors la liste des descriptions affichĂ©es inclura les pages des sections « 3 », « 3perl », « 3x », et ainsi de suite. Par contre, si une des entrĂ©es de la liste est plus prĂ©cise, par exemple « 3perl », alors la liste n’inclura que les pages de cette partie de section.

-m systĂšme [,...], --systems= systĂšme [,...]

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 systĂšme indiquĂ© peut ĂȘtre une suite de noms de systĂšmes d’exploitation, sĂ©parĂ©s par des virgules. Pour inclure une recherche sur le nom des pages de manuel du systĂšme natif, il faut inclure le nom systĂšme « man » dans la chaĂźne fournie en argument. Cette option remplacera la variable d’environnement $ SYSTEM .

-M liste_de_chemins , --manpath= liste_de_chemins

Indique une liste de structures hiĂ©rarchiques de pages de manuel, sĂ©parĂ©es par des deux-points, Ă  utiliser lors des recherches. Par dĂ©faut, whatis utilise la variable d’environnement $ MANPATH , Ă  moins qu’elle ne soit vide ou n’ait Ă©tĂ© supprimĂ©e. Dans ce cas, il dĂ©termine la liste appropriĂ©e des chemins d’accĂšs 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 dĂ©termine habituellement la locale (NdT : la langue ou le dialecte) actuelle par un appel Ă  la fonction C setlocale (3) qui consulte diverses variables d’environnement, y compris $ LC_MESSAGES et $ LANG . Pour remplacer temporairement la valeur dĂ©finie, utilisez cette option. Elle fournit directement Ă  whatis la chaĂźne de caractĂšres reprĂ©sentant la locale . Notez que cette valeur ne prendra effet qu’à partir de la recherche des pages. Par consĂ©quent, les autres affichages, tels que les messages d’aide, seront toujours montrĂ©s dans la langue initialement dĂ©terminĂ©e.

-C fichier , --config-file= fichier

Use this user configuration file rather than the default of ~/.manpath .

-? , --help

Affiche un message d’aide et s’arrĂȘte.

--usage

Affiche un court mode d’emploi et s’arrĂȘte.

-V , --version

Affiche le numéro de version.

CODE DE RETOUR

0

Programme exécuté sans erreur.

1

Erreur d’utilisation, de syntaxe ou de fichier de configuration.

2

Erreur d’exĂ©cution.

16

Rien n’a Ă©tĂ© trouvĂ© selon les critĂšres indiquĂ©s.

ENVIRONNEMENT

SYSTEM

Si $ SYSTEM est dĂ©finie, l’effet sera le mĂȘme que si on l’avait indiquĂ©e comme argument de l’option -m .

MANPATH

Si $ MANPATH est dĂ©finie, sa valeur est interprĂ©tĂ©e comme une liste d’élĂ©ments, sĂ©parĂ©s par des deux-points, reprĂ©sentant les chemins d’accĂšs aux structures hiĂ©rarchiques 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 dĂ©finie, sa valeur est utilisĂ©e comme largeur de terminal (voir l’option --long ). Sinon, la largeur du terminal sera calculĂ©e d’aprĂšs les valeurs de $ COLUMNS et ioctl (2) s’il est disponible, soit Ă  80 colonnes si aucune indication n’est trouvĂ©e.

FICHIERS

/usr/share/man/index.(bt|db|dir|pag)

Base de donnĂ©es d’indexation globale habituelle.

/var/cache/man/index.(bt|db|dir|pag)

Base de donnĂ©es d’indexation globale, conforme Ă  FHS.

/usr/share/man/.../whatis

Base de données 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 Ă  l’aide de l’outil po4a <URL:https://po4a.org/> par l’équipe francophone de traduction de Debian.

ValĂ©ry Perrin <valery.perrin.debian@free.fr> le 2 janvier 2006. David PrĂ©vot <david@tilapin.org> et l’équipe francophone de traduction de Debian (2010).

Veuillez signaler toute erreur de traduction en Ă©crivant Ă  <debian-l10n-french@lists.debian.org> ou par un rapport de bogue sur le paquet man-db.

Vous pouvez toujours avoir accÚs à la version anglaise de ce document en utilisant la commande « man -L C <section> <page_de_man> ».