From: Rafael Garcia-Suarez Date: Mon, 6 Mar 2006 17:26:43 +0000 (+0000) Subject: Add all new utilities in the perlutil man page. X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=baf0caadde35ebbb6558406dd82ba1936d59cf0b;p=p5sagit%2Fp5-mst-13.2.git Add all new utilities in the perlutil man page. Includes lots of work by Zsban Ambrus. p4raw-id: //depot/perl@27390 --- diff --git a/pod/perlutil.pod b/pod/perlutil.pod index 5da4860..19d2dec 100644 --- a/pod/perlutil.pod +++ b/pod/perlutil.pod @@ -11,7 +11,9 @@ 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. -=head2 DOCUMENTATION +=head1 LIST OF UTILITIES + +=head2 Documentation =over 3 @@ -73,7 +75,7 @@ typeset PostScript or text file of the whole lot. =back -=head2 CONVERTORS +=head2 Convertors To help you convert legacy programs to Perl, we've included three conversion filters: @@ -91,7 +93,7 @@ based around this code: print $Fld2; } -=item L +=item L and L Similarly, F converts F scripts to Perl programs. F run on C will produce a Perl program based around this: @@ -102,6 +104,9 @@ on C will produce a Perl program based around this: print if $printit; } +When invoked as F, it behaves as a F implementation, written in +Perl. + =item L Finally, F translates C commands to Perl equivalents which @@ -127,14 +132,21 @@ new-style Perl5 modules. =over 3 +=item L + +Query or change configuration of Perl modules that use Module::Build-based +configuration files for features and config data. + =item L To display and change the libnet configuration run the libnetcfg command. -=item L +=item L -Query or change configuration of Perl modules that use Module::Build-based -configuration files for features and config data. +The F 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 (or your platform's equivalent procedure) to verify that perl +and its libraries have been installed correctly. =back @@ -174,6 +186,23 @@ F 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 + +F 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 to add your own encoding to perl. +No knowledge of XS is necessary. + +=item L + +F is a compiler to convert Perl XS code into C code. +It is typically run by the makefiles created by L. + +F 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 Perl comes with a profiler, the F module. The @@ -185,9 +214,71 @@ for more information. F is the interface to the experimental Perl compiler suite. +=item L + +F is a command-line interface to the test-running functionality of +of F. It's an alternative to C. + +=item L + +A command-line front-end to C, 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 + +B is a Perl version of B, 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 + +F is a tar-like program, written in pure Perl. + +=item L + +F is a small utility that produces a diff between an extracted +archive and an unextracted one. + +=item L + +This utility, that comes with the C 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 + +F 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 module, + + perl -MCPAN -e shell + +=item L + +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, L, L, L, L, L, @@ -195,6 +286,8 @@ L, L, L, L, L, L, L, L, L, L, L, L, L, L, -L, L +L, L, L, L, L, +L, L, L, L, L, L, +L =cut