This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update perldelta for all changes from v5.31.7 to v5.31.8
[perl5.git] / pod / perlutil.pod
index 3c703c1..2703815 100644 (file)
@@ -35,11 +35,10 @@ 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 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>
 
@@ -48,14 +47,6 @@ 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>
@@ -66,7 +57,7 @@ utility will look for errors in your markup.
 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
@@ -75,68 +66,16 @@ 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;
-    }
+=head2 Converters
 
-=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.
+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.
 
 =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.
@@ -159,10 +98,16 @@ and in particular, extending Perl with C.
 
 =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.
+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|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>
 
@@ -173,13 +118,6 @@ 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
@@ -203,16 +141,9 @@ 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
+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>
@@ -233,7 +164,7 @@ came along modules included in the perl distribution.
 
 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
+technology demonstrator for Perl v5.8.0, but you can use piconv in the
 place of iconv for virtually any case.
 
 =item L<ptar>
@@ -243,13 +174,25 @@ 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.
+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
@@ -277,13 +220,11 @@ validate your packlists and even create a tarball from an installed module.
 =head1 SEE ALSO
 
 L<perldoc|perldoc>, L<pod2man|pod2man>, L<perlpod>,
-L<pod2html|pod2html>, L<pod2usage|pod2usage>, L<podselect|podselect>,
+L<pod2html|pod2html>, L<pod2usage|pod2usage>,
 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<instmodsh>, L<piconv>, L<prove>, L<corelist>, L<ptar>, L<ptardiff>,
-L<shasum>
+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