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/perlutil.pod (9881B)

=head1 NAME

perlutil - utilities packaged with the Perl distribution

=head1 DESCRIPTION

Along with the Perl interpreter itself, the Perl distribution installs a
range of utilities on your system. There are also several utilities
which are used by the Perl distribution itself as part of the install
process. This document exists to list all of these utilities, explain
what they are for and provide pointers to each module's documentation,
if appropriate.

=head1 LIST OF UTILITIES

=head2 Documentation

=over 3

=item L<perldoc|perldoc>

The main interface to Perl's documentation is C<perldoc>, although
if you're reading this, it's more than likely that you've already found
it. F<perldoc> will extract and format the documentation from any file
in the current directory, any Perl module installed on the system, or
any of the standard documentation pages, such as this one. Use 
C<perldoc E<lt>nameE<gt>> to get information on any of the utilities
described in this document.

=item L<pod2man|pod2man> and L<pod2text|pod2text>

If it's run from a terminal, F<perldoc> will usually call F<pod2man> to
translate POD (Plain Old Documentation - see L<perlpod> for an
explanation) into a manpage, and then run F<man> to display it; if
F<man> isn't available, F<pod2text> will be used instead and the output
piped through your favourite pager.

=item L<pod2html|pod2html> and L<pod2latex|pod2latex>

As well as these two, there are two other converters: F<pod2html> will
produce HTML pages from POD, and F<pod2latex>, which produces LaTeX
files.

=item L<pod2usage|pod2usage>

If you just want to know how to use the utilities described here,
F<pod2usage> will just extract the "USAGE" section; some of
the utilities will automatically call F<pod2usage> on themselves when
you call them with C<-help>.

=item L<podselect|podselect>

F<pod2usage> is a special case of F<podselect>, a utility to extract
named sections from documents written in POD. For instance, while
utilities have "USAGE" sections, Perl modules usually have "SYNOPSIS"
sections: C<podselect -s "SYNOPSIS" ...> will extract this section for
a given file.

=item L<podchecker|podchecker>

If you're writing your own documentation in POD, the F<podchecker>
utility will look for errors in your markup.

=item L<splain|splain>

F<splain> is an interface to L<perldiag> - paste in your error message
to it, and it'll explain it for you.

=item L<roffitall|roffitall>

The C<roffitall> utility is not installed on your system but lives in
the F<pod/> directory of your Perl source kit; it converts all the
documentation from the distribution to F<*roff> format, and produces a
typeset PostScript or text file of the whole lot.

=back

=head2 Convertors

To help you convert legacy programs to Perl, we've included three
conversion filters:

=over 3

=item L<a2p|a2p>

F<a2p> converts F<awk> scripts to Perl programs; for example, C<a2p -F:>
on the simple F<awk> script C<{print $2}> will produce a Perl program
based around this code:

while (<>) {
        ($Fld1,$Fld2) = split(/[:\n]/, $_, 9999);
        print $Fld2;
    }

=item L<s2p|s2p> and L<psed>

Similarly, F<s2p> converts F<sed> scripts to Perl programs. F<s2p> run
on C<s/foo/bar> will produce a Perl program based around this:

while (<>) {
        chomp;
        s/foo/bar/g;
        print if $printit;
    }

When invoked as F<psed>, it behaves as a F<sed> implementation, written in
Perl.

=item L<find2perl|find2perl>

Finally, F<find2perl> translates C<find> commands to Perl equivalents which 
use the L<File::Find|File::Find> module. As an example, 
C<find2perl . -user root -perm 4000 -print> produces the following callback
subroutine for C<File::Find>:

sub wanted {
        my ($dev,$ino,$mode,$nlink,$uid,$gid);
        (($dev,$ino,$mode,$nlink,$uid,$gid) = lstat($_)) &&
        $uid == $uid{'root'}) &&
        (($mode & 0777) == 04000);
        print("$name\n");
    }

=back

As well as these filters for converting other languages, the
L<pl2pm|pl2pm> utility will help you convert old-style Perl 4 libraries to 
new-style Perl5 modules.

=head2 Administration

=over 3

=item L<config_data|config_data>

Query or change configuration of Perl modules that use Module::Build-based
configuration files for features and config data.

=item L<libnetcfg|libnetcfg>

To display and change the libnet configuration run the libnetcfg command.

=item L<perlivp>

The F<perlivp> program is set up at Perl source code build time to test
the Perl version it was built under.  It can be used after running C<make
install> (or your platform's equivalent procedure) to verify that perl
and its libraries have been installed correctly.

=back

=head2 Development

There are a set of utilities which help you in developing Perl programs, 
and in particular, extending Perl with C.

=over 3

=item L<perlbug|perlbug>

F<perlbug> is the recommended way to report bugs in the perl interpreter
itself or any of the standard library modules back to the developers;
please read through the documentation for F<perlbug> thoroughly before
using it to submit a bug report.

=item L<perlthanks|perlthanks>

This program provides an easy way to send a thank-you message back to the
authors and maintainers of perl. It's just F<perlbug> installed under
another name.

=item L<h2ph|h2ph>

Back before Perl had the XS system for connecting with C libraries,
programmers used to get library constants by reading through the C
header files. You may still see C<require 'syscall.ph'> or similar
around - the F<.ph> file should be created by running F<h2ph> on the
corresponding F<.h> file. See the F<h2ph> documentation for more on how
to convert a whole bunch of header files at once.

=item L<c2ph|c2ph> and L<pstruct|pstruct>

F<c2ph> and F<pstruct>, which are actually the same program but behave
differently depending on how they are called, provide another way of
getting at C with Perl - they'll convert C structures and union declarations
to Perl code. This is deprecated in favour of F<h2xs> these days.

=item L<h2xs|h2xs>

F<h2xs> converts C header files into XS modules, and will try and write
as much glue between C libraries and Perl modules as it can. It's also
very useful for creating skeletons of pure Perl modules.

=item L<enc2xs>

F<enc2xs> builds a Perl extension for use by Encode from either
Unicode Character Mapping files (.ucm) or Tcl Encoding Files (.enc).
Besides being used internally during the build process of the Encode
module, you can use F<enc2xs> to add your own encoding to perl.
No knowledge of XS is necessary.

=item L<xsubpp>

F<xsubpp> is a compiler to convert Perl XS code into C code.
It is typically run by the makefiles created by L<ExtUtils::MakeMaker>.

F<xsubpp> will compile XS code into C code by embedding the constructs
necessary to let C functions manipulate Perl values and creates the glue
necessary to let Perl access those functions.

=item L<dprofpp|dprofpp>

Perl comes with a profiler, the F<Devel::DProf> module. The
F<dprofpp> utility analyzes the output of this profiler and tells you
which subroutines are taking up the most run time. See L<Devel::DProf>
for more information.

=item L<prove>

F<prove> is a command-line interface to the test-running functionality of
of F<Test::Harness>.  It's an alternative to C<make test>.

=item L<corelist>

A command-line front-end to C<Module::CoreList>, to query what modules
were shipped with given versions of perl.

=back

=head2 General tools

A few general-purpose tools are shipped with perl, mostly because they
came along modules included in the perl distribution.

=over 3

=item L<piconv>

B<piconv> is a Perl version of B<iconv>, a character encoding converter
widely available for various Unixen today.  This script was primarily a
technology demonstrator for Perl 5.8.0, but you can use piconv in the
place of iconv for virtually any case.

=item L<ptar>

F<ptar> is a tar-like program, written in pure Perl.

=item L<ptardiff>

F<ptardiff> is a small utility that produces a diff between an extracted
archive and an unextracted one. (Note that this utility requires the
C<Text::Diff> module to function properly; this module isn't distributed
with perl, but is available from the CPAN.)

=item L<shasum>

This utility, that comes with the C<Digest::SHA> module, is used to print
or verify SHA checksums.

=back

=head2 Installation

These utilities help manage extra Perl modules that don't come with the perl
distribution.

=over 3

=item L<cpan>

F<cpan> is a command-line interface to CPAN.pm.  It allows you to install
modules or distributions from CPAN, or just get information about them, and
a lot more.  It is similar to the command line mode of the L<CPAN> module,

perl -MCPAN -e shell

=item L<cpanp>

F<cpanp> is, like F<cpan>, a command-line interface to the CPAN, using
the C<CPANPLUS> module as a back-end. It can be used interactively or
imperatively.

=item L<cpan2dist>

F<cpan2dist> is a tool to create distributions (or packages) from CPAN
modules, then suitable for your package manager of choice. Support for
specific formats are available from CPAN as C<CPANPLUS::Dist::*> modules.

=item L<instmodsh>

A little interface to ExtUtils::Installed to examine installed modules,
validate your packlists and even create a tarball from an installed module.

=back

=head1 SEE ALSO

=cut

cmd: