• NOM
• SYNOPSIS
• DESCRIPTION
• OPTIONS
• ENVIRONNEMENT
• VERSION
• AUTEUR
• TRADUCTION EN FRANÇAIS

NOM

perldoc - Recherche dans la documentation Perl au format pod.

Retour en haut de la page

SYNOPSIS

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

perldoc -f FonctionDeBase

perldoc -q MotClef FAQ

Retour en haut de la page

DESCRIPTION

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 pod2man | nroff -man | $PAGER. (en plus, s'il tourne sous HP-UX, 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).

Retour en haut de la page

OPTIONS

-h help

Affiche un bref message d'aide.

-v verbose

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

-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.

-u unformatted

Trouve les docs seulement; saute le reformatage par pod2*

-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.

-l file name only

Affiche le nom de fichier du module trouvé.

-F file names

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

-f perlfunc

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

-q perlfaq

L'option -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.

-X utilise un indeX s'il existe

L'option -X cherche une entrée dans le fichier $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.

-U run insecurely

Parce que 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 -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.

NomDePage|NomDeModule|NomDeProgramme

L'item que vous voulez rechercher. Les modules emboîtés (comme File::Basename) sont spécifiés comme File::Basename ou comme File/Basename. Vous pouvez donner aussi un nom descriptif de page, tel que 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.

Retour en haut de la page

ENVIRONNEMENT

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

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

Retour en haut de la page

VERSION

Ceci est perldoc v2.03.

Retour en haut de la page

AUTEUR

Kenneth Albanowski <kjahds@kjahds.com>

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

Retour en haut de la page

TRADUCTION EN FRANÇAIS

Jean-Louis Morel <jl_morel@bribes.org>

Retour en haut de la page