X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=pod%2Fperlutil.pod;h=e67ec1c23eaf1766d4ca75396870eac40bec4783;hb=953f6acfa20ec275ec39a552dfac8124bd93ebdf;hp=7b56a175035f0b647043c4a63a190bcf02bf91d2;hpb=a31a806a8f483dfa4e00e0ac91d9875a8d724cff;p=p5sagit%2Fp5-mst-13.2.git diff --git a/pod/perlutil.pod b/pod/perlutil.pod index 7b56a17..e67ec1c 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 @@ -29,7 +31,7 @@ described in this document. If it's run from a terminal, F will usually call F to translate POD (Plain Old Documentation - see L for an -explanation) into a man page, and then run F to display it; if +explanation) into a manpage, and then run F to display it; if F isn't available, F will be used instead and the output piped through your favourite pager. @@ -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,17 +93,20 @@ 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: while (<>) { - chop; + chomp; s/foo/bar/g; 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 @@ -123,6 +128,28 @@ As well as these filters for converting other languages, the L utility will help you convert old-style Perl 4 libraries to new-style Perl5 modules. +=head2 Administration + +=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 + +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 + =head2 Development There are a set of utilities which help you in developing Perl programs, @@ -137,6 +164,12 @@ itself or any of the standard library modules back to the developers; please read through the documentation for F thoroughly before using it to submit a bug report. +=item L + +This program provides an easy way to send a thank-you message back to the +authors and maintainers of perl. It's just F installed under +another name. + =item L Back before Perl had the XS system for connecting with C libraries, @@ -144,7 +177,7 @@ programmers used to get library constants by reading through the C header files. You may still see C or similar around - the F<.ph> file should be created by running F on the corresponding F<.h> file. See the F documentation for more on how -to convert a whole bunch of header files at ones. +to convert a whole bunch of header files at once. =item L and L @@ -159,20 +192,109 @@ 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 +Perl comes with a profiler, the F module. The F utility analyzes the output of this profiler and tells you -which subroutines are taking up the most run time. See L +which subroutines are taking up the most run time. See L for more information. -=item L +=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. (Note that this utility requires the +C module to function properly; this module isn't distributed +with perl, but is available from the CPAN.) + +=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 + +F is, like F, a command-line interface to the CPAN, using +the C module as a back-end. It can be used interactively or +imperatively. + +=item L + +F 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 modules. + +=item L -F 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, L, L, L, L, L, @@ -180,6 +302,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, +L =cut