what they are for and provide pointers to each module's documentation,
if appropriate.
-=head2 DOCUMENTATION
+=head1 LIST OF UTILITIES
+
+=head2 Documentation
=over 3
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 man page, and then run F<man> to display it; if
+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>
+=item L<pod2html|pod2html>
-As well as these two, there are two other convertors: 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>
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 C<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
=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:
+=head2 Converters
- while (<>) {
- ($Fld1,$Fld2) = split(/[:\n]/, $_, 9999);
- print $Fld2;
- }
+To help you convert legacy programs to more modern Perl, the
+L<pl2pm|pl2pm> utility will help you convert old-style Perl 4 libraries
+to new-style Perl5 modules.
-=item L<s2p|s2p>
+=head2 Administration
-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:
+=over 3
- while (<>) {
- chop;
- s/foo/bar/g;
- print if $printit;
- }
+=item L<libnetcfg|libnetcfg>
-=item L<find2perl|find2perl>
+To display and change the libnet configuration run the libnetcfg command.
-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>:
+=item L<perlivp>
- 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");
- }
+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
-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 Development
There are a set of utilities which help you in developing Perl programs,
please read through the documentation for F<perlbug> thoroughly before
using it to submit a bug report.
+=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>
Back before Perl had the XS system for connecting with C libraries,
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 ones.
-
-=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.
+to convert a whole bunch of header files at once.
=item L<h2xs|h2xs>
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<dprofpp|dprofpp>
+=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<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>.
+
+=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 v5.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<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
+or verify SHA checksums.
+
+=item L<zipdetails>
+
+L<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
+
+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 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.
+ perl -MCPAN -e shell
-=item L<perlcc|perlcc>
+=item L<instmodsh>
-F<perlcc> is the interface to the experimental Perl compiler suite.
+A little interface to ExtUtils::Installed to examine installed modules,
+validate your packlists and even create a tarball from an installed module.
=back
-=head2 SEE ALSO
+=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<perlcc|perlcc>
+C<roffitall|roffitall>, L<File::Find|File::Find>, L<pl2pm|pl2pm>,
+L<perlbug|perlbug>, L<h2ph|h2ph>, L<h2xs|h2xs>, L<enc2xs>,
+L<xsubpp>, L<cpan>, L<instmodsh>, L<piconv>, L<prove>, L<corelist>, L<ptar>,
+L<ptardiff>, L<shasum>, L<zipdetails>
=cut
https://perl5.git.perl.org / perl5.git / blobdiff