>perldoc -v @+


Prints out a brief help message.
Describes search for the item in detail.
Display docs using plain text converter, instead of nroff. This may be faster, but it probably won't look as nice.
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 display.
Display only the file name of the module found.
Consider arguments as file names; no search in directories will be performed.
-f perlfunc
The -f option followed by the name of a perl built in function will extract the documentation of this function from perlfunc.
>perldoc -f sprintf
-q perlfaq
The -q option takes a regular expression as an argument. It will search the question headings in perlfaq[1-9] and print the entries matching the regular expression.
-v perlvar
The -v option followed by the name of a Perl predefined variable will extract the documentation of this variable from perlvar.
  perldoc -v '$"'
  perldoc -v @+
  perldoc -v DATA
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 -dtextwrapdocs.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 -oformatname 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::Perldoc::Tolatex Pod::Perldoc::ToLatex Pod::Perldoc::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 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::SuperPod;Tk::Pod .
-w option:value or -w option
This specifies an option to call the formatter with. For example, -w textsize:15 will call $formatter->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 textsize expects an integer, and you do -w textsize:big, expect trouble.)
You can use -w optionname (without a value) as shorthand for -w optionname:TRUE. This is presumably useful in cases of on/off features like: -w page_numbering .
You can use a "=" instead of the ":", as in: -w textsize=15 . This might be more (or less) convenient, depending on what shell you use.
Use an index if it is present. The -X option looks for an entry whose basename matches the name given on the command line in the file $Config{archlib}/pod.idx . The pod.idx file should contain fully qualified filenames, one per line.
-L language_code
This allows to specify the language code for desired language translation. If POD2:: package doesn't exist (or isn't installed in your system), the switch will be ignored. All available translation packages should be found under the POD2:: namespace. See POD2::IT (or POD2::FR) in order to see how to create and integrate new localized POD2::* pod documentation packages in Pod::Perldoc.
The item you want to look up. Nested modules (such as File::Basename ) are specified either as File::Basename or File/Basename . You may also give a descriptive name of a page, such as perlfunc .
For simple names like 'foo', when the normal search fails to find a matching page, a search with the "perl" prefix is tried as well. So "perldoc intro" is enough to find/render "perlintro.pod".
-n some-formatter
Specify replacement for nroff
Recursive search.
Ignore case.
Displays the version of perldoc you're running

2010 grandmaster all rights reserved.@IXVF2010/12/28