FM / pod

/usr/share/perl5/pod

Name	Size	Mode	Actions
a2p.pod	6107	0644	edit dl rm
perl.pod	15748	0644	edit dl rm
perl56delta.pod	107184	0644	edit dl rm
perl58delta.pod	114908	0644	edit dl rm
perl561delta.pod	124697	0644	edit dl rm
perl570delta.pod	21655	0644	edit dl rm
perl571delta.pod	30382	0644	edit dl rm
perl572delta.pod	25551	0644	edit dl rm
perl573delta.pod	4644	0644	edit dl rm
perl581delta.pod	38060	0644	edit dl rm
perl582delta.pod	4470	0644	edit dl rm
perl583delta.pod	6335	0644	edit dl rm
perl584delta.pod	7363	0644	edit dl rm
perl585delta.pod	5889	0644	edit dl rm
perl586delta.pod	4651	0644	edit dl rm
perl587delta.pod	8357	0644	edit dl rm
perl588delta.pod	25267	0644	edit dl rm
perl589delta.pod	53905	0644	edit dl rm
perl590delta.pod	34951	0644	edit dl rm
perl591delta.pod	11173	0644	edit dl rm
perl592delta.pod	10954	0644	edit dl rm
perl593delta.pod	17034	0644	edit dl rm
perl594delta.pod	12661	0644	edit dl rm
perl595delta.pod	18934	0644	edit dl rm
perl5004delta.pod	56240	0644	edit dl rm
perl5005delta.pod	34285	0644	edit dl rm
perl5100delta.pod	53922	0644	edit dl rm
perl5101delta.pod	43877	0644	edit dl rm
perlaix.pod	18128	0644	edit dl rm
perlamiga.pod	7031	0644	edit dl rm
perlapi.pod	169428	0644	edit dl rm
perlapio.pod	19332	0644	edit dl rm
perlapollo.pod	829	0644	edit dl rm
perlartistic.pod	6802	0644	edit dl rm
perlbeos.pod	2939	0644	edit dl rm
perlbook.pod	663	0644	edit dl rm
perlboot.pod	28355	0644	edit dl rm
perlbot.pod	11675	0644	edit dl rm
perlbs2000.pod	7929	0644	edit dl rm
perlcall.pod	55173	0644	edit dl rm
perlce.pod	9257	0644	edit dl rm
perlcheat.pod	4153	0644	edit dl rm
perlclib.pod	7684	0644	edit dl rm
perlcn.pod	4915	0644	edit dl rm
perlcommunity.pod	6398	0644	edit dl rm
perlcompile.pod	9516	0644	edit dl rm
perlcygwin.pod	28183	0644	edit dl rm
perldata.pod	36879	0644	edit dl rm
perldbmfilter.pod	4987	0644	edit dl rm
perldebguts.pod	31887	0644	edit dl rm
perldebtut.pod	21304	0644	edit dl rm
perldebug.pod	37535	0644	edit dl rm
perldelta.pod	43877	0644	edit dl rm
perldgux.pod	2821	0644	edit dl rm
perldiag.pod	183151	0644	edit dl rm
perldoc.pod	7310	0644	edit dl rm
perldos.pod	10853	0644	edit dl rm
perldsc.pod	25447	0644	edit dl rm
perlebcdic.pod	66607	0644	edit dl rm
perlembed.pod	38033	0644	edit dl rm
perlepoc.pod	3779	0644	edit dl rm
perlfaq.pod	24841	0644	edit dl rm
perlfaq1.pod	17762	0644	edit dl rm
perlfaq2.pod	21614	0644	edit dl rm
perlfaq3.pod	38534	0644	edit dl rm
perlfaq4.pod	81412	0644	edit dl rm
perlfaq5.pod	49201	0644	edit dl rm
perlfaq6.pod	38538	0644	edit dl rm
perlfaq7.pod	37588	0644	edit dl rm
perlfaq8.pod	46128	0644	edit dl rm
perlfaq9.pod	24191	0644	edit dl rm
perlfilter.pod	21140	0644	edit dl rm
perlfork.pod	11440	0644	edit dl rm
perlform.pod	16894	0644	edit dl rm
perlfreebsd.pod	1950	0644	edit dl rm
perlfunc.pod	291909	0644	edit dl rm
perlglossary.pod	112139	0644	edit dl rm
perlgpl.pod	18806	0644	edit dl rm
perlguts.pod	105182	0644	edit dl rm
perlhack.pod	121512	0644	edit dl rm
perlhaiku.pod	1504	0644	edit dl rm
perlhist.pod	38766	0644	edit dl rm
perlhpux.pod	28650	0644	edit dl rm
perlhurd.pod	1990	0644	edit dl rm
perlintern.pod	26408	0644	edit dl rm
perlintro.pod	21491	0644	edit dl rm
perliol.pod	33755	0644	edit dl rm
perlipc.pod	67761	0644	edit dl rm
perlirix.pod	4397	0644	edit dl rm
perljp.pod	8070	0644	edit dl rm
perlko.pod	7892	0644	edit dl rm
perllexwarn.pod	14435	0644	edit dl rm
perllinux.pod	1492	0644	edit dl rm
perllocale.pod	41616	0644	edit dl rm
perllol.pod	8252	0644	edit dl rm
perlmachten.pod	4500	0644	edit dl rm
perlmacos.pod	2111	0644	edit dl rm
perlmacosx.pod	11322	0644	edit dl rm
perlmint.pod	9539	0644	edit dl rm
perlmod.pod	24494	0644	edit dl rm
perlmodinstall.pod	13929	0644	edit dl rm
perlmodlib.pod	77333	0644	edit dl rm
perlmodstyle.pod	21114	0644	edit dl rm
perlmpeix.pod	15087	0644	edit dl rm
perlmroapi.pod	2959	0644	edit dl rm
perlnetware.pod	6488	0644	edit dl rm
perlnewmod.pod	11214	0644	edit dl rm
perlnumber.pod	8352	0644	edit dl rm
perlobj.pod	21813	0644	edit dl rm
perlop.pod	96225	0644	edit dl rm
perlopenbsd.pod	1207	0644	edit dl rm
perlopentut.pod	37997	0644	edit dl rm
perlos2.pod	92783	0644	edit dl rm
perlos390.pod	16074	0644	edit dl rm
perlos400.pod	4618	0644	edit dl rm
perlothrtut.pod	40657	0644	edit dl rm
perlpacktut.pod	51047	0644	edit dl rm
perlperf.pod	51328	0644	edit dl rm
perlplan9.pod	5125	0644	edit dl rm
perlpod.pod	21626	0644	edit dl rm
perlpodspec.pod	67792	0644	edit dl rm
perlport.pod	86302	0644	edit dl rm
perlpragma.pod	4320	0644	edit dl rm
perlqnx.pod	4246	0644	edit dl rm
perlre.pod	82798	0644	edit dl rm
perlreapi.pod	25427	0644	edit dl rm
perlrebackslash.pod	20109	0644	edit dl rm
perlrecharclass.pod	21909	0644	edit dl rm
perlref.pod	26465	0644	edit dl rm
perlreftut.pod	18670	0644	edit dl rm
perlreguts.pod	36877	0644	edit dl rm
perlrepository.pod	23453	0644	edit dl rm
perlrequick.pod	17617	0644	edit dl rm
perlreref.pod	11996	0644	edit dl rm
perlretut.pod	115005	0644	edit dl rm
perlriscos.pod	1511	0644	edit dl rm
perlrun.pod	49928	0644	edit dl rm
perlsec.pod	23542	0644	edit dl rm
perlsolaris.pod	29131	0644	edit dl rm
perlstyle.pod	8618	0644	edit dl rm
perlsub.pod	54222	0644	edit dl rm
perlsymbian.pod	16222	0644	edit dl rm
perlsyn.pod	31090	0644	edit dl rm
perlthrtut.pod	46510	0644	edit dl rm
perltie.pod	36665	0644	edit dl rm
perltoc.pod	642987	0644	edit dl rm
perltodo.pod	48360	0644	edit dl rm
perltooc.pod	51425	0644	edit dl rm
perltoot.pod	68625	0644	edit dl rm
perltrap.pod	41151	0644	edit dl rm
perltru64.pod	7736	0644	edit dl rm
perltw.pod	5384	0644	edit dl rm
perlunicode.pod	56169	0644	edit dl rm
perlunifaq.pod	12878	0644	edit dl rm
perluniintro.pod	32973	0644	edit dl rm
perlunitut.pod	7907	0644	edit dl rm
perlutil.pod	9881	0644	edit dl rm
perluts.pod	3180	0644	edit dl rm
perlvar.pod	59133	0644	edit dl rm
perlvmesa.pod	3952	0644	edit dl rm
perlvms.pod	52545	0644	edit dl rm
perlvos.pod	5567	0644	edit dl rm
perlwin32.pod	40809	0644	edit dl rm
perlxs.pod	74194	0644	edit dl rm
perlxstut.pod	49670	0644	edit dl rm

Edit: /usr/share/perl5/pod/perldoc.pod (7310B)

=head1 NAME

perldoc - Look up Perl documentation in Pod format.

=head1 SYNOPSIS

B<perldoc> [B<-h>] [B<-v>] [B<-t>] [B<-u>] [B<-m>] [B<-l>] [B<-F>]
[B<-i>] [B<-V>] [B<-T>] [B<-r>]
[B<-dI<destination_file>>]
[B<-oI<formatname>>]
[B<-MI<FormatterClassName>>]
[B<-wI<formatteroption:value>>]
[B<-n>I<nroff-replacement>]
[B<-X>]
[B<-L> I<language_code>]
PageName|ModuleName|ProgramName

B<perldoc> B<-f> BuiltinFunction

B<perldoc> B<-L> it B<-f> BuiltinFunction

B<perldoc> B<-q> FAQ Keyword

B<perldoc> B<-L> fr B<-q> FAQ Keyword

See below for more description of the switches.

=head1 DESCRIPTION

I<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
C<pod2man | nroff -man | $PAGER>. (In addition, if running under HP-UX,
C<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 L<perltoc> page.

=head1 OPTIONS

=over 5

=item B<-h>

Prints out a brief B<h>elp message.

=item B<-v>

Describes search for the item in detail (B<v>erbosely).

=item B<-t>

Display docs using plain B<t>ext converter, instead of nroff. This may be faster,
but it probably won't look as nice.

=item B<-u>

Skip the real Pod formatting, and just show the raw Pod source (B<U>nformatted)

=item B<-m> I<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.

=item B<-l>

Display onB<l>y the file name of the module found.

=item B<-F>

Consider arguments as file names; no search in directories will be performed.

=item B<-f> I<perlfunc>

The B<-f> option followed by the name of a perl built in function will
extract the documentation of this function from L<perlfunc>.

Example:

perldoc -f sprintf

=item B<-q> I<perlfaq-search-regexp>

The B<-q> option takes a regular expression as an argument.  It will search
the B<q>uestion headings in perlfaq[1-9] and print the entries matching
the regular expression.  Example: C<perldoc -q shuffle>

=item B<-T>

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

=item B<-d> I<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:
C<perldoc -oLaTeX -dtextwrapdocs.tex Text::Wrap>

=item B<-o> I<output-formatname>

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

For example, C<-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.

=item B<-M> I<module-name>

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

You can specify several classes to try by joining them with commas
or semicolons, as in C<-MTk::SuperPod;Tk::Pod>.

=item B<-w> I<option:value> or B<-w> I<option>

This specifies an option to call the formatter B<w>ith.  For example,
C<-w textsize:15> will call
C<< $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 C<textsize> expects an integer, and you do C<-w textsize:big>,
expect trouble.)

You can use C<-w optionname> (without a value) as shorthand for
C<-w optionname:I<TRUE>>.  This is presumably useful in cases of on/off
features like: C<-w page_numbering>.

You can use a "=" instead of the ":", as in: C<-w textsize=15>.  This
might be more (or less) convenient, depending on what shell you use.

=item B<-X>

Use an index if it is present -- the B<-X> option looks for an entry
whose basename matches the name given on the command line in the file
C<$Config{archlib}/pod.idx>. The F<pod.idx> file should contain fully
qualified filenames, one per line.

=item B<-L> I<language_code>

This allows to specify the I<language code> for desired language translation.
If C<POD2::E<lt>language_codeE<gt>> 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 C<POD2::>
namespace. See L<POD2::IT> (or L<POD2::FR>) in order to see how to create and
integrate new localized C<POD2::*> pod documentation packages in
L<Pod::Perldoc>.

=item B<PageName|ModuleName|ProgramName>

The item you want to look up.  Nested modules (such as C<File::Basename>)
are specified either as C<File::Basename> or C<File/Basename>.  You may also
give a descriptive name of a page, such as C<perlfunc>.

=item B<-n> I<some-formatter>

Specify replacement for nroff

=item B<-r>

Recursive search.

=item B<-i>

Ignore case.

=item B<-V>

Displays the version of perldoc you're running.

=back

=head1 SECURITY

Because B<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 effective and real IDs to nobody's
or nouser's account, or -2 if unavailable.  If it cannot relinquish
its privileges, it will not run.

=head1 ENVIRONMENT

Any switches in the C<PERLDOC> environment variable will be used before the
command line arguments.

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

C<perldoc> also searches directories
specified by the C<PERL5LIB> (or C<PERLLIB> if C<PERL5LIB> is not
defined) and C<PATH> environment variables.
(The latter is so that embedded pods for executables, such as
C<perldoc> itself, are available.)

C<perldoc> will use, in order of preference, the pager defined in
C<PERLDOC_PAGER>, C<MANPAGER>, or C<PAGER> before trying to find a pager
on its own. (C<MANPAGER> is not used if C<perldoc> was told to display
plain text or unformatted pod.)

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

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

=head1 SEE ALSO

L<perlpod>, L<Pod::Perldoc>

=head1 AUTHOR

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

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

=cut

cmd: