perlutil - utilities packaged with the Perl distribution
Along with the Perl interpreter itself, the Perl distribution installs a range of utilities on your system. There are also several utilities which are used by the Perl distribution itself as part of the install 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.
The main interface to Perl's documentation isperldoc, although if you're reading this, it's more than likely that you've already found it.perldoc will extract and format the documentation from any file in the current directory, any Perl module installed on the system, or any of the standard documentation pages, such as this one. Useperldoc <name> to get information on any of the utilities described in this document.
If it's run from a terminal,perldoc will usually callpod2man to translate POD (Plain Old Documentation - seeperlpod for an explanation) into a manpage, and then runman to display it; ifman isn't available,pod2text will be used instead and the output piped through your favourite pager.
As well as these two, there are two other converters:pod2html will produce HTML pages from POD, andpod2latex, which produces LaTeX files.
If you just want to know how to use the utilities described here,pod2usage will just extract the "USAGE" section; some of the utilities will automatically callpod2usage on themselves when you call them with-help.
pod2usage is a special case ofpodselect, a utility to extract named sections from documents written in POD. For instance, while utilities have "USAGE" sections, Perl modules usually have "SYNOPSIS" sections:podselect -s "SYNOPSIS" ... will extract this section for a given file.
If you're writing your own documentation in POD, thepodchecker utility will look for errors in your markup.
splain is an interface toperldiag - paste in your error message to it, and it'll explain it for you.
roffitallTheroffitall utility is not installed on your system but lives in thepod/ directory of your Perl source kit; it converts all the documentation from the distribution to*roff format, and produces a typeset PostScript or text file of the whole lot.
To help you convert legacy programs to Perl, we've included three conversion filters:
a2p convertsawk scripts to Perl programs; for example,a2p -F: on the simpleawk script{print $2} will produce a Perl program based around this code:
while (<>) { ($Fld1,$Fld2) = split(/[:\n]/, $_, -1); print $Fld2;}Similarly,s2p convertssed scripts to Perl programs.s2p run ons/foo/bar will produce a Perl program based around this:
while (<>) { chomp; s/foo/bar/g; print if $printit;}When invoked aspsed, it behaves as ased implementation, written in Perl.
Finally,find2perl translatesfind commands to Perl equivalents which use theFile::Find module. As an example,find2perl . -user root -perm 4000 -print produces the following callback subroutine forFile::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");}As well as these filters for converting other languages, thepl2pm utility will help you convert old-style Perl 4 libraries to new-style Perl5 modules.
Query or change configuration of Perl modules that use Module::Build-based configuration files for features and config data.
To display and change the libnet configuration run the libnetcfg command.
Theperlivp program is set up at Perl source code build time to test the Perl version it was built under. It can be used after runningmake install (or your platform's equivalent procedure) to verify that perl and its libraries have been installed correctly.
There are a set of utilities which help you in developing Perl programs, and in particular, extending Perl with C.
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 forperlbug thoroughly before using it to submit a bug report.
This program provides an easy way to send a thank-you message back to the authors and maintainers of perl. It's justperlbug installed under another name.
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 seerequire 'syscall.ph' or similar around - the.ph file should be created by runningh2ph on the corresponding.h file. See theh2ph documentation for more on how to convert a whole bunch of header files at once.
c2ph andpstruct, 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 ofh2xs these days.
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 very useful for creating skeletons of pure Perl modules.
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 useenc2xs to add your own encoding to perl. No knowledge of XS is necessary.
xsubpp is a compiler to convert Perl XS code into C code. It is typically run by the makefiles created byExtUtils::MakeMaker.
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.
prove is a command-line interface to the test-running functionality ofTest::Harness. It's an alternative tomake test.
A command-line front-end toModule::CoreList, to query what modules were shipped with given versions of perl.
A few general-purpose tools are shipped with perl, mostly because they came along modules included in the perl distribution.
piconv is a Perl version oficonv, 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.
ptar is a tar-like program, written in pure Perl.
ptardiff is a small utility that produces a diff between an extracted archive and an unextracted one. (Note that this utility requires theText::Diff module to function properly; this module isn't distributed with perl, but is available from the CPAN.)
ptargrep is a utility to apply pattern matching to the contents of files in a tar archive.
This utility, that comes with theDigest::SHA module, is used to print or verify SHA checksums.
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.
These utilities help manage extra Perl modules that don't come with the perl distribution.
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 theCPAN module,
perl -MCPAN -e shellcpanp is, likecpan, a command-line interface to the CPAN, using theCPANPLUS module as a back-end. It can be used interactively or imperatively.
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 asCPANPLUS::Dist::* modules.
A little interface to ExtUtils::Installed to examine installed modules, validate your packlists and even create a tarball from an installed module.
perldoc,pod2man,perlpod,pod2html,pod2usage,podselect,podchecker,splain,perldiag,roffitall|roffitall,a2p,s2p,find2perl,File::Find,pl2pm,perlbug,h2ph,c2ph,h2xs,enc2xs,xsubpp,cpan,cpanp,cpan2dist,instmodsh,piconv,prove,corelist,ptar,ptardiff,shasum,zipdetails
Perldoc Browser is maintained by Dan Book (DBOOK). Please contact him via theGitHub issue tracker oremail regarding any issues with the site itself, search, or rendering of documentation.
The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via thePerl issue tracker, themailing list, orIRC to report any issues with the contents or format of the documentation.