perldoc - Look up Perl documentation in pod format. |
perldoc - Look up Perl documentation in pod format.
perldoc [-h] [-v] [-t] [-u] [-m] [-l] [-F] [-X] PageName|ModuleName|ProgramName
perldoc -f BuiltinFunction
perldoc -q FAQ Keyword
perldoc looks up a piece of documentation in .pod format that is embedded
in the perl installation tree or in a perl script, and displays it via
pod2man | nroff -man | $PAGER
. (In addition, if running under HP-UX,
col -x
will be used.) This is primarily used for the documentation for
the perl library modules.
Your system may also have man pages installed for those modules, in
which case you can probably just use the man(1)
command.
If you are looking for a table of contents to the Perl library modules documentation, see the the perltoc manpage page.
$Config{archlib}/pod.idx
. The pod.idx file should
contain fully qualified filenames, one per line.
File::Basename
)
are specified either as File::Basename
or File/Basename
. You may also
give a descriptive name of a page, such as perlfunc
.
Any switches in the PERLDOC
environment variable will be used before the
command line arguments. perldoc
also searches directories
specified by the PERL5LIB
(or PERLLIB
if PERL5LIB
is not
defined) and PATH
environment variables.
(The latter is so that embedded pods for executables, such as
perldoc
itself, are available.) perldoc
will use, in order of
preference, the pager defined in PERLDOC_PAGER
, MANPAGER
, or
PAGER
before trying to find a pager on its own. (MANPAGER
is not
used if perldoc
was told to display plain text or unformatted pod.)
One useful value for PERLDOC_PAGER
is less -+C -E
.
This is perldoc v2.04.
Kenneth Albanowski <kjahds@kjahds.com>
Minor updates by Andy Dougherty <doughera@lafcol.lafayette.edu>, and others.
perldoc - Look up Perl documentation in pod format. |