Welcome to Linux Knowledge Base and Tutorial
"The place where you learn linux"
The ONE Campaign to make poverty history

 Create an AccountHome | Submit News | Your Account  

Tutorial Menu
Linux Tutorial Home
Table of Contents

· Introduction to Operating Systems
· Linux Basics
· Working with the System
· Shells and Utilities
· Editing Files
· Basic Administration
· The Operating System
· The X Windowing System
· The Computer Itself
· Networking
· System Monitoring
· Solving Problems
· Security
· Installing and Upgrading
· Linux and Windows

Man Pages
Linux Topics
Test Your Knowledge

Site Menu
Site Map
Copyright Info
Terms of Use
Privacy Info
Masthead / Impressum
Your Account

Private Messages

News Archive
Submit News
User Articles
Web Links


The Web

Who's Online
There are currently, 55 guest(s) and 0 member(s) that are online.

You are an Anonymous user. You can register for free by clicking here




       perldoc [-h] [-v] [-t] [-u] [-m] [-l] [-F] [-i] [-V] [-T]
       [-r] [-dddeessttiinnaattiioonn_ffiillee] [-offoorrmmaattnnaammee] [-MFFoorrmmaatttteerr­­
       CCllaassssNNaammee] [-wffoorrmmaatttteerrooppttiioonn::vvaalluuee] [-nnroff-replacement]
       [-X] PageName|ModuleName|ProgramName

       perldoc -f BuiltinFunction

       perldoc -q FAQ Keyword

       See below for more description of the switches.


       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 documenta­
       tion 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 perltoc page.


       -h   Prints out a brief help message.

       -v   Describes search for the item in detail (verbosely).

       -t   Display docs using plain text converter, instead of
            nroff. This may be faster, but it probably won't look
            as nice.

       -u   Skip the real Pod formatting, and just show the raw
            Pod source (Unformatted)

       -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 detail you need, and
            you'd like to inspect the code directly; perldoc will
            find the file for you and simply hand it off for dis­

       -l   Display only the file name of the module found.

       -F   Consider arguments as file names; no search in direc­
            tories will be performed.

       -T   This specifies that the output is not to be sent to a
            pager, but is to be sent right to STDOUT.

       -d destination-filename
            This specifies that the output is to be sent neither
            to a pager nor to STDOUT, but is to be saved to the
            specified filename.  Example: "perldoc -oLaTeX -dtex­
            twrapdocs.tex Text::Wrap"

       -o output-formatname
            This specifies that you want Perldoc to try using a
            Pod-formatting class for the output format that you
            specify.  For example: "-oman".  This is actually
            just a wrapper around the "-M" switch; using "-ofor­
            matname" just looks for a loadable class by adding
            that format name (with different capitalizations) to
            the end of different classname prefixes.

            For example, "-oLaTeX" currently tries all of the
            following classes: Pod::Perldoc::ToLaTeX Pod::Perl­
            doc::Tolatex Pod::Perldoc::ToLatex Pod::Perl­
            doc::ToLATEX Pod::Simple::LaTeX Pod::Simple::latex
            Pod::Simple::Latex Pod::Simple::LATEX Pod::LaTeX
            Pod::latex Pod::Latex Pod::LATEX.

       -M module-name
            This specifies the module that you want to try using
            for formatting the pod.  The class must must at least
            provide a "parse_from_file" method.  For example:
            "perldoc -MPod::Perldoc::ToChecker".

            You can specify several classes to try by joining
            them with commas or semicolons, as in "-MTk::Super­

       -w option:value or -w option
            This specifies an option to call the formatter with.
            For example, "-w textsize:15" will call "$format­
            ter->textsize(15)" on the formatter object before it
            is used to format the object.  For this to be valid,
            the formatter class must provide such a method, and
            the value you pass should be valid.  (So if "text­
            size" expects an integer, and you do "-w text­
            size:big", expect trouble.)

            You can use "-w optionname" (without a value) as
            shorthand for "-w optionname:TRUE".  This is presum­
            ably useful in cases of on/off features like: "-w

            You can use a "=" instead of the ":", as in: "-w

       -n some-formatter
            Specify replacement for nroff

       -r   Recursive search.

       -i   Ignore case.

       -V   Displays the version of perldoc you're running.


       Because perldoc does not run properly tainted, and is
       known to have security issues, when run as the superuser
       it will attempt to drop privileges by setting the effec­
       tive and real IDs to nobody's or nouser's account, or -2
       if unavailable.  If it cannot relinquish its privileges,
       it will not run.


       Any switches in the "PERLDOC" environment variable will be
       used before the command line arguments.

       Useful values for "PERLDOC" include "-oman", "-otext",
       "-otk", "-ortf", "-oxml", and so on, depending on what
       modules you have on hand; or exactly specify the formatter
       class with "-MPod::Perldoc::ToMan" or the like.

       "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

       One useful value for "PERLDOC_PAGER" is "less -+C -E".

       Having PERLDOCDEBUG set to a positive integer will make
       perldoc emit even more descriptive output than the "-v"
       switch does -- the higher the number, the more it emits.


       Current maintainer: Sean M. Burke, <sburke@cpan.org>

       Past contributors are: Kenneth Albanowski
       <kjahds@kjahds.com>, Andy Dougherty
       <doughera@lafayette.edu>, and many others.

An undefined database error occurred. SELECT distinct pages.pagepath,pages.pageid FROM pages, page2command WHERE pages.pageid = page2command.pageid AND commandid =

Show your Support for the Linux Tutorial

Purchase one of the products from our new online shop. For each product you purchase, the Linux Tutorial gets a portion of the proceeds to help keep us going.



Security Code
Security Code
Type Security Code

Don't have an account yet? You can create one. As a registered user you have some advantages like theme manager, comments configuration and post comments with your name.

Help if you can!

Amazon Wish List

Did You Know?
You can choose larger fonts by selecting a different themes.


Tell a Friend About Us

Bookmark and Share

Web site powered by PHP-Nuke

Is this information useful? At the very least you can help by spreading the word to your favorite newsgroups, mailing lists and forums.
All logos and trademarks in this site are property of their respective owner. The comments are property of their posters. Articles are the property of their respective owners. Unless otherwise stated in the body of the article, article content (C) 1994-2013 by James Mohr. All rights reserved. The stylized page/paper, as well as the terms "The Linux Tutorial", "The Linux Server Tutorial", "The Linux Knowledge Base and Tutorial" and "The place where you learn Linux" are service marks of James Mohr. All rights reserved.
The Linux Knowledge Base and Tutorial may contain links to sites on the Internet, which are owned and operated by third parties. The Linux Tutorial is not responsible for the content of any such third-party site. By viewing/utilizing this web site, you have agreed to our disclaimer, terms of use and privacy policy. Use of automated download software ("harvesters") such as wget, httrack, etc. causes the site to quickly exceed its bandwidth limitation and are therefore expressly prohibited. For more details on this, take a look here

PHP-Nuke Copyright © 2004 by Francisco Burzi. This is free software, and you may redistribute it under the GPL. PHP-Nuke comes with absolutely no warranty, for details, see the license.
Page Generation: 0.12 Seconds