2 Generated by perlmodlib.PL -- DO NOT EDIT!
6 perlmodlib - constructing new Perl modules and finding existing ones
10 =head1 THE PERL MODULE LIBRARY
12 Many modules are included the Perl distribution. These are described
13 below, and all end in F<.pm>. You may discover compiled library
14 file (usually ending in F<.so>) or small pieces of modules to be
15 autoloaded (ending in F<.al>); these were automatically generated
16 by the installation process. You may also discover files in the
17 library directory that end in either F<.pl> or F<.ph>. These are
18 old libraries supplied so that old programs that use them still
19 run. The F<.pl> files will all eventually be converted into standard
20 modules, and the F<.ph> files made by B<h2ph> will probably end up
21 as extension modules made by B<h2xs>. (Some F<.ph> values may
22 already be available through the POSIX, Errno, or Fcntl modules.)
23 The B<pl2pm> file in the distribution may help in your conversion,
24 but it's just a mechanical process and therefore far from bulletproof.
26 =head2 Pragmatic Modules
28 They work somewhat like compiler directives (pragmata) in that they
29 tend to affect the compilation of your program, and thus will usually
30 work well only when used within a C<use>, or C<no>. Most of these
31 are lexically scoped, so an inner BLOCK may countermand them
38 which lasts until the end of that BLOCK.
40 Some pragmas are lexically scoped--typically those that affect the
41 C<$^H> hints variable. Others affect the current package instead,
42 like C<use vars> and C<use subs>, which allow you to predeclare a
43 variables or subroutines within a particular I<file> rather than
44 just a block. Such declarations are effective for the entire file
45 for which they were declared. You cannot rescind them with C<no
48 The following pragmas are defined (and have their own documentation).
54 Get/set subroutine or variable attributes
58 Set/get attributes of a subroutine (deprecated)
62 Postpone load of modules until a function is used
66 Establish IS-A relationship with base class at compile time
70 Use MakeMaker's uninstalled version of a package
74 Force byte semantics rather than character semantics
78 Define character names for C<\N{named}> string literal escapes.
86 Perl compiler pragma to force verbose warning diagnostics
90 Pragma to control the conversion of legacy data into Unicode
94 Compile-time class fields
98 Control the filetest permission operators
102 Use integer arithmetic instead of floating point
106 Request less of something from the compiler
110 Use and avoid POSIX locales for built-in operations
114 Set default disciplines for input and output
118 Restrict unsafe operations when compiling
122 Package for overloading perl operations
126 Alter regular expression behaviour
130 Enable simple signal handling
134 Control sort() behaviour
138 Restrict unsafe constructs
146 Perl extension allowing use of interpreter based threads from perl
150 Enable/disable UTF-8 (or UTF-EBCDIC) in source code
154 Predeclare global variable names (obsolete)
158 Control VMS-specific language features
162 Control optional warnings
164 =item warnings::register
166 Warnings import function
170 =head2 Standard Modules
172 Standard, bundled modules are all expected to behave in a well-defined
173 manner with respect to namespace pollution because they use the
174 Exporter module. See their own documentation for details.
180 Provide framework for multiple DBMs
182 =item Attribute::Handlers
184 Simpler definition of attribute handlers
188 Load subroutines only on demand
192 Split a package for autoloading
200 Autogenerated data about Perl ops, used to generate bytecode
204 Assemble Perl bytecode
212 Perl compiler's bytecode backend
216 Perl compiler's C backend
220 Perl compiler's optimized C translation backend
224 Walk Perl syntax tree, printing concise info about ops
228 Walk Perl syntax tree, printing debug info about ops
232 Perl compiler backend to produce perl code
234 =item B::Disassembler
236 Disassemble Perl bytecode
244 Show lexical variables used in functions or files
248 Helper module for CC backend
252 Show what stashes are loaded
256 Walk Perl syntax tree, printing terse info about ops
260 Generates cross reference reports for Perl programs
264 Benchmark running times of Perl code
268 Load byte compiled perl code
272 Simple Common Gateway Interface Class
276 Backward compatibility module for CGI.pm
280 CGI routines for writing to the HTTPD (or other) error log
284 Interface to Netscape Cookies
288 CGI Interface for Fast CGI
292 Module to produce nicely formatted HTML code
296 Simple Interface to Server Push
300 Backward compatibility module for defunct CGI::Switch
304 Internal utilities used by CGI module
308 Query, download and build perl modules from CPAN sites
310 =item CPAN::FirstTime
312 Utility for CPAN::Config file Initialization
316 Wrapper around CPAN.pm without using any XS module
320 Warn of errors (from perspective of caller)
324 No user serviceable parts inside
328 Report the search path for a class's ISA tree
332 Declare struct-like datatypes as Perl classes
336 Get pathname of current working directory
340 Programmatic interface to the Perl debugging API (draft, subject to
344 Perl5 access to Berkeley DB version 1.x
346 =item Devel::SelfStubber
348 Generate stubs for a SelfLoading module
352 Modules that calculate message digests
356 Supply object methods for directory handles
360 Provides screen dump of Perl data.
366 =item Encode::EncodeFormat
368 The format of encoding tables of the Encode extension
376 Use nice English (or awk) names for ugly punctuation variables
380 Perl module that imports environment variables as scalars or arrays
384 Implements default import method for modules
386 =item Exporter::Heavy
390 =item ExtUtils::Command
392 Utilities to replace common UNIX commands in Makefiles etc.
394 =item ExtUtils::Constant
396 Generate XS code to import C header constants
398 =item ExtUtils::Embed
400 Utilities for embedding Perl in C/C++ applications
402 =item ExtUtils::Install
404 Install files from here to there
406 =item ExtUtils::Installed
408 Inventory management of installed modules
410 =item ExtUtils::Liblist
412 Determine libraries to use and how to use them
414 =item ExtUtils::MM_Cygwin
416 Methods to override UN*X behaviour in ExtUtils::MakeMaker
418 =item ExtUtils::MM_NW5
420 Methods to override UN*X behaviour in ExtUtils::MakeMaker
422 =item ExtUtils::MM_OS2
424 Methods to override UN*X behaviour in ExtUtils::MakeMaker
426 =item ExtUtils::MM_Unix
428 Methods used by ExtUtils::MakeMaker
430 =item ExtUtils::MM_VMS
432 Methods to override UN*X behaviour in ExtUtils::MakeMaker
434 =item ExtUtils::MM_Win32
436 Methods to override UN*X behaviour in ExtUtils::MakeMaker
438 =item ExtUtils::MakeMaker
440 Create an extension Makefile
442 =item ExtUtils::Manifest
444 Utilities to write and check a MANIFEST file
446 =item ExtUtils::Mkbootstrap
448 Make a bootstrap file for use by DynaLoader
450 =item ExtUtils::Mksymlists
452 Write linker options files for dynamic extension
454 =item ExtUtils::Packlist
456 Manage .packlist files
458 =item ExtUtils::testlib
460 Add blib/* directories to @INC
464 Replace functions with equivalents which succeed or die
468 Load the C Fcntl.h defines
472 Split a pathname into pieces
474 =item File::CheckTree
476 Run many filetest checks on a tree
480 Compare files or filehandles
484 Copy files or filehandles
488 DOS like globbing and then some
496 Create or remove directory trees
500 Portably perform operations on file names
502 =item File::Spec::Epoc
504 Methods for Epoc file specs
506 =item File::Spec::Functions
508 Portably perform operations on file names
510 =item File::Spec::Mac
512 File::Spec for Mac OS (Classic)
514 =item File::Spec::OS2
516 Methods for OS/2 file specs
518 =item File::Spec::Unix
520 File::Spec for Unix, base for other File::Spec modules
522 =item File::Spec::VMS
524 Methods for VMS file specs
526 =item File::Spec::Win32
528 Methods for Win32 file specs
532 Return name and handle of a temporary file safely
536 By-name interface to Perl's built-in stat() functions
540 Keep more files open than the system permits
544 Supply object methods for filehandles
548 Simplified source filtering
552 Locate directory of original perl script
556 Extended processing of command line options
560 Process single-character switches with switch clustering
564 Compare 8-bit scalar data according to the current locale
568 Functions for dealing with RFC3066-style language tags
570 =item I18N::LangTags::List
572 Tags and names for human languages
576 Load various IO modules
580 Open a process for both reading and writing
584 Open a process for reading, writing, and error handling
586 =item Locale::Constants
588 Constants for Locale codes
590 =item Locale::Country
592 ISO codes for country identification (ISO 3166)
594 =item Locale::Currency
596 ISO three letter codes for currency identification (ISO 4217)
598 =item Locale::Language
600 ISO two letter codes for language identification (ISO 639)
602 =item Locale::Maketext
604 Framework for localization
606 =item Locale::Maketext::TPJ13
608 Article about software localization
612 Arbitrary size floating point math package
616 Arbitrary size integer math package
618 =item Math::BigInt::Calc
620 Pure Perl module to support Math::BigInt
624 Complex numbers and associated mathematical functions
628 Trigonometric functions
632 Make your functions faster by trading space for time
634 =item Memoize::AnyDBM_File
636 Glue to provide EXISTS for AnyDBM_File for Storable use
638 =item Memoize::Expire
640 Plug-in module for automatic expiration of memoized values
642 =item Memoize::ExpireFile
644 Test for Memoize expiration semantics
646 =item Memoize::ExpireTest
648 Test for Memoize expiration semantics
650 =item Memoize::NDBM_File
652 Glue to provide EXISTS for NDBM_File for Storable use
654 =item Memoize::SDBM_File
656 Glue to provide EXISTS for SDBM_File for Storable use
660 Plug-in module to specify which return values should be memoized
662 =item Memoize::Storable
664 Store Memoized data in Storable database
668 Tied access to ndbm files
672 Provide a pseudo-class NEXT that allows method redispatch
676 Network Command class (as used by FTP, SMTP etc)
680 Local configuration data for libnet
684 Attempt to evaluate the current host's internet name and domain
696 OO interface to users netrc file
700 Post Office Protocol 3 Client class (RFC1081)
704 Check a remote host for reachability
708 Simple Mail Transfer Protocol Client
712 Time and daytime network client interface
716 By-name interface to Perl's built-in gethost*() functions
720 Libnet Frequently Asked Questions
724 By-name interface to Perl's built-in getnet*() functions
728 By-name interface to Perl's built-in getproto*() functions
732 By-name interface to Perl's built-in getserv*() functions
736 Generic interface to Perl Compiler backends
740 Tied access to odbm files
744 Disable named opcodes when compiling perl code
748 Perl interface to IEEE Std 1003.1
752 On demand loader for PerlIO layers and root of PerlIO::* name space
756 Check pod documents for syntax errors
760 Find POD documents in directory trees
764 Module to convert pod files to HTML
766 =item Pod::InputObjects
768 Objects representing POD input paragraphs, commands, etc.
772 Convert Pod data to formatted Latex
776 Convert POD data to formatted *roff input
780 Parse an L<> formatting code in POD text
782 =item Pod::ParseUtils
784 Helpers for POD parsing and conversion
788 Base class for creating POD filters and translators
792 Perl extension for converting Pod to old style Pod.
796 Extract selected sections of POD from input
800 Convert POD data to formatted ASCII text
802 =item Pod::Text::Color
804 Convert POD data to formatted color ASCII text
806 =item Pod::Text::Overstrike
808 Convert POD data to formatted overstrike text
810 =item Pod::Text::Termcap
812 Convert POD data to ASCII text with format escapes
816 Print a usage message from embedded pod documentation
820 Test of various basic POD features in translators.
824 Tied access to sdbm files
828 Compile and execute code in restricted compartments
832 Search for key in dictionary file
836 Save and restore selected file handle
840 Load functions only on demand
844 Run shell commands transparently within perl
848 Load the C socket.h defines and structure manipulators
852 Persistency for perl data structures
856 A switch statement for Perl
860 Manipulate Perl symbols and their names
862 =item Term::ANSIColor
864 Color screen output using ANSI escape sequences
868 Perl termcap interface
872 Perl word completion module
876 Perl interface to various C<readline> packages. If
880 Provides a simple framework for writing test scripts
884 Backend for building test libraries
888 Run perl standard test scripts with statistics
892 Yet another framework for writing test scripts
896 Basic utilities for writing tests.
900 A tutorial about writing really basic tests
904 Create an abbreviation table from a list
908 Extract delimited text sequences from strings.
910 =item Text::ParseWords
912 Parse text into an array of tokens or array of arrays
916 Implementation of the Soundex Algorithm as Described by Knuth
920 Expand and unexpand tabs per the unix expand(1) and unexpand(1)
924 Line wrapping to form simple paragraphs
928 Manipulate threads in Perl
932 Base class for tied arrays
936 Base class definitions for tied handles
940 Base class definitions for tied hashes
944 Use references as hash keys
948 Base class definitions for tied scalars
950 =item Tie::SubstrHash
952 Fixed-table-size, fixed-key-length hashing
956 Efficiently compute time from local and GMT time
960 By-name interface to Perl's built-in gmtime() function
962 =item Time::localtime
964 By-name interface to Perl's built-in localtime() function
968 Internal object used by Time::gmtime and Time::localtime
972 Base class for ALL classes (blessed references)
974 =item Unicode::Collate
976 Use UCA (Unicode Collation Algorithm)
980 Unicode character database
984 By-name interface to Perl's built-in getgr*() functions
988 By-name interface to Perl's built-in getpw*() functions
992 Interfaces to some Win32 API Functions
996 To find out I<all> modules installed on your system, including
997 those without documentation or outside the standard release,
1000 % find `perl -e 'print "@INC"'` -name '*.pm' -print
1002 They should all have their own documentation installed and accessible
1003 via your system man(1) command. If you do not have a B<find>
1004 program, you can use the Perl B<find2perl> program instead, which
1005 generates Perl code as output you can run through perl. If you
1006 have a B<man> program but it doesn't find your modules, you'll have
1007 to fix your manpath. See L<perl> for details. If you have no
1008 system B<man> command, you might try the B<perldoc> program.
1010 =head2 Extension Modules
1012 Extension modules are written in C (or a mix of Perl and C). They
1013 are usually dynamically loaded into Perl if and when you need them,
1014 but may also be linked in statically. Supported extension modules
1015 include Socket, Fcntl, and POSIX.
1017 Many popular C extension modules do not come bundled (at least, not
1018 completely) due to their sizes, volatility, or simply lack of time
1019 for adequate testing and configuration across the multitude of
1020 platforms on which Perl was beta-tested. You are encouraged to
1021 look for them on CPAN (described below), or using web search engines
1022 like Alta Vista or Deja News.
1026 CPAN stands for Comprehensive Perl Archive Network; it's a globally
1027 replicated trove of Perl materials, including documentation, style
1028 guides, tricks and traps, alternate ports to non-Unix systems and
1029 occasional binary distributions for these. Search engines for
1030 CPAN can be found at http://cpan.perl.com/ and at
1031 http://theory.uwinnipeg.ca/mod_perl/cpan-search.pl .
1033 Most importantly, CPAN includes around a thousand unbundled modules,
1034 some of which require a C compiler to build. Major categories of
1041 Language Extensions and Documentation Tools
1049 Operating System Interfaces
1053 Networking, Device Control (modems) and InterProcess Communication
1057 Data Types and Data Type Utilities
1069 Interfaces to / Emulations of Other Programming Languages
1073 File Names, File Systems and File Locking (see also File Handles)
1077 String Processing, Language Text Processing, Parsing, and Searching
1081 Option, Argument, Parameter, and Configuration File Processing
1085 Internationalization and Locale
1089 Authentication, Security, and Encryption
1093 World Wide Web, HTML, HTTP, CGI, MIME
1097 Server and Daemon Utilities
1101 Archiving and Compression
1105 Images, Pixmap and Bitmap Manipulation, Drawing, and Graphing
1109 Mail and Usenet News
1113 Control Flow Utilities (callbacks and exceptions etc)
1117 File Handle and Input/Output Stream Utilities
1121 Miscellaneous Modules
1125 Registered CPAN sites as of this writing include the following.
1126 You should try to choose one close to you:
1136 ftp://ftp.is.co.za/programming/perl/CPAN/
1137 ftp://ftp.mweb.co.za/pub/mirrors/cpan/
1138 ftp://ftp.saix.net/pub/CPAN/
1139 ftp://ftp.sun.ac.za/CPAN/
1151 ftp://freesoft.cei.gov.cn/pub/languages/perl/CPAN/
1152 http://www2.linuxforum.net/mirror/CPAN/
1153 http://CPAN.pacific.net.hk/
1154 ftp://ftp.pacific.net.hk/pub/mirror/CPAN/
1155 http://cpan.shellhung.org/
1156 ftp://ftp.shellhung.org/pub/CPAN
1162 http://cpan.in.freeos.com
1163 ftp://cpan.in.freeos.com/pub/CPAN/
1169 http://cpan.itb.web.id/
1170 ftp://mirrors.piksi.itb.ac.id/CPAN/
1171 http://CPAN.mweb.co.id/
1172 ftp://ftp.mweb.co.id/pub/languages/perl/CPAN/
1178 http://www.iglu.org.il:/pub/CPAN/
1179 ftp://ftp.iglu.org.il/pub/CPAN/
1180 http://cpan.lerner.co.il/
1181 http://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
1182 ftp://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
1188 ftp://ftp.u-aizu.ac.jp/pub/CPAN
1189 ftp://ftp.kddlabs.co.jp/CPAN/
1190 http://mirror.nucba.ac.jp/mirror/Perl/
1191 ftp://mirror.nucba.ac.jp/mirror/Perl/
1192 ftp://ftp.meisei-u.ac.jp/pub/CPAN/
1193 ftp://ftp.jaist.ac.jp/pub/lang/perl/CPAN/
1194 ftp://ftp.dti.ad.jp/pub/lang/CPAN/
1195 ftp://ftp.ring.gr.jp/pub/lang/perl/CPAN/
1201 http://mirror.Mazic.org/pub/CPAN
1202 ftp://mirror.Mazic.org/pub/CPAN
1208 http://www.adzu.edu.ph/CPAN
1214 http://cpan.tomsk.ru
1215 ftp://cpan.tomsk.ru/pub/CPAN
1221 ftp://ftp.isu.net.sa/pub/CPAN/
1227 http://cpan.hjc.edu.sg
1233 http://CPAN.bora.net/
1234 ftp://ftp.bora.net/pub/CPAN/
1235 http://ftp.kornet.net/pub/CPAN/
1236 ftp://ftp.kornet.net/pub/CPAN/
1237 ftp://ftp.nuri.net/pub/CPAN/
1243 ftp://coda.nctu.edu.tw/UNIX/perl/CPAN
1244 ftp://ftp.ee.ncku.edu.tw/pub/perl/CPAN/
1245 ftp://ftp1.sinica.edu.tw/pub1/perl/CPAN/
1246 http://ftp.tku.edu.tw/pub/CPAN/
1247 ftp://ftp.tku.edu.tw/pub/CPAN/
1253 http://download.nectec.or.th/CPAN/
1254 ftp://ftp.nectec.or.th/pub/languages/CPAN/
1255 ftp://ftp.cs.riubon.ac.th/pub/mirrors/CPAN/
1259 =head2 Central America
1267 ftp://ftp.linux.co.cr/mirrors/CPAN/
1268 http://ftp.ucr.ac.cr/Unix/CPAN/
1269 ftp://ftp.ucr.ac.cr/pub/Unix/CPAN/
1281 ftp://ftp.tuwien.ac.at/pub/CPAN/
1287 http://ftp.easynet.be/pub/CPAN/
1288 ftp://ftp.easynet.be/pub/CPAN/
1289 http://cpan.skynet.be
1290 ftp://ftp.skynet.be/pub/CPAN
1291 ftp://ftp.kulnet.kuleuven.ac.be/pub/mirror/CPAN/
1297 ftp://ftp.ntrl.net/pub/mirrors/CPAN/
1303 ftp://ftp.linux.hr/pub/CPAN/
1309 http://ftp.fi.muni.cz/pub/CPAN/
1310 ftp://ftp.fi.muni.cz/pub/CPAN/
1311 ftp://sunsite.mff.cuni.cz/MIRRORS/ftp.funet.fi/pub/languages/perl/CPAN/
1317 http://mirrors.sunsite.dk/cpan/
1318 ftp://sunsite.dk/mirrors/cpan/
1319 http://www.cpan.dk/CPAN/
1320 ftp://www.cpan.dk/ftp.cpan.org/CPAN/
1326 http://www.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN
1327 ftp://ftp.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN/
1328 http://cpan.crazygreek.co.uk
1329 ftp://ftp.demon.co.uk/pub/CPAN/
1330 ftp://ftp.flirble.org/pub/languages/perl/CPAN/
1331 ftp://ftp.plig.org/pub/CPAN/
1332 ftp://sunsite.doc.ic.ac.uk/packages/CPAN/
1333 http://mirror.uklinux.net/CPAN/
1334 ftp://mirror.uklinux.net/pub/CPAN/
1335 ftp://usit.shef.ac.uk/pub/packages/CPAN/
1341 ftp://ftp.ut.ee/pub/languages/perl/CPAN/
1347 ftp://ftp.funet.fi/pub/languages/perl/CPAN/
1348 http://cpan.kpnqwest.fi/
1354 ftp://cpan.ftp.worldonline.fr/pub/CPAN/
1355 http://cpan.mirrors.easynet.fr/
1356 ftp://cpan.mirrors.easynet.fr/pub/ftp.cpan.org/
1357 ftp://ftp.club-internet.fr/pub/perl/CPAN/
1359 ftp://ftp.lip6.fr/pub/perl/CPAN/
1360 ftp://ftp.oleane.net/pub/mirrors/CPAN/
1361 ftp://ftp.pasteur.fr/pub/computing/CPAN/
1362 http://cpan.cict.fr/
1363 ftp://cpan.cict.fr/pub/CPAN/
1364 ftp://ftp.uvsq.fr/pub/perl/CPAN/
1370 ftp://ftp.rz.ruhr-uni-bochum.de/pub/CPAN/
1371 ftp://ftp.freenet.de/pub/ftp.cpan.org/pub/CPAN/
1372 ftp://ftp.uni-erlangen.de/pub/source/CPAN/
1373 ftp://ftp-stud.fht-esslingen.de/pub/Mirrors/CPAN
1374 ftp://ftp.gigabell.net/pub/CPAN/
1375 http://ftp.gwdg.de/pub/languages/perl/CPAN/
1376 ftp://ftp.gwdg.de/pub/languages/perl/CPAN/
1377 ftp://ftp.uni-hamburg.de/pub/soft/lang/perl/CPAN/
1378 ftp://ftp.leo.org/pub/CPAN/
1379 http://cpan.noris.de/
1380 ftp://cpan.noris.de/pub/CPAN/
1381 ftp://ftp.mpi-sb.mpg.de/pub/perl/CPAN/
1382 ftp://ftp.gmd.de/mirrors/CPAN/
1388 ftp://ftp.forthnet.gr/pub/languages/perl/CPAN
1389 ftp://ftp.ntua.gr/pub/lang/perl/
1395 http://cpan.artifact.hu/
1396 ftp://cpan.artifact.hu/CPAN/
1397 http://ftp.kfki.hu/pub/CPAN/
1398 ftp://ftp.kfki.hu/pub/CPAN/
1404 http://ftp.rhnet.is/pub/CPAN/
1405 ftp://ftp.rhnet.is/pub/CPAN/
1411 http://cpan.indigo.ie/
1412 ftp://cpan.indigo.ie/pub/CPAN/
1413 http://sunsite.compapp.dcu.ie/pub/perl/
1414 ftp://sunsite.compapp.dcu.ie/pub/perl/
1420 http://cpan.nettuno.it/
1421 http://gusp.dyndns.org/CPAN/
1422 ftp://gusp.dyndns.org/pub/CPAN
1423 http://softcity.iol.it/cpan
1424 ftp://softcity.iol.it/pub/cpan
1425 ftp://ftp.unina.it/pub/Other/CPAN/
1426 ftp://ftp.unipi.it/pub/mirror/perl/CPAN/
1427 ftp://cis.uniRoma2.it/CPAN/
1428 ftp://ftp.edisontel.it/pub/CPAN_Mirror/
1429 ftp://ftp.flashnet.it/pub/CPAN/
1435 http://kvin.lv/pub/CPAN/
1441 ftp://ftp.unix.lt/pub/CPAN/
1447 ftp://download.xs4all.nl/pub/mirror/CPAN/
1448 ftp://ftp.nl.uu.net/pub/CPAN/
1449 ftp://ftp.nluug.nl/pub/languages/perl/CPAN/
1450 http://cpan.cybercomm.nl/
1451 ftp://mirror.cybercomm.nl/pub/cpan/
1452 ftp://ftp.cpan.nl/pub/CPAN/
1453 http://www.cs.uu.nl/mirror/CPAN/
1454 ftp://ftp.cs.uu.nl/mirror/CPAN/
1460 ftp://ftp.uninett.no/pub/languages/perl/CPAN
1461 ftp://ftp.uit.no/pub/languages/perl/cpan/
1467 ftp://ftp.pk.edu.pl/pub/lang/perl/CPAN/
1468 http://www.fic.uni.lodz.pl/pub/CPAN
1469 ftp://ftp.fic.uni.lodz.pl/pub/CPAN
1470 ftp://ftp.mega.net.pl/pub/mirrors/ftp.perl.com/
1471 ftp://ftp.man.torun.pl/pub/doc/CPAN/
1472 ftp://sunsite.icm.edu.pl/pub/CPAN/
1478 ftp://ftp.ua.pt/pub/CPAN/
1479 ftp://perl.di.uminho.pt/pub/CPAN/
1481 ftp://cpan.ip.pt/pub/perl/
1482 ftp://ftp.ist.utl.pt/pub/CPAN/
1484 ftp://cpan.ip.pt/pub/cpan/
1485 ftp://ftp.netc.pt/pub/CPAN/
1486 ftp://ftp.up.pt/pub/CPAN
1492 ftp://archive.logicnet.ro/mirrors/ftp.cpan.org/CPAN/
1493 ftp://ftp.kappa.ro/pub/mirrors/ftp.perl.org/pub/CPAN/
1494 ftp://ftp.dntis.ro/pub/cpan/
1495 ftp://ftp.opsynet.com/cpan/
1496 ftp://ftp.dnttm.ro/pub/CPAN/
1497 ftp://ftp.lasting.ro/pub/CPAN
1498 ftp://ftp.timisoara.roedu.net/mirrors/CPAN/
1504 ftp://ftp.chg.ru/pub/lang/perl/CPAN/
1505 http://cpan.rinet.ru/
1506 ftp://cpan.rinet.ru/pub/mirror/CPAN/
1507 ftp://ftp.aha.ru/pub/CPAN/
1508 http://cpan.sai.msu.ru/
1509 ftp://ftp.sai.msu.su/pub/lang/perl/CPAN/
1515 ftp://ftp.entry.sk/pub/languages/perl/CPAN/
1521 ftp://ftp.arnes.si/software/perl/CPAN/
1527 ftp://ftp.rediris.es/mirror/CPAN/
1528 ftp://ftp.etse.urv.es/pub/perl/
1534 http://ftp.du.se/CPAN/
1535 ftp://ftp.du.se/pub/CPAN/
1536 ftp://mirror.dataphone.se/pub/CPAN
1537 ftp://ftp.sunet.se/pub/lang/perl/CPAN/
1543 ftp://ftp.danyk.ch/CPAN/
1544 ftp://sunsite.cnlab-switch.ch/mirror/CPAN/
1550 ftp://sunsite.bilkent.edu.tr/pub/languages/CPAN/
1558 ftp://ftp.perl.org.ua/pub/CPAN/
1562 =head2 North America
1576 http://sunsite.ualberta.ca/pub/Mirror/CPAN/
1577 ftp://sunsite.ualberta.ca/pub/Mirror/CPAN/
1583 http://theoryx5.uwinnipeg.ca/pub/CPAN/
1584 ftp://theoryx5.uwinnipeg.ca/pub/CPAN/
1590 ftp://cpan.chebucto.ns.ca/pub/CPAN/
1596 ftp://ftp.crc.ca/pub/CPAN/
1602 http://cpan.mirror.smartworker.org/
1603 ftp://cpan.mirror.smartworker.org/pub/CPAN
1611 http://cpan.azc.uam.mx
1612 ftp://cpan.azc.uam.mx/mirrors/CPAN
1613 http://cpan.unam.mx/
1614 ftp://cpan.unam.mx/pub/CPAN
1615 http://www.msg.com.mx/CPAN/
1616 ftp://ftp.msg.com.mx/pub/CPAN/
1628 http://mirror.hiwaay.net/CPAN/
1629 ftp://mirror.hiwaay.net/CPAN/
1635 http://www.cpan.org/
1636 ftp://cpan.valueclick.com/pub/CPAN/
1637 http://mirrors.gossamer-threads.com/CPAN
1638 ftp://cpan.nas.nasa.gov/pub/perl/CPAN/
1639 ftp://ftp.digital.com/pub/plan/perl/CPAN/
1640 http://mirrors.kernel.org/cpan/
1641 ftp://mirrors.kernel.org/pub/CPAN
1642 http://cpan.digisle.net/
1643 ftp://cpan.digisle.net/pub/CPAN
1644 http://www.linuxjar.com/CPAN
1645 ftp://linuxjar.com/pub/CPAN
1646 http://www.perl.com/CPAN/
1647 http://download.sourceforge.net/mirrors/CPAN/
1653 ftp://ftp.cs.colorado.edu/pub/perl/CPAN/
1657 District of Columbia
1659 ftp://ftp.dc.us.telia.net/pub/cpan/
1665 ftp://ftp.cise.ufl.edu/pub/mirrors/CPAN/
1666 http://mirror.csit.fsu.edu/pub/CPAN/
1667 ftp://mirror.csit.fsu.edu/pub/CPAN/
1673 http://uiarchive.uiuc.edu/mirrors/ftp/cpan.cse.msu.edu/
1674 ftp://uiarchive.uiuc.edu/mirrors/ftp/cpan.cse.msu.edu/
1680 ftp://ftp.uwsg.indiana.edu/pub/perl/CPAN/
1681 http://cpan.nitco.com/
1682 ftp://cpan.nitco.com/pub/CPAN/
1683 http://archive.progeny.com/CPAN/
1684 ftp://archive.progeny.com/CPAN/
1685 ftp://cpan.in-span.net/
1686 http://csociety-ftp.ecn.purdue.edu/pub/CPAN
1687 ftp://csociety-ftp.ecn.purdue.edu/pub/CPAN
1693 http://cpan.uky.edu/
1694 ftp://cpan.uky.edu/pub/CPAN/
1700 ftp://ftp.ccs.neu.edu/net/mirrors/ftp.funet.fi/pub/languages/perl/CPAN/
1701 http://cpan.mirrors.netnumina.com/
1702 ftp://mirrors.netnumina.com/cpan/
1703 ftp://ftp.iguide.com/pub/mirrors/packages/perl/CPAN/
1709 ftp://cpan.cse.msu.edu/
1715 ftp://ftp.cpanel.net/pub/CPAN/
1721 ftp://ftp.freesoftware.com/pub/perl/CPAN/
1722 ftp://ftp.stealth.net/pub/CPAN/
1723 http://www.rge.com/pub/languages/perl/
1724 ftp://ftp.rge.com/pub/languages/perl/
1725 ftp://mirrors.cloud9.net/pub/mirrors/CPAN/
1731 ftp://ftp.duke.edu/pub/perl/
1737 ftp://ftp.loaded.net/pub/CPAN/
1743 ftp://ftp.ou.edu/mirrors/CPAN/
1749 ftp://ftp.orst.edu/pub/CPAN
1755 http://ftp.epix.net/CPAN/
1756 ftp://ftp.epix.net/pub/languages/perl/
1757 http://mirrors.phenominet.com/pub/CPAN/
1758 ftp://mirrors.phenominet.com/pub/CPAN/
1759 ftp://carroll.cac.psu.edu/pub/CPAN/
1765 ftp://ftp.sunsite.utk.edu/pub/CPAN/
1771 http://ftp.sedl.org/pub/mirrors/CPAN/
1777 ftp://mirror.xmission.com/CPAN/
1783 http://mirrors.rcn.net/pub/lang/CPAN/
1784 ftp://mirrors.rcn.net/pub/lang/CPAN/
1785 ftp://ruff.cs.jmu.edu/pub/CPAN/
1786 http://perl.Liquidation.com/CPAN/
1792 http://cpan.llarian.net/
1793 ftp://cpan.llarian.net/pub/CPAN/
1794 http://cpan.mirrorcentral.com/
1795 ftp://ftp.mirrorcentral.com/pub/CPAN/
1796 ftp://ftp-mirror.internap.com/pub/CPAN/
1810 http://ftp.planetmirror.com/pub/CPAN/
1811 ftp://ftp.planetmirror.com/pub/CPAN/
1812 ftp://mirror.aarnet.edu.au/pub/perl/CPAN/
1813 ftp://cpan.topend.com.au/pub/CPAN/
1818 ftp://ftp.auckland.ac.nz/pub/perl/CPAN/
1822 =head2 South America
1830 ftp://mirrors.bannerlandia.com.ar/mirrors/CPAN/
1836 ftp://cpan.pop-mg.com.br/pub/CPAN/
1837 ftp://ftp.matrix.com.br/pub/perl/CPAN/
1843 ftp://ftp.psinet.cl/pub/programming/perl/CPAN/
1844 ftp://sunsite.dcc.uchile.cl/pub/lang/perl/
1849 For an up-to-date listing of CPAN sites,
1850 see http://www.cpan.org/SITES or ftp://www.cpan.org/SITES .
1852 =head1 Modules: Creation, Use, and Abuse
1854 (The following section is borrowed directly from Tim Bunce's modules
1855 file, available at your nearest CPAN site.)
1857 Perl implements a class using a package, but the presence of a
1858 package doesn't imply the presence of a class. A package is just a
1859 namespace. A class is a package that provides subroutines that can be
1860 used as methods. A method is just a subroutine that expects, as its
1861 first argument, either the name of a package (for "static" methods),
1862 or a reference to something (for "virtual" methods).
1864 A module is a file that (by convention) provides a class of the same
1865 name (sans the .pm), plus an import method in that class that can be
1866 called to fetch exported symbols. This module may implement some of
1867 its methods by loading dynamic C or C++ objects, but that should be
1868 totally transparent to the user of the module. Likewise, the module
1869 might set up an AUTOLOAD function to slurp in subroutine definitions on
1870 demand, but this is also transparent. Only the F<.pm> file is required to
1871 exist. See L<perlsub>, L<perltoot>, and L<AutoLoader> for details about
1872 the AUTOLOAD mechanism.
1874 =head2 Guidelines for Module Creation
1880 Do similar modules already exist in some form?
1882 If so, please try to reuse the existing modules either in whole or
1883 by inheriting useful features into a new class. If this is not
1884 practical try to get together with the module authors to work on
1885 extending or enhancing the functionality of the existing modules.
1886 A perfect example is the plethora of packages in perl4 for dealing
1887 with command line options.
1889 If you are writing a module to expand an already existing set of
1890 modules, please coordinate with the author of the package. It
1891 helps if you follow the same naming scheme and module interaction
1892 scheme as the original author.
1896 Try to design the new module to be easy to extend and reuse.
1898 Try to C<use warnings;> (or C<use warnings qw(...);>).
1899 Remember that you can add C<no warnings qw(...);> to individual blocks
1900 of code that need less warnings.
1902 Use blessed references. Use the two argument form of bless to bless
1903 into the class name given as the first parameter of the constructor,
1908 return bless {}, $class;
1911 or even this if you'd like it to be used as either a static
1912 or a virtual method.
1916 my $class = ref($self) || $self;
1917 return bless {}, $class;
1920 Pass arrays as references so more parameters can be added later
1921 (it's also faster). Convert functions into methods where
1922 appropriate. Split large methods into smaller more flexible ones.
1923 Inherit methods from other modules if appropriate.
1925 Avoid class name tests like: C<die "Invalid" unless ref $ref eq 'FOO'>.
1926 Generally you can delete the C<eq 'FOO'> part with no harm at all.
1927 Let the objects look after themselves! Generally, avoid hard-wired
1928 class names as far as possible.
1930 Avoid C<< $r->Class::func() >> where using C<@ISA=qw(... Class ...)> and
1931 C<< $r->func() >> would work (see L<perlbot> for more details).
1933 Use autosplit so little used or newly added functions won't be a
1934 burden to programs that don't use them. Add test functions to
1935 the module after __END__ either using AutoSplit or by saying:
1937 eval join('',<main::DATA>) || die $@ unless caller();
1939 Does your module pass the 'empty subclass' test? If you say
1940 C<@SUBCLASS::ISA = qw(YOURCLASS);> your applications should be able
1941 to use SUBCLASS in exactly the same way as YOURCLASS. For example,
1942 does your application still work if you change: C<$obj = new YOURCLASS;>
1943 into: C<$obj = new SUBCLASS;> ?
1945 Avoid keeping any state information in your packages. It makes it
1946 difficult for multiple other packages to use yours. Keep state
1947 information in objects.
1951 Try to C<use strict;> (or C<use strict qw(...);>).
1952 Remember that you can add C<no strict qw(...);> to individual blocks
1953 of code that need less strictness.
1957 Follow the guidelines in the perlstyle(1) manual.
1963 Some simple style guidelines
1965 The perlstyle manual supplied with Perl has many helpful points.
1967 Coding style is a matter of personal taste. Many people evolve their
1968 style over several years as they learn what helps them write and
1969 maintain good code. Here's one set of assorted suggestions that
1970 seem to be widely used by experienced developers:
1972 Use underscores to separate words. It is generally easier to read
1973 $var_names_like_this than $VarNamesLikeThis, especially for
1974 non-native speakers of English. It's also a simple rule that works
1975 consistently with VAR_NAMES_LIKE_THIS.
1977 Package/Module names are an exception to this rule. Perl informally
1978 reserves lowercase module names for 'pragma' modules like integer
1979 and strict. Other modules normally begin with a capital letter and
1980 use mixed case with no underscores (need to be short and portable).
1982 You may find it helpful to use letter case to indicate the scope
1983 or nature of a variable. For example:
1985 $ALL_CAPS_HERE constants only (beware clashes with Perl vars)
1986 $Some_Caps_Here package-wide global/static
1987 $no_caps_here function scope my() or local() variables
1989 Function and method names seem to work best as all lowercase.
1990 e.g., C<< $obj->as_string() >>.
1992 You can use a leading underscore to indicate that a variable or
1993 function should not be used outside the package that defined it.
1997 Select what to export.
1999 Do NOT export method names!
2001 Do NOT export anything else by default without a good reason!
2003 Exports pollute the namespace of the module user. If you must
2004 export try to use @EXPORT_OK in preference to @EXPORT and avoid
2005 short or common names to reduce the risk of name clashes.
2007 Generally anything not exported is still accessible from outside the
2008 module using the ModuleName::item_name (or C<< $blessed_ref->method >>)
2009 syntax. By convention you can use a leading underscore on names to
2010 indicate informally that they are 'internal' and not for public use.
2012 (It is actually possible to get private functions by saying:
2013 C<my $subref = sub { ... }; &$subref;>. But there's no way to call that
2014 directly as a method, because a method must have a name in the symbol
2017 As a general rule, if the module is trying to be object oriented
2018 then export nothing. If it's just a collection of functions then
2019 @EXPORT_OK anything but use @EXPORT with caution.
2023 Select a name for the module.
2025 This name should be as descriptive, accurate, and complete as
2026 possible. Avoid any risk of ambiguity. Always try to use two or
2027 more whole words. Generally the name should reflect what is special
2028 about what the module does rather than how it does it. Please use
2029 nested module names to group informally or categorize a module.
2030 There should be a very good reason for a module not to have a nested name.
2031 Module names should begin with a capital letter.
2033 Having 57 modules all called Sort will not make life easy for anyone
2034 (though having 23 called Sort::Quick is only marginally better :-).
2035 Imagine someone trying to install your module alongside many others.
2036 If in any doubt ask for suggestions in comp.lang.perl.misc.
2038 If you are developing a suite of related modules/classes it's good
2039 practice to use nested classes with a common prefix as this will
2040 avoid namespace clashes. For example: Xyz::Control, Xyz::View,
2041 Xyz::Model etc. Use the modules in this list as a naming guide.
2043 If adding a new module to a set, follow the original author's
2044 standards for naming modules and the interface to methods in
2047 If developing modules for private internal or project specific use,
2048 that will never be released to the public, then you should ensure
2049 that their names will not clash with any future public module. You
2050 can do this either by using the reserved Local::* category or by
2051 using a category name that includes an underscore like Foo_Corp::*.
2053 To be portable each component of a module name should be limited to
2054 11 characters. If it might be used on MS-DOS then try to ensure each is
2055 unique in the first 8 characters. Nested modules make this easier.
2059 Have you got it right?
2061 How do you know that you've made the right decisions? Have you
2062 picked an interface design that will cause problems later? Have
2063 you picked the most appropriate name? Do you have any questions?
2065 The best way to know for sure, and pick up many helpful suggestions,
2066 is to ask someone who knows. Comp.lang.perl.misc is read by just about
2067 all the people who develop modules and it's the best place to ask.
2069 All you need to do is post a short summary of the module, its
2070 purpose and interfaces. A few lines on each of the main methods is
2071 probably enough. (If you post the whole module it might be ignored
2072 by busy people - generally the very people you want to read it!)
2074 Don't worry about posting if you can't say when the module will be
2075 ready - just say so in the message. It might be worth inviting
2076 others to help you, they may be able to complete it for you!
2080 README and other Additional Files.
2082 It's well known that software developers usually fully document the
2083 software they write. If, however, the world is in urgent need of
2084 your software and there is not enough time to write the full
2085 documentation please at least provide a README file containing:
2091 A description of the module/package/extension etc.
2095 A copyright notice - see below.
2099 Prerequisites - what else you may need to have.
2103 How to build it - possible changes to Makefile.PL etc.
2111 Recent changes in this release, especially incompatibilities
2115 Changes / enhancements you plan to make in the future.
2119 If the README file seems to be getting too large you may wish to
2120 split out some of the sections into separate files: INSTALL,
2127 Adding a Copyright Notice.
2129 How you choose to license your work is a personal decision.
2130 The general mechanism is to assert your Copyright and then make
2131 a declaration of how others may copy/use/modify your work.
2133 Perl, for example, is supplied with two types of licence: The GNU
2134 GPL and The Artistic Licence (see the files README, Copying, and
2135 Artistic). Larry has good reasons for NOT just using the GNU GPL.
2137 My personal recommendation, out of respect for Larry, Perl, and the
2138 Perl community at large is to state something simply like:
2140 Copyright (c) 1995 Your Name. All rights reserved.
2141 This program is free software; you can redistribute it and/or
2142 modify it under the same terms as Perl itself.
2144 This statement should at least appear in the README file. You may
2145 also wish to include it in a Copying file and your source files.
2146 Remember to include the other words in addition to the Copyright.
2150 Give the module a version/issue/release number.
2152 To be fully compatible with the Exporter and MakeMaker modules you
2153 should store your module's version number in a non-my package
2154 variable called $VERSION. This should be a floating point
2155 number with at least two digits after the decimal (i.e., hundredths,
2156 e.g, C<$VERSION = "0.01">). Don't use a "1.3.2" style version.
2157 See L<Exporter> for details.
2159 It may be handy to add a function or method to retrieve the number.
2160 Use the number in announcements and archive file names when
2161 releasing the module (ModuleName-1.02.tar.Z).
2162 See perldoc ExtUtils::MakeMaker.pm for details.
2166 How to release and distribute a module.
2168 It's good idea to post an announcement of the availability of your
2169 module (or the module itself if small) to the comp.lang.perl.announce
2170 Usenet newsgroup. This will at least ensure very wide once-off
2173 If possible, register the module with CPAN. You should
2174 include details of its location in your announcement.
2176 Some notes about ftp archives: Please use a long descriptive file
2177 name that includes the version number. Most incoming directories
2178 will not be readable/listable, i.e., you won't be able to see your
2179 file after uploading it. Remember to send your email notification
2180 message as soon as possible after uploading else your file may get
2181 deleted automatically. Allow time for the file to be processed
2182 and/or check the file has been processed before announcing its
2185 FTP Archives for Perl Modules:
2187 Follow the instructions and links on:
2189 http://www.cpan.org/modules/00modlist.long.html
2190 http://www.cpan.org/modules/04pause.html
2192 or upload to one of these sites:
2194 https://pause.kbx.de/pause/
2195 http://pause.perl.org/pause/
2197 and notify <modules@perl.org>.
2199 By using the WWW interface you can ask the Upload Server to mirror
2200 your modules from your ftp or WWW site into your own directory on
2203 Please remember to send me an updated entry for the Module list!
2207 Take care when changing a released module.
2209 Always strive to remain compatible with previous released versions.
2210 Otherwise try to add a mechanism to revert to the
2211 old behavior if people rely on it. Document incompatible changes.
2217 =head2 Guidelines for Converting Perl 4 Library Scripts into Modules
2223 There is no requirement to convert anything.
2225 If it ain't broke, don't fix it! Perl 4 library scripts should
2226 continue to work with no problems. You may need to make some minor
2227 changes (like escaping non-array @'s in double quoted strings) but
2228 there is no need to convert a .pl file into a Module for just that.
2232 Consider the implications.
2234 All Perl applications that make use of the script will need to
2235 be changed (slightly) if the script is converted into a module. Is
2236 it worth it unless you plan to make other changes at the same time?
2240 Make the most of the opportunity.
2242 If you are going to convert the script to a module you can use the
2243 opportunity to redesign the interface. The guidelines for module
2244 creation above include many of the issues you should consider.
2248 The pl2pm utility will get you started.
2250 This utility will read *.pl files (given as parameters) and write
2251 corresponding *.pm files. The pl2pm utilities does the following:
2257 Adds the standard Module prologue lines
2261 Converts package specifiers from ' to ::
2265 Converts die(...) to croak(...)
2269 Several other minor changes
2273 Being a mechanical process pl2pm is not bullet proof. The converted
2274 code will need careful checking, especially any package statements.
2275 Don't delete the original .pl file till the new .pm one works!
2279 =head2 Guidelines for Reusing Application Code
2285 Complete applications rarely belong in the Perl Module Library.
2289 Many applications contain some Perl code that could be reused.
2291 Help save the world! Share your code in a form that makes it easy
2296 Break-out the reusable code into one or more separate module files.
2300 Take the opportunity to reconsider and redesign the interfaces.
2304 In some cases the 'application' can then be reduced to a small
2306 fragment of code built on top of the reusable modules. In these cases
2307 the application could invoked as:
2309 % perl -e 'use Module::Name; method(@ARGV)' ...
2311 % perl -mModule::Name ... (in perl5.002 or higher)
2317 Perl does not enforce private and public parts of its modules as you may
2318 have been used to in other languages like C++, Ada, or Modula-17. Perl
2319 doesn't have an infatuation with enforced privacy. It would prefer
2320 that you stayed out of its living room because you weren't invited, not
2321 because it has a shotgun.
2323 The module and its user have a contract, part of which is common law,
2324 and part of which is "written". Part of the common law contract is
2325 that a module doesn't pollute any namespace it wasn't asked to. The
2326 written contract for the module (A.K.A. documentation) may make other
2327 provisions. But then you know when you C<use RedefineTheWorld> that
2328 you're redefining the world and willing to take the consequences.