2 Generated by perlmodlib.PL -- DO NOT EDIT!
6 perlmodlib - constructing new Perl modules and finding existing ones
8 =head1 THE PERL MODULE LIBRARY
10 Many modules are included in the Perl distribution. These are described
11 below, and all end in F<.pm>. You may discover compiled library
12 files (usually ending in F<.so>) or small pieces of modules to be
13 autoloaded (ending in F<.al>); these were automatically generated
14 by the installation process. You may also discover files in the
15 library directory that end in either F<.pl> or F<.ph>. These are
16 old libraries supplied so that old programs that use them still
17 run. The F<.pl> files will all eventually be converted into standard
18 modules, and the F<.ph> files made by B<h2ph> will probably end up
19 as extension modules made by B<h2xs>. (Some F<.ph> values may
20 already be available through the POSIX, Errno, or Fcntl modules.)
21 The B<pl2pm> file in the distribution may help in your conversion,
22 but it's just a mechanical process and therefore far from bulletproof.
24 =head2 Pragmatic Modules
26 They work somewhat like compiler directives (pragmata) in that they
27 tend to affect the compilation of your program, and thus will usually
28 work well only when used within a C<use>, or C<no>. Most of these
29 are lexically scoped, so an inner BLOCK may countermand them
36 which lasts until the end of that BLOCK.
38 Some pragmas are lexically scoped--typically those that affect the
39 C<$^H> hints variable. Others affect the current package instead,
40 like C<use vars> and C<use subs>, which allow you to predeclare a
41 variables or subroutines within a particular I<file> rather than
42 just a block. Such declarations are effective for the entire file
43 for which they were declared. You cannot rescind them with C<no
46 The following pragmas are defined (and have their own documentation).
52 Select assertions in blocks of code
54 =item assertions::activate
58 =item assertions::compat
60 Assertions for pre-5.9 versions of perl
64 Get/set subroutine or variable attributes
68 Set/get attributes of a subroutine (deprecated)
72 Postpone load of modules until a function is used
76 Establish IS-A relationship with base classes at compile time
80 Transparent BigInteger support for Perl
84 Transparent BigNumber support for Perl
88 Transparent BigNumber/BigRational support for Perl
92 Use MakeMaker's uninstalled version of a package
96 Force byte semantics rather than character semantics
100 Define character names for C<\N{named}> string literal escapes
108 Produce verbose warning diagnostics
112 Allows you to write your script in non-ascii or non-utf8
114 =item encoding::warnings
116 Warn on implicit encoding conversions
120 Enable new syntactic features
124 Compile-time class fields
128 Control the filetest permission operators
132 C<use> a Perl module if a condition holds
136 Use integer arithmetic instead of floating point
140 Request less of something from the compiler
144 Manipulate @INC at compile time
148 Use and avoid POSIX locales for built-in operations
152 Set default PerlIO layers for input and output
156 Restrict unsafe operations when compiling
160 Package for overloading Perl operations
164 Alter regular expression behaviour
168 Enable simple signal handling
172 Control sort() behaviour
176 Restrict unsafe constructs
184 Perl extension allowing use of interpreter based threads from perl
186 =item threads::shared
188 Perl extension for sharing data structures between threads
192 Enable/disable UTF-8 (or UTF-EBCDIC) in source code
196 Predeclare global variable names (obsolete)
200 Perl extension for Version Objects
204 Control VMS-specific language features
208 Control optional warnings
210 =item warnings::register
212 Warnings import function
216 =head2 Standard Modules
218 Standard, bundled modules are all expected to behave in a well-defined
219 manner with respect to namespace pollution because they use the
220 Exporter module. See their own documentation for details.
222 It's possible that not all modules listed below are installed on your
223 system. For example, the GDBM_File module will not be installed if you
224 don't have the gdbm library.
230 Provide framework for multiple DBMs
234 Module for manipulations of tar archives
236 =item Archive::Tar::File
238 A subclass for in-memory extracted file from Archive::Tar
240 =item Attribute::Handlers
242 Simpler definition of attribute handlers
246 Load subroutines only on demand
250 Split a package for autoloading
258 Autogenerated data about Perl ops, used to generate bytecode
262 Assemble Perl bytecode
270 Perl compiler's bytecode backend
274 Perl compiler's C backend
278 Perl compiler's optimized C translation backend
282 Walk Perl syntax tree, printing concise info about ops
286 Walk Perl syntax tree, printing debug info about ops
290 Perl compiler backend to produce perl code
292 =item B::Disassembler
294 Disassemble Perl bytecode
302 Show lexical variables used in functions or files
306 Helper module for CC backend
310 Show what stashes are loaded
314 Walk Perl syntax tree, printing terse info about ops
318 Generates cross reference reports for Perl programs
322 Benchmark running times of Perl code
326 Load byte compiled perl code
330 Simple Common Gateway Interface Class
334 Backward compatibility module for CGI.pm
338 CGI routines for writing to the HTTPD (or other) error log
342 Interface to Netscape Cookies
346 CGI Interface for Fast CGI
350 Module to produce nicely formatted HTML code
354 Simple Interface to Server Push
358 Backward compatibility module for defunct CGI::Switch
362 Internal utilities used by CGI module
366 Query, download and build perl modules from CPAN sites
368 =item CPAN::FirstTime
370 Utility for CPAN::Config file Initialization
374 Wrapper around CPAN.pm without using any XS module
378 Utility functions to compare CPAN versions
382 Warn of errors (from perspective of caller)
386 Heavy machinery, no user serviceable parts inside
390 Report the search path for a class's ISA tree
394 Declare struct-like datatypes as Perl classes
398 Interface to zlib compression library
400 =item Compress::Zlib::pod::FAQ
402 Frequently Asked Questions about Compress::Zlib
406 Access Perl configuration information
410 Get pathname of current working directory
414 Programmatic interface to the Perl debugging API (draft, subject to
418 Filter DBM keys/values
422 Perl5 access to Berkeley DB version 1.x
426 Stringified perl data structures, suitable for both printing and C<eval>
434 Perl/Pollution/Portability
438 A data debugging tool for the XS programmer
440 =item Devel::SelfStubber
442 Generate stubs for a SelfLoading module
446 Modules that calculate message digests
450 Perl interface to the MD5 Algorithm
454 Perl extension for SHA-1/224/256/384/512
462 Calculate digests of files
466 Supply object methods for directory handles
470 Provides screen dump of Perl data.
474 Dynamically load C libraries into Perl code
482 Alias definitions to encodings
486 Single Byte Encodings
488 =item Encode::CJKConstants
490 Internally used by Encode::??::ISO_2022_*
494 China-based Chinese Encodings
498 Internally used by Encode::CN
502 Internally used by Encode
508 =item Encode::Encoder
510 Object Oriented Encoder
512 =item Encode::Encoding
514 Encode Implementation Base Class
518 Guesses encoding from data
524 =item Encode::JP::H2Z
526 Internally used by Encode::JP::2022_JP*
528 =item Encode::JP::JIS7
530 Internally used by Encode::JP
536 =item Encode::KR::2022_KR
538 Internally used by Encode::KR
540 =item Encode::MIME::Header
542 MIME 'B' and 'Q' header encoding
546 A detailed document on Encode and PerlIO
548 =item Encode::Supported
550 Encodings supported by Encode
558 Taiwan-based Chinese Encodings
560 =item Encode::Unicode
562 Various Unicode Transformation Formats
564 =item Encode::Unicode::UTF7
570 Use nice English (or awk) names for ugly punctuation variables
574 Perl module that imports environment variables as scalars or arrays
578 System errno constants
582 Implements default import method for modules
584 =item Exporter::Heavy
588 =item ExtUtils::CBuilder
590 Compile and link C code for Perl modules
592 =item ExtUtils::CBuilder::Platform::Windows
594 Builder class for Windows platforms
596 =item ExtUtils::Command
598 Utilities to replace common UNIX commands in Makefiles etc.
600 =item ExtUtils::Command::MM
602 Commands for the MM's to use in Makefiles
604 =item ExtUtils::Constant
606 Generate XS code to import C header constants
608 =item ExtUtils::Constant::Base
610 Base class for ExtUtils::Constant objects
612 =item ExtUtils::Constant::Utils
614 Helper functions for ExtUtils::Constant
616 =item ExtUtils::Constant::XS
618 Base class for ExtUtils::Constant objects
620 =item ExtUtils::Embed
622 Utilities for embedding Perl in C/C++ applications
624 =item ExtUtils::Install
626 Install files from here to there
628 =item ExtUtils::Installed
630 Inventory management of installed modules
632 =item ExtUtils::Liblist
634 Determine libraries to use and how to use them
638 OS adjusted ExtUtils::MakeMaker subclass
640 =item ExtUtils::MM_AIX
642 AIX specific subclass of ExtUtils::MM_Unix
644 =item ExtUtils::MM_Any
646 Platform-agnostic MM methods
648 =item ExtUtils::MM_BeOS
650 Methods to override UN*X behaviour in ExtUtils::MakeMaker
652 =item ExtUtils::MM_Cygwin
654 Methods to override UN*X behaviour in ExtUtils::MakeMaker
656 =item ExtUtils::MM_DOS
658 DOS specific subclass of ExtUtils::MM_Unix
660 =item ExtUtils::MM_MacOS
662 Once produced Makefiles for MacOS Classic
664 =item ExtUtils::MM_NW5
666 Methods to override UN*X behaviour in ExtUtils::MakeMaker
668 =item ExtUtils::MM_OS2
670 Methods to override UN*X behaviour in ExtUtils::MakeMaker
672 =item ExtUtils::MM_QNX
674 QNX specific subclass of ExtUtils::MM_Unix
676 =item ExtUtils::MM_UWIN
678 U/WIN specific subclass of ExtUtils::MM_Unix
680 =item ExtUtils::MM_Unix
682 Methods used by ExtUtils::MakeMaker
684 =item ExtUtils::MM_VMS
686 Methods to override UN*X behaviour in ExtUtils::MakeMaker
688 =item ExtUtils::MM_VOS
690 VOS specific subclass of ExtUtils::MM_Unix
692 =item ExtUtils::MM_Win32
694 Methods to override UN*X behaviour in ExtUtils::MakeMaker
696 =item ExtUtils::MM_Win95
698 Method to customize MakeMaker for Win9X
702 ExtUtils::MakeMaker subclass for customization
704 =item ExtUtils::MakeMaker
706 Create a module Makefile
708 =item ExtUtils::MakeMaker::Config
710 Wrapper around Config.pm
712 =item ExtUtils::MakeMaker::FAQ
714 Frequently Asked Questions About MakeMaker
716 =item ExtUtils::MakeMaker::Tutorial
718 Writing a module with MakeMaker
720 =item ExtUtils::MakeMaker::bytes
722 Version-agnostic bytes.pm
724 =item ExtUtils::MakeMaker::vmsish
726 Platform-agnostic vmsish.pm
728 =item ExtUtils::Manifest
730 Utilities to write and check a MANIFEST file
732 =item ExtUtils::Mkbootstrap
734 Make a bootstrap file for use by DynaLoader
736 =item ExtUtils::Mksymlists
738 Write linker options files for dynamic extension
740 =item ExtUtils::Packlist
742 Manage .packlist files
744 =item ExtUtils::ParseXS
746 Converts Perl XS code into C code
748 =item ExtUtils::testlib
750 Add blib/* directories to @INC
754 Replace functions with equivalents which succeed or die
758 Load the C Fcntl.h defines
762 Parse file paths into directory, filename and suffix.
764 =item File::CheckTree
766 Run many filetest checks on a tree
770 Compare files or filehandles
774 Copy files or filehandles
778 DOS like globbing and then some
782 Traverse a directory tree.
786 Perl extension for BSD glob routine
788 =item File::GlobMapper
790 Extend File Glob to Allow Input and Output Files
794 Create or remove directory trees
798 Portably perform operations on file names
800 =item File::Spec::Cygwin
802 Methods for Cygwin file specs
804 =item File::Spec::Epoc
806 Methods for Epoc file specs
808 =item File::Spec::Functions
810 Portably perform operations on file names
812 =item File::Spec::Mac
814 File::Spec for Mac OS (Classic)
816 =item File::Spec::OS2
818 Methods for OS/2 file specs
820 =item File::Spec::Unix
822 File::Spec for Unix, base for other File::Spec modules
824 =item File::Spec::VMS
826 Methods for VMS file specs
828 =item File::Spec::Win32
830 Methods for Win32 file specs
834 Return name and handle of a temporary file safely
838 By-name interface to Perl's built-in stat() functions
842 Keep more files open than the system permits
846 Supply object methods for filehandles
850 Simplified source filtering
852 =item Filter::Util::Call
854 Perl Source Filter Utility Module
858 Locate directory of original perl script
862 Perl5 access to the gdbm library.
866 Extended processing of command line options
870 Process single-character switches with switch clustering
874 A selection of general-utility hash subroutines
878 Compare 8-bit scalar data according to the current locale
882 Functions for dealing with RFC3066-style language tags
884 =item I18N::LangTags::Detect
886 Detect the user's language preferences
888 =item I18N::LangTags::List
890 Tags and names for human languages
894 Query locale information
898 Load various IO modules
900 =item IO::Compress::Deflate
902 Perl interface to write RFC 1950 files/buffers
904 =item IO::Compress::Gzip
906 Perl interface to write RFC 1952 files/buffers
908 =item IO::Compress::RawDeflate
910 Perl interface to write RFC 1951 files/buffers
914 Supply object methods for directory handles
918 Supply object methods for filehandles
922 Supply object methods for I/O handles
926 Supply object methods for pipes
930 Object interface to system poll call
934 Supply seek based methods for I/O objects
938 OO interface to the select system call
942 Object interface to socket communications
944 =item IO::Socket::INET
946 Object interface for AF_INET domain sockets
948 =item IO::Socket::UNIX
950 Object interface for AF_UNIX domain sockets
952 =item IO::Uncompress::AnyInflate
954 Perl interface to read RFC 1950, 1951 & 1952 files/buffers
956 =item IO::Uncompress::Gunzip
958 Perl interface to read RFC 1952 files/buffers
960 =item IO::Uncompress::Inflate
962 Perl interface to read RFC 1950 files/buffers
964 =item IO::Uncompress::RawInflate
966 Perl interface to read RFC 1951 files/buffers
970 IO:: style interface to L<Compress::Zlib>
974 Open a process for both reading and writing
978 Open a process for reading, writing, and error handling
986 SysV Msg IPC object class
988 =item IPC::SysV::Semaphore
990 SysV Semaphore IPC object class
994 A selection of general-utility list subroutines
996 =item Locale::Constants
998 Constants for Locale codes
1000 =item Locale::Country
1002 ISO codes for country identification (ISO 3166)
1004 =item Locale::Currency
1006 ISO three letter codes for currency identification (ISO 4217)
1008 =item Locale::Language
1010 ISO two letter codes for language identification (ISO 639)
1012 =item Locale::Maketext
1014 Framework for localization
1016 =item Locale::Maketext::TPJ13
1018 Article about software localization
1020 =item Locale::Script
1022 ISO codes for script identification (ISO 15924)
1026 Encoding and decoding of base64 strings
1028 =item MIME::Base64::QuotedPrint
1030 Encoding and decoding of quoted-printable strings
1032 =item Math::BigFloat
1034 Arbitrary size floating point math package
1038 Arbitrary size integer/float math package
1040 =item Math::BigInt::Calc
1042 Pure Perl module to support Math::BigInt
1044 =item Math::BigInt::CalcEmu
1046 Emulate low-level math with BigInt code
1048 =item Math::BigInt::FastCalc
1050 Math::BigInt::Calc with some XS for more speed
1054 Arbitrary big rational numbers
1058 Complex numbers and associated mathematical functions
1062 Trigonometric functions
1066 Make functions faster by trading space for time
1068 =item Memoize::AnyDBM_File
1070 Glue to provide EXISTS for AnyDBM_File for Storable use
1072 =item Memoize::Expire
1074 Plug-in module for automatic expiration of memoized values
1076 =item Memoize::ExpireFile
1078 Test for Memoize expiration semantics
1080 =item Memoize::ExpireTest
1082 Test for Memoize expiration semantics
1084 =item Memoize::NDBM_File
1086 Glue to provide EXISTS for NDBM_File for Storable use
1088 =item Memoize::SDBM_File
1090 Glue to provide EXISTS for SDBM_File for Storable use
1092 =item Memoize::Storable
1094 Store Memoized data in Storable database
1096 =item Module::CoreList
1098 What modules shipped with versions of perl
1102 Tied access to ndbm files
1106 Provide a pseudo-class NEXT (et al) that allows method redispatch
1110 Network Command class (as used by FTP, SMTP etc)
1114 Local configuration data for libnet
1118 Attempt to evaluate the current host's internet name and domain
1130 OO interface to users netrc file
1134 Post Office Protocol 3 Client class (RFC1939)
1138 Check a remote host for reachability
1142 Simple Mail Transfer Protocol Client
1146 Time and daytime network client interface
1150 By-name interface to Perl's built-in gethost*() functions
1152 =item Net::libnetFAQ
1154 Libnet Frequently Asked Questions
1158 By-name interface to Perl's built-in getnet*() functions
1162 By-name interface to Perl's built-in getproto*() functions
1166 By-name interface to Perl's built-in getserv*() functions
1170 Generic interface to Perl Compiler backends
1174 Tied access to odbm files
1178 Disable named opcodes when compiling perl code
1182 Perl interface to IEEE Std 1003.1
1186 On demand loader for PerlIO layers and root of PerlIO::* name space
1188 =item PerlIO::encoding
1192 =item PerlIO::scalar
1194 In-memory IO, scalar IO
1198 Helper class for PerlIO layers implemented in perl
1200 =item PerlIO::via::QuotedPrint
1202 PerlIO layer for quoted-printable strings
1206 Check pod documents for syntax errors
1210 For resolving Pod EE<lt>...E<gt> sequences
1214 Find POD documents in directory trees
1216 =item Pod::Functions
1218 Group Perl's functions a la perlfunc.pod
1222 Module to convert pod files to HTML
1224 =item Pod::InputObjects
1226 Objects representing POD input paragraphs, commands, etc.
1230 Convert Pod data to formatted Latex
1234 Convert POD data to formatted *roff input
1236 =item Pod::ParseLink
1238 Parse an LE<lt>E<gt> formatting code in POD text
1240 =item Pod::ParseUtils
1242 Helpers for POD parsing and conversion
1246 Base class for creating POD filters and translators
1248 =item Pod::Perldoc::ToChecker
1250 Let Perldoc check Pod for errors
1252 =item Pod::Perldoc::ToMan
1254 Let Perldoc render Pod as man pages
1256 =item Pod::Perldoc::ToNroff
1258 Let Perldoc convert Pod to nroff
1260 =item Pod::Perldoc::ToPod
1262 Let Perldoc render Pod as ... Pod!
1264 =item Pod::Perldoc::ToRtf
1266 Let Perldoc render Pod as RTF
1268 =item Pod::Perldoc::ToText
1270 Let Perldoc render Pod as plaintext
1272 =item Pod::Perldoc::ToTk
1274 Let Perldoc use Tk::Pod to render Pod
1276 =item Pod::Perldoc::ToXml
1278 Let Perldoc render Pod as XML
1280 =item Pod::PlainText
1282 Convert POD data to formatted ASCII text
1286 Perl extension for converting Pod to old style Pod.
1290 Extract selected sections of POD from input
1294 Framework for parsing Pod
1296 =item Pod::Simple::Checker
1298 Check the Pod syntax of a document
1300 =item Pod::Simple::Debug
1302 Put Pod::Simple into trace/debug mode
1304 =item Pod::Simple::DumpAsText
1306 Dump Pod-parsing events as text
1308 =item Pod::Simple::DumpAsXML
1312 =item Pod::Simple::HTML
1316 =item Pod::Simple::HTMLBatch
1318 Convert several Pod files to several HTML files
1320 =item Pod::Simple::LinkSection
1322 Represent "section" attributes of L codes
1324 =item Pod::Simple::Methody
1326 Turn Pod::Simple events into method calls
1328 =item Pod::Simple::PullParser
1330 A pull-parser interface to parsing Pod
1332 =item Pod::Simple::PullParserEndToken
1334 End-tokens from Pod::Simple::PullParser
1336 =item Pod::Simple::PullParserStartToken
1338 Start-tokens from Pod::Simple::PullParser
1340 =item Pod::Simple::PullParserTextToken
1342 Text-tokens from Pod::Simple::PullParser
1344 =item Pod::Simple::PullParserToken
1346 Tokens from Pod::Simple::PullParser
1348 =item Pod::Simple::RTF
1352 =item Pod::Simple::Search
1354 Find POD documents in directory trees
1356 =item Pod::Simple::SimpleTree
1358 Parse Pod into a simple parse tree
1360 =item Pod::Simple::Subclassing
1362 Write a formatter as a Pod::Simple subclass
1364 =item Pod::Simple::Text
1366 Format Pod as plaintext
1368 =item Pod::Simple::TextContent
1370 Get the text content of Pod
1372 =item Pod::Simple::XMLOutStream
1378 Convert POD data to formatted ASCII text
1380 =item Pod::Text::Color
1382 Convert POD data to formatted color ASCII text
1384 =item Pod::Text::Overstrike
1386 Convert POD data to formatted overstrike text
1388 =item Pod::Text::Termcap
1390 Convert POD data to ASCII text with format escapes
1394 Print a usage message from embedded pod documentation
1398 Tied access to sdbm files
1402 Compile and execute code in restricted compartments
1406 A selection of general-utility scalar subroutines
1410 Search for key in dictionary file
1414 Save and restore selected file handle
1418 Load functions only on demand
1422 Run shell commands transparently within perl
1426 Load the C socket.h defines and structure manipulators
1430 Persistence for Perl data structures
1434 A switch statement for Perl
1438 Manipulate Perl symbols and their names
1442 Try every conceivable way to get hostname
1446 Perl interface to the UNIX syslog(3) calls
1448 =item Term::ANSIColor
1450 Color screen output using ANSI escape sequences
1454 Perl termcap interface
1456 =item Term::Complete
1458 Perl word completion module
1460 =item Term::ReadLine
1462 Perl interface to various C<readline> packages.
1466 Provides a simple framework for writing test scripts
1470 Backend for building test libraries
1472 =item Test::Builder::Module
1474 Base class for test modules
1476 =item Test::Builder::Tester
1478 Test testsuites that have been built with
1480 =item Test::Builder::Tester::Color
1482 Turn on colour in Test::Builder::Tester
1486 Run Perl standard test scripts with statistics
1488 =item Test::Harness::Assert
1492 =item Test::Harness::Iterator
1494 Internal Test::Harness Iterator
1496 =item Test::Harness::Point
1498 Object for tracking a single test point
1500 =item Test::Harness::Straps
1502 Detailed analysis of test results
1504 =item Test::Harness::TAP
1506 Documentation for the TAP format
1510 Yet another framework for writing test scripts
1514 Basic utilities for writing tests.
1516 =item Test::Tutorial
1518 A tutorial about writing really basic tests
1522 Create an abbreviation table from a list
1524 =item Text::Balanced
1526 Extract delimited text sequences from strings.
1528 =item Text::ParseWords
1530 Parse text into an array of tokens or array of arrays
1534 Implementation of the Soundex Algorithm as Described by Knuth
1538 Expand and unexpand tabs per the unix expand(1) and unexpand(1)
1542 Line wrapping to form simple paragraphs
1546 Manipulate threads in Perl (for old code only)
1552 =item Thread::Semaphore
1554 Thread-safe semaphores
1556 =item Thread::Signal
1558 Start a thread which runs signal handlers reliably (for old code)
1560 =item Thread::Specific
1562 Thread-specific keys
1566 Base class for tied arrays
1570 Access the lines of a disk file via a Perl array
1574 Base class definitions for tied handles
1578 Base class definitions for tied hashes
1582 Add data to hash when needed
1586 Use references as hash keys
1590 Base class definitions for tied scalars
1592 =item Tie::SubstrHash
1594 Fixed-table-size, fixed-key-length hashing
1598 High resolution alarm, sleep, gettimeofday, interval timers
1602 Efficiently compute time from local and GMT time
1606 By-name interface to Perl's built-in gmtime() function
1608 =item Time::localtime
1610 By-name interface to Perl's built-in localtime() function
1614 Internal object used by Time::gmtime and Time::localtime
1618 Base class for ALL classes (blessed references)
1620 =item Unicode::Collate
1622 Unicode Collation Algorithm
1624 =item Unicode::Normalize
1626 Unicode Normalization Forms
1630 Unicode character database
1634 By-name interface to Perl's built-in getgr*() functions
1638 By-name interface to Perl's built-in getpw*() functions
1646 Module to test the XS typemaps distributed with perl
1650 Dynamically load C libraries into Perl code
1654 To find out I<all> modules installed on your system, including
1655 those without documentation or outside the standard release,
1656 just use the following command (under the default win32 shell,
1657 double quotes should be used instead of single quotes).
1659 % perl -MFile::Find=find -MFile::Spec::Functions -Tlwe \
1660 'find { wanted => sub { print canonpath $_ if /\.pm\z/ },
1661 no_chdir => 1 }, @INC'
1663 (The -T is here to prevent '.' from being listed in @INC.)
1664 They should all have their own documentation installed and accessible
1665 via your system man(1) command. If you do not have a B<find>
1666 program, you can use the Perl B<find2perl> program instead, which
1667 generates Perl code as output you can run through perl. If you
1668 have a B<man> program but it doesn't find your modules, you'll have
1669 to fix your manpath. See L<perl> for details. If you have no
1670 system B<man> command, you might try the B<perldoc> program.
1672 Note also that the command C<perldoc perllocal> gives you a (possibly
1673 incomplete) list of the modules that have been further installed on
1674 your system. (The perllocal.pod file is updated by the standard MakeMaker
1677 =head2 Extension Modules
1679 Extension modules are written in C (or a mix of Perl and C). They
1680 are usually dynamically loaded into Perl if and when you need them,
1681 but may also be linked in statically. Supported extension modules
1682 include Socket, Fcntl, and POSIX.
1684 Many popular C extension modules do not come bundled (at least, not
1685 completely) due to their sizes, volatility, or simply lack of time
1686 for adequate testing and configuration across the multitude of
1687 platforms on which Perl was beta-tested. You are encouraged to
1688 look for them on CPAN (described below), or using web search engines
1689 like Alta Vista or Google.
1693 CPAN stands for Comprehensive Perl Archive Network; it's a globally
1694 replicated trove of Perl materials, including documentation, style
1695 guides, tricks and traps, alternate ports to non-Unix systems and
1696 occasional binary distributions for these. Search engines for
1697 CPAN can be found at http://www.cpan.org/
1699 Most importantly, CPAN includes around a thousand unbundled modules,
1700 some of which require a C compiler to build. Major categories of
1707 Language Extensions and Documentation Tools
1715 Operating System Interfaces
1719 Networking, Device Control (modems) and InterProcess Communication
1723 Data Types and Data Type Utilities
1735 Interfaces to / Emulations of Other Programming Languages
1739 File Names, File Systems and File Locking (see also File Handles)
1743 String Processing, Language Text Processing, Parsing, and Searching
1747 Option, Argument, Parameter, and Configuration File Processing
1751 Internationalization and Locale
1755 Authentication, Security, and Encryption
1759 World Wide Web, HTML, HTTP, CGI, MIME
1763 Server and Daemon Utilities
1767 Archiving and Compression
1771 Images, Pixmap and Bitmap Manipulation, Drawing, and Graphing
1775 Mail and Usenet News
1779 Control Flow Utilities (callbacks and exceptions etc)
1783 File Handle and Input/Output Stream Utilities
1787 Miscellaneous Modules
1791 The list of the registered CPAN sites as of this writing follows.
1792 Please note that the sorting order is alphabetical on fields:
1798 |-->[state/province]
1804 and thus the North American servers happen to be listed between the
1805 European and the South American sites.
1807 You should try to choose one close to you.
1815 http://ftp.rucus.ru.ac.za/pub/perl/CPAN/
1816 ftp://ftp.rucus.ru.ac.za/pub/perl/CPAN/
1817 ftp://ftp.is.co.za/programming/perl/CPAN/
1818 ftp://ftp.saix.net/pub/CPAN/
1819 ftp://ftp.sun.ac.za/CPAN/CPAN/
1829 http://cpan.linuxforum.net/
1830 http://cpan.shellhung.org/
1831 ftp://ftp.shellhung.org/pub/CPAN
1832 ftp://mirrors.hknet.com/CPAN
1836 http://mirrors.tf.itb.ac.id/cpan/
1837 http://cpan.cbn.net.id/
1838 ftp://ftp.cbn.net.id/mirror/CPAN
1842 ftp://ftp.iglu.org.il/pub/CPAN/
1843 http://cpan.lerner.co.il/
1844 http://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
1845 ftp://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
1849 ftp://ftp.u-aizu.ac.jp/pub/CPAN
1850 ftp://ftp.kddlabs.co.jp/CPAN/
1851 ftp://ftp.ayamura.org/pub/CPAN/
1852 ftp://ftp.jaist.ac.jp/pub/lang/perl/CPAN/
1854 ftp://ftp.cpan.jp/CPAN/
1855 ftp://ftp.dti.ad.jp/pub/lang/CPAN/
1856 ftp://ftp.ring.gr.jp/pub/lang/perl/CPAN/
1860 http://cpan.MyBSD.org.my
1861 http://mirror.leafbug.org/pub/CPAN
1862 http://ossig.mncc.com.my/mirror/pub/CPAN
1864 =item Russian Federation
1866 http://cpan.tomsk.ru
1867 ftp://cpan.tomsk.ru/
1871 ftp://ftp.isu.net.sa/pub/CPAN/
1875 http://CPAN.en.com.sg/
1876 ftp://cpan.en.com.sg/
1877 http://mirror.averse.net/pub/CPAN
1878 ftp://mirror.averse.net/pub/CPAN
1879 http://cpan.oss.eznetsols.org
1880 ftp://ftp.oss.eznetsols.org/cpan
1884 http://CPAN.bora.net/
1885 ftp://ftp.bora.net/pub/CPAN/
1886 http://mirror.kr.FreeBSD.org/CPAN
1887 ftp://ftp.kr.FreeBSD.org/pub/CPAN
1891 ftp://ftp.nctu.edu.tw/UNIX/perl/CPAN
1892 http://cpan.cdpa.nsysu.edu.tw/
1893 ftp://cpan.cdpa.nsysu.edu.tw/pub/CPAN
1894 http://ftp.isu.edu.tw/pub/CPAN
1895 ftp://ftp.isu.edu.tw/pub/CPAN
1896 ftp://ftp1.sinica.edu.tw/pub1/perl/CPAN/
1897 http://ftp.tku.edu.tw/pub/CPAN/
1898 ftp://ftp.tku.edu.tw/pub/CPAN/
1902 ftp://ftp.loxinfo.co.th/pub/cpan/
1903 ftp://ftp.cs.riubon.ac.th/pub/mirrors/CPAN/
1907 =head2 Central America
1913 http://ftp.ucr.ac.cr/Unix/CPAN/
1914 ftp://ftp.ucr.ac.cr/pub/Unix/CPAN/
1924 http://cpan.inode.at/
1926 ftp://ftp.tuwien.ac.at/pub/CPAN/
1930 http://ftp.easynet.be/pub/CPAN/
1931 ftp://ftp.easynet.be/pub/CPAN/
1932 http://cpan.skynet.be
1933 ftp://ftp.cpan.skynet.be/pub/CPAN
1934 ftp://ftp.kulnet.kuleuven.ac.be/pub/mirror/CPAN/
1936 =item Bosnia and Herzegovina
1938 http://cpan.blic.net/
1942 http://cpan.online.bg
1943 ftp://cpan.online.bg/cpan
1944 http://cpan.zadnik.org
1945 ftp://ftp.zadnik.org/mirrors/CPAN/
1946 http://cpan.lirex.net/
1947 ftp://ftp.lirex.net/pub/mirrors/CPAN
1951 http://ftp.linux.hr/pub/CPAN/
1952 ftp://ftp.linux.hr/pub/CPAN/
1954 =item Czech Republic
1956 ftp://ftp.fi.muni.cz/pub/CPAN/
1957 ftp://sunsite.mff.cuni.cz/MIRRORS/ftp.funet.fi/pub/languages/perl/CPAN/
1961 http://mirrors.sunsite.dk/cpan/
1962 ftp://sunsite.dk/mirrors/cpan/
1963 http://cpan.cybercity.dk
1964 http://www.cpan.dk/CPAN/
1965 ftp://www.cpan.dk/ftp.cpan.org/CPAN/
1969 ftp://ftp.ut.ee/pub/languages/perl/CPAN/
1973 ftp://ftp.funet.fi/pub/languages/perl/CPAN/
1974 http://mirror.eunet.fi/CPAN
1978 http://www.enstimac.fr/Perl/CPAN
1979 http://ftp.u-paris10.fr/perl/CPAN
1980 ftp://ftp.u-paris10.fr/perl/CPAN
1981 http://cpan.mirrors.easynet.fr/
1982 ftp://cpan.mirrors.easynet.fr/pub/ftp.cpan.org/
1983 ftp://ftp.club-internet.fr/pub/perl/CPAN/
1985 ftp://ftp.lip6.fr/pub/perl/CPAN/
1986 ftp://ftp.oleane.net/pub/mirrors/CPAN/
1987 ftp://ftp.pasteur.fr/pub/computing/CPAN/
1988 http://mir2.ovh.net/ftp.cpan.org
1989 ftp://mir1.ovh.net/ftp.cpan.org
1990 http://ftp.crihan.fr/mirrors/ftp.cpan.org/
1991 ftp://ftp.crihan.fr/mirrors/ftp.cpan.org/
1992 http://ftp.u-strasbg.fr/CPAN
1993 ftp://ftp.u-strasbg.fr/CPAN
1994 ftp://cpan.cict.fr/pub/CPAN/
1995 ftp://ftp.uvsq.fr/pub/perl/CPAN/
1999 ftp://ftp.rub.de/pub/CPAN/
2000 ftp://ftp.freenet.de/pub/ftp.cpan.org/pub/CPAN/
2001 ftp://ftp.uni-erlangen.de/pub/source/CPAN/
2002 ftp://ftp-stud.fht-esslingen.de/pub/Mirrors/CPAN
2003 http://pandemonium.tiscali.de/pub/CPAN/
2004 ftp://pandemonium.tiscali.de/pub/CPAN/
2005 http://ftp.gwdg.de/pub/languages/perl/CPAN/
2006 ftp://ftp.gwdg.de/pub/languages/perl/CPAN/
2007 ftp://ftp.uni-hamburg.de/pub/soft/lang/perl/CPAN/
2008 ftp://ftp.leo.org/pub/CPAN/
2009 http://cpan.noris.de/
2010 ftp://cpan.noris.de/pub/CPAN/
2011 ftp://ftp.mpi-sb.mpg.de/pub/perl/CPAN/
2012 ftp://ftp.gmd.de/mirrors/CPAN/
2016 ftp://ftp.acn.gr/pub/lang/perl
2017 ftp://ftp.forthnet.gr/pub/languages/perl/CPAN
2018 ftp://ftp.ntua.gr/pub/lang/perl/
2022 http://ftp.kfki.hu/packages/perl/CPAN/
2023 ftp://ftp.kfki.hu/pub/packages/perl/CPAN/
2027 http://ftp.rhnet.is/pub/CPAN/
2028 ftp://ftp.rhnet.is/pub/CPAN/
2032 http://cpan.indigo.ie/
2033 ftp://cpan.indigo.ie/pub/CPAN/
2034 http://ftp.heanet.ie/mirrors/ftp.perl.org/pub/CPAN
2035 ftp://ftp.heanet.ie/mirrors/ftp.perl.org/pub/CPAN
2036 http://sunsite.compapp.dcu.ie/pub/perl/
2037 ftp://sunsite.compapp.dcu.ie/pub/perl/
2041 http://cpan.nettuno.it/
2042 http://gusp.dyndns.org/CPAN/
2043 ftp://gusp.dyndns.org/pub/CPAN
2044 http://softcity.iol.it/cpan
2045 ftp://softcity.iol.it/pub/cpan
2046 ftp://ftp.unina.it/pub/Other/CPAN/CPAN/
2047 ftp://ftp.unipi.it/pub/mirror/perl/CPAN/
2048 ftp://cis.uniRoma2.it/CPAN/
2049 ftp://ftp.edisontel.it/pub/CPAN_Mirror/
2050 http://cpan.flashnet.it/
2051 ftp://ftp.flashnet.it/pub/CPAN/
2055 http://kvin.lv/pub/CPAN/
2059 ftp://ftp.unix.lt/pub/CPAN/
2063 ftp://download.xs4all.nl/pub/mirror/CPAN/
2064 ftp://ftp.nl.uu.net/pub/CPAN/
2065 ftp://ftp.nluug.nl/pub/languages/perl/CPAN/
2066 http://cpan.cybercomm.nl/
2067 ftp://mirror.cybercomm.nl/pub/CPAN
2068 ftp://mirror.vuurwerk.nl/pub/CPAN/
2069 ftp://ftp.cpan.nl/pub/CPAN/
2070 http://ftp.easynet.nl/mirror/CPAN
2071 ftp://ftp.easynet.nl/mirror/CPAN
2072 http://archive.cs.uu.nl/mirror/CPAN/
2073 ftp://ftp.cs.uu.nl/mirror/CPAN/
2077 ftp://ftp.uninett.no/pub/languages/perl/CPAN
2078 ftp://ftp.uit.no/pub/languages/perl/cpan/
2082 ftp://ftp.mega.net.pl/CPAN
2083 ftp://ftp.man.torun.pl/pub/doc/CPAN/
2084 ftp://sunsite.icm.edu.pl/pub/CPAN/
2088 ftp://ftp.ua.pt/pub/CPAN/
2089 ftp://perl.di.uminho.pt/pub/CPAN/
2090 http://cpan.dei.uc.pt/
2091 ftp://ftp.dei.uc.pt/pub/CPAN
2092 ftp://ftp.nfsi.pt/pub/CPAN
2093 http://ftp.linux.pt/pub/mirrors/CPAN
2094 ftp://ftp.linux.pt/pub/mirrors/CPAN
2096 ftp://cpan.ip.pt/pub/cpan/
2097 http://cpan.telepac.pt/
2098 ftp://ftp.telepac.pt/pub/cpan/
2102 ftp://ftp.bio-net.ro/pub/CPAN
2103 ftp://ftp.kappa.ro/pub/mirrors/ftp.perl.org/pub/CPAN/
2104 ftp://ftp.lug.ro/CPAN
2105 ftp://ftp.roedu.net/pub/CPAN/
2106 ftp://ftp.dntis.ro/pub/cpan/
2107 ftp://ftp.iasi.roedu.net/pub/mirrors/ftp.cpan.org/
2108 http://cpan.ambra.ro/
2109 ftp://ftp.ambra.ro/pub/CPAN
2110 ftp://ftp.dnttm.ro/pub/CPAN/
2111 ftp://ftp.lasting.ro/pub/CPAN
2112 ftp://ftp.timisoara.roedu.net/mirrors/CPAN/
2116 ftp://ftp.chg.ru/pub/lang/perl/CPAN/
2117 http://cpan.rinet.ru/
2118 ftp://cpan.rinet.ru/pub/mirror/CPAN/
2119 ftp://ftp.aha.ru/pub/CPAN/
2120 ftp://ftp.corbina.ru/pub/CPAN/
2121 http://cpan.sai.msu.ru/
2122 ftp://ftp.sai.msu.su/pub/lang/perl/CPAN/
2126 ftp://ftp.cvt.stuba.sk/pub/CPAN/
2130 ftp://ftp.arnes.si/software/perl/CPAN/
2134 http://cpan.imasd.elmundo.es/
2135 ftp://ftp.rediris.es/mirror/CPAN/
2136 ftp://ftp.ri.telefonica-data.net/CPAN
2137 ftp://ftp.etse.urv.es/pub/perl/
2141 http://ftp.du.se/CPAN/
2142 ftp://ftp.du.se/pub/CPAN/
2143 http://mirror.dataphone.se/CPAN
2144 ftp://mirror.dataphone.se/pub/CPAN
2145 ftp://ftp.sunet.se/pub/lang/perl/CPAN/
2149 http://cpan.mirror.solnet.ch/
2150 ftp://ftp.solnet.ch/mirror/CPAN/
2151 ftp://ftp.danyk.ch/CPAN/
2152 ftp://sunsite.cnlab-switch.ch/mirror/CPAN/
2156 http://ftp.ulak.net.tr/perl/CPAN/
2157 ftp://ftp.ulak.net.tr/perl/CPAN
2158 ftp://sunsite.bilkent.edu.tr/pub/languages/CPAN/
2164 ftp://ftp.perl.org.ua/pub/CPAN/
2165 http://no-more.kiev.ua/CPAN/
2166 ftp://no-more.kiev.ua/pub/CPAN/
2168 =item United Kingdom
2170 http://www.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN
2171 ftp://ftp.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN/
2172 http://cpan.teleglobe.net/
2173 ftp://cpan.teleglobe.net/pub/CPAN
2174 http://cpan.mirror.anlx.net/
2175 ftp://ftp.mirror.anlx.net/CPAN/
2176 http://cpan.etla.org/
2177 ftp://cpan.etla.org/pub/CPAN
2178 ftp://ftp.demon.co.uk/pub/CPAN/
2179 http://cpan.m.flirble.org/
2180 ftp://ftp.flirble.org/pub/languages/perl/CPAN/
2181 ftp://ftp.plig.org/pub/CPAN/
2182 http://cpan.hambule.co.uk/
2183 http://cpan.mirrors.clockerz.net/
2184 ftp://ftp.clockerz.net/pub/CPAN/
2185 ftp://usit.shef.ac.uk/pub/packages/CPAN/
2189 =head2 North America
2199 http://cpan.sunsite.ualberta.ca/
2200 ftp://cpan.sunsite.ualberta.ca/pub/CPAN/
2204 http://theoryx5.uwinnipeg.ca/pub/CPAN/
2205 ftp://theoryx5.uwinnipeg.ca/pub/CPAN/
2209 ftp://cpan.chebucto.ns.ca/pub/CPAN/
2213 ftp://ftp.nrc.ca/pub/CPAN/
2219 http://cpan.azc.uam.mx
2220 ftp://cpan.azc.uam.mx/mirrors/CPAN
2221 http://www.cpan.unam.mx/
2222 ftp://ftp.unam.mx/pub/CPAN
2223 http://www.msg.com.mx/CPAN/
2224 ftp://ftp.msg.com.mx/pub/CPAN/
2232 http://mirror.hiwaay.net/CPAN/
2233 ftp://mirror.hiwaay.net/CPAN/
2237 http://cpan.develooper.com/
2238 http://www.cpan.org/
2239 ftp://cpan.valueclick.com/pub/CPAN/
2240 http://www.mednor.net/ftp/pub/mirrors/CPAN/
2241 ftp://ftp.mednor.net/pub/mirrors/CPAN/
2242 http://mirrors.gossamer-threads.com/CPAN
2243 ftp://cpan.nas.nasa.gov/pub/perl/CPAN/
2244 http://mirrors.kernel.org/cpan/
2245 ftp://mirrors.kernel.org/pub/CPAN
2246 http://cpan-sj.viaverio.com/
2247 ftp://cpan-sj.viaverio.com/pub/CPAN/
2248 http://cpan.digisle.net/
2249 ftp://cpan.digisle.net/pub/CPAN
2250 http://www.perl.com/CPAN/
2251 http://www.uberlan.net/CPAN
2255 ftp://ftp.cs.colorado.edu/pub/perl/CPAN/
2256 http://cpan.four10.com
2260 http://ftp.lug.udel.edu/pub/CPAN
2261 ftp://ftp.lug.udel.edu/pub/CPAN
2263 =item District of Columbia
2265 ftp://ftp.dc.aleron.net/pub/CPAN/
2269 ftp://ftp.cise.ufl.edu/pub/mirrors/CPAN/
2270 http://mirror.csit.fsu.edu/pub/CPAN/
2271 ftp://mirror.csit.fsu.edu/pub/CPAN/
2272 http://cpan.mirrors.nks.net/
2276 ftp://ftp.uwsg.iu.edu/pub/perl/CPAN/
2277 http://cpan.netnitco.net/
2278 ftp://cpan.netnitco.net/pub/mirrors/CPAN/
2279 http://archive.progeny.com/CPAN/
2280 ftp://archive.progeny.com/CPAN/
2281 http://fx.saintjoe.edu/pub/CPAN
2282 ftp://ftp.saintjoe.edu/pub/CPAN
2283 http://csociety-ftp.ecn.purdue.edu/pub/CPAN
2284 ftp://csociety-ftp.ecn.purdue.edu/pub/CPAN
2288 http://cpan.uky.edu/
2289 ftp://cpan.uky.edu/pub/CPAN/
2290 http://slugsite.louisville.edu/cpan
2291 ftp://slugsite.louisville.edu/CPAN
2295 http://mirrors.towardex.com/CPAN
2296 ftp://mirrors.towardex.com/pub/CPAN
2297 ftp://ftp.ccs.neu.edu/net/mirrors/ftp.funet.fi/pub/languages/perl/CPAN/
2301 ftp://cpan.cse.msu.edu/
2302 http://cpan.calvin.edu/pub/CPAN
2303 ftp://cpan.calvin.edu/pub/CPAN
2307 http://www.oss.redundant.com/pub/CPAN
2308 ftp://www.oss.redundant.com/pub/CPAN
2312 http://ftp.cpanel.net/pub/CPAN/
2313 ftp://ftp.cpanel.net/pub/CPAN/
2314 http://cpan.teleglobe.net/
2315 ftp://cpan.teleglobe.net/pub/CPAN
2319 http://cpan.belfry.net/
2320 http://cpan.erlbaum.net/
2321 ftp://cpan.erlbaum.net/
2322 http://cpan.thepirtgroup.com/
2323 ftp://cpan.thepirtgroup.com/
2324 ftp://ftp.stealth.net/pub/CPAN/
2325 http://www.rge.com/pub/languages/perl/
2326 ftp://ftp.rge.com/pub/languages/perl/
2328 =item North Carolina
2330 http://www.ibiblio.org/pub/languages/perl/CPAN
2331 ftp://ftp.ibiblio.org/pub/languages/perl/CPAN
2332 ftp://ftp.duke.edu/pub/perl/
2333 ftp://ftp.ncsu.edu/pub/mirror/CPAN/
2337 ftp://ftp.ou.edu/mirrors/CPAN/
2341 ftp://ftp.orst.edu/pub/CPAN
2345 http://ftp.epix.net/CPAN/
2346 ftp://ftp.epix.net/pub/languages/perl/
2347 http://mirrors.phenominet.com/pub/CPAN/
2348 ftp://mirrors.phenominet.com/pub/CPAN/
2349 http://cpan.pair.com/
2350 ftp://cpan.pair.com/pub/CPAN/
2351 ftp://carroll.cac.psu.edu/pub/CPAN/
2355 ftp://ftp.sunsite.utk.edu/pub/CPAN/
2359 http://ftp.sedl.org/pub/mirrors/CPAN/
2360 http://www.binarycode.org/cpan
2361 ftp://mirror.telentente.com/pub/CPAN
2362 http://mirrors.theonlinerecordstore.com/CPAN
2366 ftp://mirror.xmission.com/CPAN/
2370 http://cpan-du.viaverio.com/
2371 ftp://cpan-du.viaverio.com/pub/CPAN/
2372 http://mirrors.rcn.net/pub/lang/CPAN/
2373 ftp://mirrors.rcn.net/pub/lang/CPAN/
2374 http://perl.secsup.org/
2375 ftp://perl.secsup.org/pub/perl/
2376 http://noc.cvaix.com/mirrors/CPAN/
2380 http://cpan.llarian.net/
2381 ftp://cpan.llarian.net/pub/CPAN/
2382 http://cpan.mirrorcentral.com/
2383 ftp://ftp.mirrorcentral.com/pub/CPAN/
2384 ftp://ftp-mirror.internap.com/pub/CPAN/
2388 http://mirror.sit.wisc.edu/pub/CPAN/
2389 ftp://mirror.sit.wisc.edu/pub/CPAN/
2390 http://mirror.aphix.com/CPAN
2391 ftp://mirror.aphix.com/pub/CPAN
2403 http://ftp.planetmirror.com/pub/CPAN/
2404 ftp://ftp.planetmirror.com/pub/CPAN/
2405 ftp://mirror.aarnet.edu.au/pub/perl/CPAN/
2406 ftp://cpan.topend.com.au/pub/CPAN/
2407 http://cpan.mirrors.ilisys.com.au
2411 ftp://ftp.auckland.ac.nz/pub/perl/CPAN/
2415 http://aniani.ifa.hawaii.edu/CPAN/
2416 ftp://aniani.ifa.hawaii.edu/CPAN/
2420 =head2 South America
2426 ftp://mirrors.bannerlandia.com.ar/mirrors/CPAN/
2427 http://www.linux.org.ar/mirrors/cpan
2428 ftp://ftp.linux.org.ar/mirrors/cpan
2432 ftp://cpan.pop-mg.com.br/pub/CPAN/
2433 ftp://ftp.matrix.com.br/pub/perl/CPAN/
2434 http://cpan.hostsul.com.br/
2435 ftp://cpan.hostsul.com.br/
2439 http://cpan.netglobalis.net/
2440 ftp://cpan.netglobalis.net/pub/CPAN/
2444 =head2 RSYNC Mirrors
2446 www.linux.org.ar::cpan
2447 theoryx5.uwinnipeg.ca::CPAN
2448 ftp.shellhung.org::CPAN
2449 rsync.nic.funet.fi::CPAN
2450 ftp.u-paris10.fr::CPAN
2452 rsync://ftp.crihan.fr::CPAN
2453 ftp.gwdg.de::FTP/languages/perl/CPAN/
2455 ftp.cbn.net.id::CPAN
2456 rsync://ftp.heanet.ie/mirrors/ftp.perl.org/pub/CPAN
2457 ftp.iglu.org.il::CPAN
2458 gusp.dyndns.org::cpan
2459 ftp.kddlabs.co.jp::cpan
2460 ftp.ayamura.org::pub/CPAN/
2461 mirror.leafbug.org::CPAN
2462 rsync.en.com.sg::CPAN
2463 mirror.averse.net::cpan
2464 rsync.oss.eznetsols.org
2465 ftp.kr.FreeBSD.org::CPAN
2467 cpan.cdpa.nsysu.edu.tw::CPAN
2468 cpan.teleglobe.net::CPAN
2469 rsync://rsync.mirror.anlx.net::CPAN
2472 cpan-du.viaverio.com::CPAN
2473 aniani.ifa.hawaii.edu::CPAN
2474 archive.progeny.com::CPAN
2475 rsync://slugsite.louisville.edu::CPAN
2476 mirror.aphix.com::CPAN
2477 cpan.teleglobe.net::CPAN
2478 ftp.lug.udel.edu::cpan
2479 mirrors.kernel.org::mirrors/CPAN
2480 mirrors.phenominet.com::CPAN
2482 cpan-sj.viaverio.com::CPAN
2483 mirror.csit.fsu.edu::CPAN
2484 csociety-ftp.ecn.purdue.edu::CPAN
2486 For an up-to-date listing of CPAN sites,
2487 see http://www.cpan.org/SITES or ftp://www.cpan.org/SITES .
2489 =head1 Modules: Creation, Use, and Abuse
2491 (The following section is borrowed directly from Tim Bunce's modules
2492 file, available at your nearest CPAN site.)
2494 Perl implements a class using a package, but the presence of a
2495 package doesn't imply the presence of a class. A package is just a
2496 namespace. A class is a package that provides subroutines that can be
2497 used as methods. A method is just a subroutine that expects, as its
2498 first argument, either the name of a package (for "static" methods),
2499 or a reference to something (for "virtual" methods).
2501 A module is a file that (by convention) provides a class of the same
2502 name (sans the .pm), plus an import method in that class that can be
2503 called to fetch exported symbols. This module may implement some of
2504 its methods by loading dynamic C or C++ objects, but that should be
2505 totally transparent to the user of the module. Likewise, the module
2506 might set up an AUTOLOAD function to slurp in subroutine definitions on
2507 demand, but this is also transparent. Only the F<.pm> file is required to
2508 exist. See L<perlsub>, L<perltoot>, and L<AutoLoader> for details about
2509 the AUTOLOAD mechanism.
2511 =head2 Guidelines for Module Creation
2517 Do similar modules already exist in some form?
2519 If so, please try to reuse the existing modules either in whole or
2520 by inheriting useful features into a new class. If this is not
2521 practical try to get together with the module authors to work on
2522 extending or enhancing the functionality of the existing modules.
2523 A perfect example is the plethora of packages in perl4 for dealing
2524 with command line options.
2526 If you are writing a module to expand an already existing set of
2527 modules, please coordinate with the author of the package. It
2528 helps if you follow the same naming scheme and module interaction
2529 scheme as the original author.
2533 Try to design the new module to be easy to extend and reuse.
2535 Try to C<use warnings;> (or C<use warnings qw(...);>).
2536 Remember that you can add C<no warnings qw(...);> to individual blocks
2537 of code that need less warnings.
2539 Use blessed references. Use the two argument form of bless to bless
2540 into the class name given as the first parameter of the constructor,
2545 return bless {}, $class;
2548 or even this if you'd like it to be used as either a static
2549 or a virtual method.
2553 my $class = ref($self) || $self;
2554 return bless {}, $class;
2557 Pass arrays as references so more parameters can be added later
2558 (it's also faster). Convert functions into methods where
2559 appropriate. Split large methods into smaller more flexible ones.
2560 Inherit methods from other modules if appropriate.
2562 Avoid class name tests like: C<die "Invalid" unless ref $ref eq 'FOO'>.
2563 Generally you can delete the C<eq 'FOO'> part with no harm at all.
2564 Let the objects look after themselves! Generally, avoid hard-wired
2565 class names as far as possible.
2567 Avoid C<< $r->Class::func() >> where using C<@ISA=qw(... Class ...)> and
2568 C<< $r->func() >> would work (see L<perlbot> for more details).
2570 Use autosplit so little used or newly added functions won't be a
2571 burden to programs that don't use them. Add test functions to
2572 the module after __END__ either using AutoSplit or by saying:
2574 eval join('',<main::DATA>) || die $@ unless caller();
2576 Does your module pass the 'empty subclass' test? If you say
2577 C<@SUBCLASS::ISA = qw(YOURCLASS);> your applications should be able
2578 to use SUBCLASS in exactly the same way as YOURCLASS. For example,
2579 does your application still work if you change: C<$obj = new YOURCLASS;>
2580 into: C<$obj = new SUBCLASS;> ?
2582 Avoid keeping any state information in your packages. It makes it
2583 difficult for multiple other packages to use yours. Keep state
2584 information in objects.
2588 Try to C<use strict;> (or C<use strict qw(...);>).
2589 Remember that you can add C<no strict qw(...);> to individual blocks
2590 of code that need less strictness.
2594 Follow the guidelines in the perlstyle(1) manual.
2600 Some simple style guidelines
2602 The perlstyle manual supplied with Perl has many helpful points.
2604 Coding style is a matter of personal taste. Many people evolve their
2605 style over several years as they learn what helps them write and
2606 maintain good code. Here's one set of assorted suggestions that
2607 seem to be widely used by experienced developers:
2609 Use underscores to separate words. It is generally easier to read
2610 $var_names_like_this than $VarNamesLikeThis, especially for
2611 non-native speakers of English. It's also a simple rule that works
2612 consistently with VAR_NAMES_LIKE_THIS.
2614 Package/Module names are an exception to this rule. Perl informally
2615 reserves lowercase module names for 'pragma' modules like integer
2616 and strict. Other modules normally begin with a capital letter and
2617 use mixed case with no underscores (need to be short and portable).
2619 You may find it helpful to use letter case to indicate the scope
2620 or nature of a variable. For example:
2622 $ALL_CAPS_HERE constants only (beware clashes with Perl vars)
2623 $Some_Caps_Here package-wide global/static
2624 $no_caps_here function scope my() or local() variables
2626 Function and method names seem to work best as all lowercase.
2627 e.g., C<< $obj->as_string() >>.
2629 You can use a leading underscore to indicate that a variable or
2630 function should not be used outside the package that defined it.
2634 Select what to export.
2636 Do NOT export method names!
2638 Do NOT export anything else by default without a good reason!
2640 Exports pollute the namespace of the module user. If you must
2641 export try to use @EXPORT_OK in preference to @EXPORT and avoid
2642 short or common names to reduce the risk of name clashes.
2644 Generally anything not exported is still accessible from outside the
2645 module using the ModuleName::item_name (or C<< $blessed_ref->method >>)
2646 syntax. By convention you can use a leading underscore on names to
2647 indicate informally that they are 'internal' and not for public use.
2649 (It is actually possible to get private functions by saying:
2650 C<my $subref = sub { ... }; &$subref;>. But there's no way to call that
2651 directly as a method, because a method must have a name in the symbol
2654 As a general rule, if the module is trying to be object oriented
2655 then export nothing. If it's just a collection of functions then
2656 @EXPORT_OK anything but use @EXPORT with caution.
2660 Select a name for the module.
2662 This name should be as descriptive, accurate, and complete as
2663 possible. Avoid any risk of ambiguity. Always try to use two or
2664 more whole words. Generally the name should reflect what is special
2665 about what the module does rather than how it does it. Please use
2666 nested module names to group informally or categorize a module.
2667 There should be a very good reason for a module not to have a nested name.
2668 Module names should begin with a capital letter.
2670 Having 57 modules all called Sort will not make life easy for anyone
2671 (though having 23 called Sort::Quick is only marginally better :-).
2672 Imagine someone trying to install your module alongside many others.
2673 If in any doubt ask for suggestions in comp.lang.perl.misc.
2675 If you are developing a suite of related modules/classes it's good
2676 practice to use nested classes with a common prefix as this will
2677 avoid namespace clashes. For example: Xyz::Control, Xyz::View,
2678 Xyz::Model etc. Use the modules in this list as a naming guide.
2680 If adding a new module to a set, follow the original author's
2681 standards for naming modules and the interface to methods in
2684 If developing modules for private internal or project specific use,
2685 that will never be released to the public, then you should ensure
2686 that their names will not clash with any future public module. You
2687 can do this either by using the reserved Local::* category or by
2688 using a category name that includes an underscore like Foo_Corp::*.
2690 To be portable each component of a module name should be limited to
2691 11 characters. If it might be used on MS-DOS then try to ensure each is
2692 unique in the first 8 characters. Nested modules make this easier.
2696 Have you got it right?
2698 How do you know that you've made the right decisions? Have you
2699 picked an interface design that will cause problems later? Have
2700 you picked the most appropriate name? Do you have any questions?
2702 The best way to know for sure, and pick up many helpful suggestions,
2703 is to ask someone who knows. Comp.lang.perl.misc is read by just about
2704 all the people who develop modules and it's the best place to ask.
2706 All you need to do is post a short summary of the module, its
2707 purpose and interfaces. A few lines on each of the main methods is
2708 probably enough. (If you post the whole module it might be ignored
2709 by busy people - generally the very people you want to read it!)
2711 Don't worry about posting if you can't say when the module will be
2712 ready - just say so in the message. It might be worth inviting
2713 others to help you, they may be able to complete it for you!
2717 README and other Additional Files.
2719 It's well known that software developers usually fully document the
2720 software they write. If, however, the world is in urgent need of
2721 your software and there is not enough time to write the full
2722 documentation please at least provide a README file containing:
2728 A description of the module/package/extension etc.
2732 A copyright notice - see below.
2736 Prerequisites - what else you may need to have.
2740 How to build it - possible changes to Makefile.PL etc.
2748 Recent changes in this release, especially incompatibilities
2752 Changes / enhancements you plan to make in the future.
2756 If the README file seems to be getting too large you may wish to
2757 split out some of the sections into separate files: INSTALL,
2764 Adding a Copyright Notice.
2766 How you choose to license your work is a personal decision.
2767 The general mechanism is to assert your Copyright and then make
2768 a declaration of how others may copy/use/modify your work.
2770 Perl, for example, is supplied with two types of licence: The GNU GPL
2771 and The Artistic Licence (see the files README, Copying, and Artistic,
2772 or L<perlgpl> and L<perlartistic>). Larry has good reasons for NOT
2773 just using the GNU GPL.
2775 My personal recommendation, out of respect for Larry, Perl, and the
2776 Perl community at large is to state something simply like:
2778 Copyright (c) 1995 Your Name. All rights reserved.
2779 This program is free software; you can redistribute it and/or
2780 modify it under the same terms as Perl itself.
2782 This statement should at least appear in the README file. You may
2783 also wish to include it in a Copying file and your source files.
2784 Remember to include the other words in addition to the Copyright.
2788 Give the module a version/issue/release number.
2790 To be fully compatible with the Exporter and MakeMaker modules you
2791 should store your module's version number in a non-my package
2792 variable called $VERSION. This should be a floating point
2793 number with at least two digits after the decimal (i.e., hundredths,
2794 e.g, C<$VERSION = "0.01">). Don't use a "1.3.2" style version.
2795 See L<Exporter> for details.
2797 It may be handy to add a function or method to retrieve the number.
2798 Use the number in announcements and archive file names when
2799 releasing the module (ModuleName-1.02.tar.Z).
2800 See perldoc ExtUtils::MakeMaker.pm for details.
2804 How to release and distribute a module.
2806 It's good idea to post an announcement of the availability of your
2807 module (or the module itself if small) to the comp.lang.perl.announce
2808 Usenet newsgroup. This will at least ensure very wide once-off
2811 If possible, register the module with CPAN. You should
2812 include details of its location in your announcement.
2814 Some notes about ftp archives: Please use a long descriptive file
2815 name that includes the version number. Most incoming directories
2816 will not be readable/listable, i.e., you won't be able to see your
2817 file after uploading it. Remember to send your email notification
2818 message as soon as possible after uploading else your file may get
2819 deleted automatically. Allow time for the file to be processed
2820 and/or check the file has been processed before announcing its
2823 FTP Archives for Perl Modules:
2825 Follow the instructions and links on:
2827 http://www.cpan.org/modules/00modlist.long.html
2828 http://www.cpan.org/modules/04pause.html
2830 or upload to one of these sites:
2832 https://pause.kbx.de/pause/
2833 http://pause.perl.org/pause/
2835 and notify <modules@perl.org>.
2837 By using the WWW interface you can ask the Upload Server to mirror
2838 your modules from your ftp or WWW site into your own directory on
2841 Please remember to send me an updated entry for the Module list!
2845 Take care when changing a released module.
2847 Always strive to remain compatible with previous released versions.
2848 Otherwise try to add a mechanism to revert to the
2849 old behavior if people rely on it. Document incompatible changes.
2855 =head2 Guidelines for Converting Perl 4 Library Scripts into Modules
2861 There is no requirement to convert anything.
2863 If it ain't broke, don't fix it! Perl 4 library scripts should
2864 continue to work with no problems. You may need to make some minor
2865 changes (like escaping non-array @'s in double quoted strings) but
2866 there is no need to convert a .pl file into a Module for just that.
2870 Consider the implications.
2872 All Perl applications that make use of the script will need to
2873 be changed (slightly) if the script is converted into a module. Is
2874 it worth it unless you plan to make other changes at the same time?
2878 Make the most of the opportunity.
2880 If you are going to convert the script to a module you can use the
2881 opportunity to redesign the interface. The guidelines for module
2882 creation above include many of the issues you should consider.
2886 The pl2pm utility will get you started.
2888 This utility will read *.pl files (given as parameters) and write
2889 corresponding *.pm files. The pl2pm utilities does the following:
2895 Adds the standard Module prologue lines
2899 Converts package specifiers from ' to ::
2903 Converts die(...) to croak(...)
2907 Several other minor changes
2911 Being a mechanical process pl2pm is not bullet proof. The converted
2912 code will need careful checking, especially any package statements.
2913 Don't delete the original .pl file till the new .pm one works!
2917 =head2 Guidelines for Reusing Application Code
2923 Complete applications rarely belong in the Perl Module Library.
2927 Many applications contain some Perl code that could be reused.
2929 Help save the world! Share your code in a form that makes it easy
2934 Break-out the reusable code into one or more separate module files.
2938 Take the opportunity to reconsider and redesign the interfaces.
2942 In some cases the 'application' can then be reduced to a small
2944 fragment of code built on top of the reusable modules. In these cases
2945 the application could invoked as:
2947 % perl -e 'use Module::Name; method(@ARGV)' ...
2949 % perl -mModule::Name ... (in perl5.002 or higher)
2955 Perl does not enforce private and public parts of its modules as you may
2956 have been used to in other languages like C++, Ada, or Modula-17. Perl
2957 doesn't have an infatuation with enforced privacy. It would prefer
2958 that you stayed out of its living room because you weren't invited, not
2959 because it has a shotgun.
2961 The module and its user have a contract, part of which is common law,
2962 and part of which is "written". Part of the common law contract is
2963 that a module doesn't pollute any namespace it wasn't asked to. The
2964 written contract for the module (A.K.A. documentation) may make other
2965 provisions. But then you know when you C<use RedefineTheWorld> that
2966 you're redefining the world and willing to take the consequences.