=over 3
-=item L<perldoc|perldoc>
+=item L<perldoc>
-The main interface to Perl's documentation is
C<perldoc>, although
+The main interface to Perl's documentation is
F<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
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>
+=item L<pod2man>
+
+=item L<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
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>
+=item L<pod2html>
-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.
+As well as these two, there is another converter: F<pod2html> will
+produce HTML pages from POD.
-=item L<pod2usage|pod2usage>
+=item L<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>
+=item L<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>
+=item L<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>
+=item F<roffitall>
-The C<roffitall> utility is not installed on your system but lives in
+The F<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:
+=head2 Converters
=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;
- }
+=item L<pl2pm>
-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");
- }
+To help you convert legacy programs to more modern Perl, the
+F<pl2pm> utility will help you convert old-style Perl 4 libraries
+to new-style Perl5 modules.
=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>
+=item L<libnetcfg>
To display and change the libnet configuration run the libnetcfg command.
=over 3
-=item L<perlbug|perlbug>
+=item L<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.
+F<perlbug> used to be the recommended way to report bugs in the perl
+interpreter itself or any of the standard library modules back to the
+developers; bug reports and patches should now be submitted to
+L<https://github.com/Perl/perl5/issues>.
-=item L<perlthanks|perlthanks>
+=item L<perlthanks|perlbug>
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>
+=item L<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
+header files. You may still see S<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
+corresponding F<.h> file. See the L<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>
+=item L<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
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 F<Test::Harness>. It's an alternative to C<make test>.
+of L<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
+A command-line front-end to L<Module::CoreList>, to query what modules
were shipped with given versions of perl.
=back
=over 3
+=item L<encguess>
+
+F<encguess> will attempt to guess the character encoding of files.
+
+=item L<json_pp>
+
+F<json_pp> is a pure Perl JSON converter and formatter.
+
=item L<piconv>
-B<piconv> is a Perl version of B<iconv>, a character encoding converter
+F<piconv> is a Perl version of L<iconv(1)>, 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
+technology demonstrator for Perl v5.8.0, but you can use piconv in the
place of iconv for virtually any case.
=item L<ptar>
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
+L<Text::Diff> module to function properly; this module isn't distributed
with perl, but is available from the CPAN.)
+=item L<ptargrep>
+
+F<ptargrep> is a utility to apply pattern matching to the contents of files
+in a tar archive.
+
=item L<shasum>
-This utility, that comes with the C<Digest::SHA> module, is used to print
+This utility, that comes with the L<Digest::SHA> module, is used to print
or verify SHA checksums.
+=item L<streamzip>
+
+F<streamzip> compresses data streamed to STDIN into a streamed zip container.
+
+=item L<zipdetails>
+
+F<zipdetails> displays information about the internal record structure of the zip file.
+It is not concerned with displaying any details of the compressed data stored in the zip file.
+
=back
=head2 Installation
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,
+A little interface to L<ExtUtils::Installed> to examine installed modules,
validate your packlists and even create a tarball from an installed module.
=back
=head1 SEE ALSO
-L<perldoc|perldoc>, L<pod2man|pod2man>, L<perlpod>,
-L<pod2html|pod2html>, L<pod2usage|pod2usage>, L<podselect|podselect>,
-L<podchecker|podchecker>, L<splain|splain>, L<perldiag>,
-L<roffitall|roffitall>, L<a2p|a2p>, L<s2p|s2p>, L<find2perl|find2perl>,
-L<File::Find|File::Find>, L<pl2pm|pl2pm>, L<perlbug|perlbug>,
-L<h2ph|h2ph>, L<c2ph|c2ph>, L<h2xs|h2xs>, L<dprofpp|dprofpp>,
-L<Devel::DProf>, L<enc2xs>, L<xsubpp>, L<cpan>, L<cpanp>, L<cpan2dist>,
-L<instmodsh>, L<piconv>, L<prove>, L<corelist>, L<ptar>, L<ptardiff>,
-L<shasum>
+L<perldoc>, L<pod2man>, L<pod2text>, L<pod2html>, L<pod2usage>,
+L<podchecker>, L<splain>, L<pl2pm>,
+L<perlbug>, L<h2ph>, L<h2xs>, L<enc2xs>,
+L<xsubpp>, L<cpan>, L<encguess>, L<instmodsh>, L<json_pp>,
+L<piconv>, L<prove>, L<corelist>, L<ptar>,
+L<ptardiff>, L<shasum>, L<streamzip>, L<zipdetails>
=cut
https://perl5.git.perl.org / perl5.git / blobdiff