MAN page from RedHat Other perl-5.004-0.1.i386.rpm
PERLDOC
Section: Perl Programmers Reference Guide (1)
Updated: perl 5.004, patch 04
Index NAME
perldoc - Look up Perl documentation in pod format.
SYNOPSIS
perldoc [
-h] [
-v] [
-t] [
-u] [
-m] [
-l] PageName|ModuleName|ProgramName
perldoc -f BuiltinFunction
DESCRIPTION
perldoc looks up a piece of documentation in .pod format that is embeddedin 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 forthe perl library modules.
Your system may also have man pages installed for those modules, inwhich case you can probably just use the man(1) command.
OPTIONS
- -h help
- Prints out a brief help message.
- -v verbose
- Describes search for the item in detail.
- -t text output
- Display docs using plain text converter, instead of nroff. This may be faster,but it won't look as nice.
- -u unformatted
- Find docs only; skip reformatting by pod2*
- -m module
- Display the entire module: both code and unformatted pod documentation.This may be useful if the docs don't explain a function in the detailyou need, and you'd like to inspect the code directly; perldoc will findthe file for you and simply hand it off for display.
- -l file name only
- Display the file name of the module found.
- -f perlfunc
- The -f option followed by the name of a perl built in function willextract the documentation of this function from the perlfunc manpage.
- PageName|ModuleName|ProgramName
- The item you want to look up. Nested modules (such as File::Basename)are specified either as File::Basename or File/Basename. You may alsogive a descriptive name of a page, such as perlfunc. You make also give apartial or wrong-case name, such as ``basename'' for ``File::Basename'', butthis will be slower, if there is more then one page with the same partialname, you will only get the first one.
ENVIRONMENT
Any switches in the
PERLDOC environment variable will be used before the command line arguments.
perldoc also searches directoriesspecified by the
PERL5LIB (or
PERLLIB if
PERL5LIB is notdefined) and
PATH environment variables.(The latter is so that embedded pods for executables, such as
perldoc itself, are available.)
AUTHOR
Kenneth Albanowski <kjahdsAATTkjahds.com>
Minor updates by Andy Dougherty <dougheraAATTlafcol.lafayette.edu>
Index
- NAME
- SYNOPSIS
- DESCRIPTION
- OPTIONS
- ENVIRONMENT
- AUTHOR
This document was created byman2html,using the manual pages.
