268 lines
9.8 KiB
HTML
268 lines
9.8 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of WHATIS</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>WHATIS</H1>
|
|
Section: Utilitaires de l'afficheur des pages de manuel (1)<BR>Updated: 2020-02-25<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NOM</H2>
|
|
|
|
whatis - Afficher une ligne de description des pages de manuel
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>whatis</B> [<B>-dlv?V</B>] [<B>-r</B>|<B>-w</B>] [<B>-s</B> <I>liste</I>]
|
|
[<B>-m</B> <I>système</I>[,...]] [<B>-M</B> <I>chemin</I>] [<B>-L</B>
|
|
<I>locale</I>] [<B>-C</B> <I>fichier</I>] <I>nom</I> ...
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
Chaque page de manuel comporte une description courte. <B>whatis</B> recherche
|
|
des pages de manuel dont le nom correspond à <I>nom</I> et affiche leur
|
|
description courte.
|
|
<P>
|
|
<I>nom</I> peut contenir des jokers (<I>wildcards</I>) avec l'option <B>-w</B> ou être
|
|
une expression rationnelle avec l'option <B>-r</B>. Lors de l'utilisation de ces
|
|
options, il peut être nécessaire de placer <I>nom</I> 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.
|
|
<P>
|
|
Les <B>bases de données d'indexation</B> sont exploitées lors de la recherche,
|
|
et sont mises à jour par le programme <B>mandb</B>. 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 <B>whatis</B> conforme à l'ancien modèle, d'après la
|
|
<B>base de données d'indexation</B> correspondante, saisissez la commande :
|
|
<P>
|
|
<B>whatis -M</B> <I>chemin_des_pages</I> <B>-w '*' | sort ></B>
|
|
<I>chemin_des_pages/whatis</I>
|
|
<P>
|
|
Dans cette expression, <I>chemin_des_pages</I> est le chemin d'accès à la
|
|
structure hiérarchique de pages de manuel, telle que <I>/usr/man</I>.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-d</B>, <B>--debug</B>
|
|
|
|
|
|
<DD>
|
|
Affiche les informations de mise au point.
|
|
<DT id="2"><B>-v</B>, <B>--verbose</B>
|
|
|
|
|
|
<DD>
|
|
Affiche des messages d'avertissement étendus.
|
|
<DT id="3"><B>-r</B>, <B>--regex</B>
|
|
|
|
|
|
<DD>
|
|
Interprète chaque <I>nom</I> comme une expression rationnelle. La recherche
|
|
aboutit si <I>nom</I> correspond à une partie quelconque du nom de la
|
|
page. Cette option ralentit légèrement <B>whatis</B> en raison de la méthode
|
|
de recherche dans les <B>bases de données d'indexation</B>.
|
|
<DT id="4"><B>-w</B>, <B>--wildcard</B>
|
|
|
|
|
|
<DD>
|
|
Interprète chaque <I>nom</I> comme un motif contenant des jokers (<I>wildcards</I>)
|
|
compréhensibles par l'interpréteur de commandes. Pour qu'une correspondance
|
|
soit trouvée, le motif <I>nom</I> doit correspondre au nom complet de la page de
|
|
manuel. Cette option ralentit légèrement <B>whatis</B> en raison de la méthode
|
|
de recherche dans les <B>bases de données d'indexation</B>.
|
|
<DT id="5"><B>-l</B>, <B>--long</B>
|
|
|
|
|
|
<DD>
|
|
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 <B>NOM</B> mal écrites.
|
|
<DT id="6"><B>-s</B> <I>list/</I>, <B>--sections=</B><I>list/</I>, <B>--section=</B><I>list</I><DD>
|
|
La recherche est limitée aux sections de manuel indiquées. <I>liste</I> est une
|
|
liste de sections séparées par des deux-points ou des virgules. Si une des
|
|
entrées de la <I>liste</I> 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
|
|
<I>liste</I> est plus précise, par exemple « 3perl », alors la liste n'inclura
|
|
que les pages de cette partie de section.
|
|
<DT id="7"><B>-m</B> <I>système</I>[,...], <B>--systems=</B><I>système</I>[,...]<DD>
|
|
Si le système a accès aux pages de manuel d'autres systèmes d'exploitation,
|
|
elles peuvent être recherchées en utilisant cette option. Pour rechercher le
|
|
nom des pages de manuel de NouveauSE, il faut employer l'option <B>-m</B>
|
|
<I>NouveauSE</I>.
|
|
<P>
|
|
Le <I>système</I> 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 « <B>man</B> » dans la chaîne fournie en argument. Cette option remplacera la
|
|
variable d'environnement $<B>SYSTEM</B>.
|
|
<DT id="8"><B>-M </B><I>liste_de_chemins</I>, <B>--manpath=</B><I>liste_de_chemins</I><DD>
|
|
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,
|
|
<B>whatis</B> utilise la variable d'environnement $<B>MANPATH</B>, à 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 $<B>PATH</B>. Cette option remplace le contenu de
|
|
$<B>MANPATH</B>.
|
|
<DT id="9"><B>-L </B><I>locale</I>, <B>--locale=</B><I>locale</I><DD>
|
|
<B>whatis</B> détermine habituellement la <I>locale</I> (NdT : la langue ou le
|
|
dialecte) actuelle par un appel à la fonction C <B><A HREF="/cgi-bin/man/man2html?3+setlocale">setlocale</A></B>(3) qui consulte
|
|
diverses variables d'environnement, y compris $<B>LC_MESSAGES</B> et
|
|
$<B>LANG</B>. Pour remplacer temporairement la valeur définie, utilisez cette
|
|
option. Elle fournit directement à <B>whatis</B> la chaîne de caractères
|
|
représentant la <I>locale</I>. 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.
|
|
<DT id="10"><B>-C </B><I>fichier</I>, <B>--config-file=</B><I>fichier</I><DD>
|
|
Utilise le <I>fichier</I> de configuration indiqué au lieu du fichier
|
|
<I>~/.manpath</I> par défaut.
|
|
<DT id="11"><B>-?</B>, <B>--help</B>
|
|
|
|
|
|
<DD>
|
|
Affiche un message d'aide et s'arrête.
|
|
<DT id="12"><B>--usage</B>
|
|
|
|
|
|
<DD>
|
|
Affiche un court mode d'emploi et s'arrête.
|
|
<DT id="13"><B>-V</B>, <B>--version</B>
|
|
|
|
|
|
<DD>
|
|
Affiche le numéro de version.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>CODE DE RETOUR</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="14"><B>0</B>
|
|
|
|
|
|
<DD>
|
|
Programme exécuté sans erreur.
|
|
<DT id="15"><B>1</B>
|
|
|
|
|
|
<DD>
|
|
Erreur d'utilisation, de syntaxe ou de fichier de configuration.
|
|
<DT id="16"><B>2</B>
|
|
|
|
|
|
<DD>
|
|
Erreur d'exécution.
|
|
<DT id="17"><B>16</B>
|
|
|
|
|
|
<DD>
|
|
Rien n'a été trouvé selon les critères indiqués.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>ENVIRONNEMENT</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="18"><B>SYSTEM</B>
|
|
|
|
|
|
<DD>
|
|
Si $<B>SYSTEM</B> est définie, l'effet sera le même que si on l'avait indiquée
|
|
comme argument de l'option <B>-m</B>.
|
|
<DT id="19"><B>MANPATH</B>
|
|
|
|
|
|
<DD>
|
|
Si $<B>MANPATH</B> 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.
|
|
<DT id="20"><B>MANWIDTH</B>
|
|
|
|
|
|
<DD>
|
|
If $<B>MANWIDTH</B> is set, its value is used as the terminal width (see the
|
|
<B>--long</B> option). If it is not set, the terminal width will be calculated
|
|
using the value of $<B>COLUMNS</B>, and <B><A HREF="/cgi-bin/man/man2html?2+ioctl">ioctl</A></B>(2) if available, or falling
|
|
back to 80 characters if all else fails.
|
|
</DL>
|
|
<A NAME="lbAH"> </A>
|
|
<H2>FICHIERS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="21"><I>/usr/share/man/index.(bt|db|dir|pag)</I>
|
|
|
|
|
|
<DD>
|
|
<B>Base de données d'indexation</B> globale habituelle.
|
|
<DT id="22"><I>/var/cache/man/index.(bt|db|dir|pag)</I>
|
|
|
|
|
|
<DD>
|
|
<B>Base de données d'indexation</B> globale, conforme à FHS.
|
|
<DT id="23"><I>/usr/share/man/.../whatis</I>
|
|
|
|
|
|
<DD>
|
|
Base de données texte <B>whatis</B> traditionnelle.
|
|
</DL>
|
|
<A NAME="lbAI"> </A>
|
|
<H2>VOIR AUSSI</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+apropos">apropos</A></B>(1),
|
|
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+man">man</A></B>(1),
|
|
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+mandb">mandb</A></B>(8)
|
|
|
|
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>AUTEUR</H2>
|
|
|
|
<PRE>
|
|
Wilf. (<A HREF="mailto:G.Wilford@ee.surrey.ac.uk">G.Wilford@ee.surrey.ac.uk</A>).Fabrizio Polacco (<A HREF="mailto:fpolacco@debian.org">fpolacco@debian.org</A>).Colin Watson (<A HREF="mailto:cjwatson@debian.org">cjwatson@debian.org</A>).</PRE>
|
|
|
|
<A NAME="lbAK"> </A>
|
|
<H2>TRADUCTION</H2>
|
|
|
|
Cette traduction est maintenue à l'aide de l'outil
|
|
po4a <URL:<A HREF="https://po4a.org/">https://po4a.org/</A>> par l'équipe
|
|
francophone de traduction de Debian.
|
|
<P>
|
|
|
|
Valéry Perrin <<A HREF="mailto:valery.perrin.debian@free.fr">valery.perrin.debian@free.fr</A>> le 2 janvier 2006.
|
|
David Prévot <<A HREF="mailto:david@tilapin.org">david@tilapin.org</A>> et l'équipe francophone de traduction de Debian (2010).
|
|
<P>
|
|
|
|
Veuillez signaler toute erreur de traduction en écrivant à
|
|
<<A HREF="mailto:debian-l10n-french@lists.debian.org">debian-l10n-french@lists.debian.org</A>> ou par un rapport de bogue sur
|
|
le paquet man-db.
|
|
<P>
|
|
|
|
Vous pouvez toujours avoir accès à la version anglaise de ce document en
|
|
utilisant la commande
|
|
« <B>man -L C</B> <I><section></I> <I><page_de_man></I> ».
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="24"><A HREF="#lbAB">NOM</A><DD>
|
|
<DT id="25"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="26"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="27"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="28"><A HREF="#lbAF">CODE DE RETOUR</A><DD>
|
|
<DT id="29"><A HREF="#lbAG">ENVIRONNEMENT</A><DD>
|
|
<DT id="30"><A HREF="#lbAH">FICHIERS</A><DD>
|
|
<DT id="31"><A HREF="#lbAI">VOIR AUSSI</A><DD>
|
|
<DT id="32"><A HREF="#lbAJ">AUTEUR</A><DD>
|
|
<DT id="33"><A HREF="#lbAK">TRADUCTION</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:02 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|