=head1 NOM

perldoc - Recherche dans la documentation Perl au format pod.

=head1 SYNOPSIS

B<perldoc> [B<-h>] [B<-v>] [B<-t>] [B<-u>] [B<-m>] [B<-l>] [B<-F>]  [B<-X>] NomDePage|NomDeModule|NomDeProgramme

B<perldoc> B<-f> FonctionDeBase

B<perldoc> B<-q> MotClef FAQ

=head1 DESCRIPTION

I<perldoc> recherche une partie de documentation au format .pod
intercalée dans l'arbre d'installation de perl ou dans un script
perl, et l'affiche avec C<pod2man | nroff -man | $PAGER>.
(en plus, s'il tourne sous HP-UX, C<col -x> sera utilisé.)
Il est utilisé essentiellement sur la documentation des modules
de la bibliothèque perl.

Votre système peut avoir aussi des pages de manuel installées pour
ces modules, auquel cas vous pouvez probablement utiliser la
commande man(1).

=head1 OPTIONS

=over 5

=item B<-h> help

Affiche un bref message d'aide.

=item B<-v> verbose

Donne une description détaillée du résultat de la recherche.

=item B<-t> text output

Affiche la doc en utilisant le convertisseur plein-texte, au lieu de nroff.
Ce peut être plus rapide, mais l'affichage est moins beau.

=item B<-u> unformatted

Trouve les docs seulement; saute le reformatage par pod2*

=item B<-m> module

Affiche le module entier: le code et la documentation pod non formatée.
Ce peut être utile si les docs n'expliquent pas une fonction suffisamment
en détails, et que vous vouliez inspecter le code directement; perldoc
trouve le fichier et vous le montre simplement à l'affichage.

=item B<-l> file name only

Affiche le nom de fichier du module trouvé.

=item B<-F> file names

Considère les arguments comme des noms de fichiers, aucune recherche
dans les répertoires n'est effectuée.

=item B<-f> perlfunc

L'option B<-f> suivie du nom d'une fonction intégrée de perl
extraira la documentation de cette fonction depuis L<perlfunc>.

=item B<-q> perlfaq

L'option B<-q> prend une expression rationnelle comme argument.
Elle cherche les en-têtes de questions dans perlfaq[1-9] et affiche
les entrées qui correspondent à l'expression rationnelle.

=item B<-X> utilise un indeX s'il existe

L'option B<-X> cherche une entrée dans le fichier C<$Config{archlib}/pod.idx>
dont le nom de base correspond a celui donné sur la ligne de commande.
Le fichier pod.idx doit contenir des noms de fichiers pleinement qualifiés,
un par ligne.

=item B<-U> run insecurely

Parce que B<perldoc> ne tourne pas correctement quand il est souillé [tainted],
et est connu pour avoir des problèmes de sécurité, il ne s'exécutera
normalement pas en super utilisateur. Si vous utilisez l'option B<-U>,
il le fera, mais seulement après avoir fixer les IDs effectif et réel
aux compte nobody ou nouser, ou -2 si disponible. S'il ne peut pas
abandonner ses privilèges, il ne fonctionnera pas.

=item B<NomDePage|NomDeModule|NomDeProgramme>

L'item que vous voulez rechercher. Les modules emboîtés (comme C<File::Basename>)
sont spécifiés comme C<File::Basename> ou comme C<File/Basename>.
Vous pouvez donner aussi un nom descriptif de page, tel que C<perlfunc>.
Vous pouvez donner aussi un nom tronqué ou avec une mauvaise casse comme
"basename" pour "File::Basename", mais ce sera plus lent, et s'il
y a plus d'une page avec le même nom partiel, vous n'obtiendrez que
la première.

=back

=head1 ENVIRONNEMENT

Tout commutateur de la variable d'environnement C<PERLDOC> sera utilisé
avant les arguments de la ligne de commande. C<perldoc> cherche aussi
dans les répertoires spécifiés par les variables d'environnement
C<PERL5LIB> (ou C<PERLLIB> si C<PERL5LIB> n'est pas défini) et C<PATH>.
(Cette dernière variable fait que les pods inclus dans les exécutables,
comme C<perldoc> lui-même, sont disponibles.)
C<perldoc> utilisera, par ordre de préférence, les pageurs définis
dans C<PERLDOC_PAGER>, C<MANPAGER>, ou C<PAGER> avant d'en chercher
un lui-même.
(C<MANPAGER> n'est pas utilisé si C<perldoc> a été appelé pour
afficher du plein-texte ou un pod non formaté.)

Une valeur utile pour C<PERLDOC_PAGER> est C<less -+C -E>.

=head1 VERSION

Ceci est perldoc v2.03.

=head1 AUTEUR

Kenneth Albanowski <kjahds@kjahds.com>

Mises à jour mineures par Andy Dougherty <doughera@lafcol.lafayette.edu>,
et quelques autres.

=head1 TRADUCTION EN FRANÇAIS

Jean-Louis Morel <jl_morel@bribes.org>

=cut