1 # Generated by perlmodlib.PL DO NOT EDIT!
5 perlmodlib - constructing new Perl modules and finding existing ones
9 =head1 THE PERL MODULE LIBRARY
11 Many modules are included the Perl distribution. These are described
12 below, and all end in F<.pm>. You may discover compiled library
13 file (usually ending in F<.so>) or small pieces of modules to be
14 autoloaded (ending in F<.al>); these were automatically generated
15 by the installation process. You may also discover files in the
16 library directory that end in either F<.pl> or F<.ph>. These are
17 old libraries supplied so that old programs that use them still
18 run. The F<.pl> files will all eventually be converted into standard
19 modules, and the F<.ph> files made by B<h2ph> will probably end up
20 as extension modules made by B<h2xs>. (Some F<.ph> values may
21 already be available through the POSIX, Errno, or Fcntl modules.)
22 The B<pl2pm> file in the distribution may help in your conversion,
23 but it's just a mechanical process and therefore far from bulletproof.
25 =head2 Pragmatic Modules
27 They work somewhat like compiler directives (pragmata) in that they
28 tend to affect the compilation of your program, and thus will usually
29 work well only when used within a C<use>, or C<no>. Most of these
30 are lexically scoped, so an inner BLOCK may countermand them
37 which lasts until the end of that BLOCK.
39 Some pragmas are lexically scoped--typically those that affect the
40 C<$^H> hints variable. Others affect the current package instead,
41 like C<use vars> and C<use subs>, which allow you to predeclare a
42 variables or subroutines within a particular I<file> rather than
43 just a block. Such declarations are effective for the entire file
44 for which they were declared. You cannot rescind them with C<no
47 The following pragmas are defined (and have their own documentation).
53 Get/set subroutine or variable attributes
57 Set/get attributes of a subroutine (deprecated)
61 Postpone load of modules until a function is used
65 Establish IS-A relationship with base class at compile time
69 Use MakeMaker's uninstalled version of a package
73 Force byte semantics rather than character semantics
77 Define character names for C<\N{named}> string literal escapes.
85 Perl compiler pragma to force verbose warning diagnostics
89 Pragma to control the conversion of legacy data into Unicode
93 Compile-time class fields
97 Control the filetest permission operators
101 Use integer arithmetic instead of floating point
105 Request less of something from the compiler
109 Use and avoid POSIX locales for built-in operations
113 Set default disciplines for input and output
117 Restrict unsafe operations when compiling
121 Package for overloading perl operations
125 Alter regular expression behaviour
129 Enable simple signal handling
133 Control sort() behaviour
137 Restrict unsafe constructs
145 Perl extension allowing use of interpreter based threads from perl
149 Enable/disable UTF-8 (or UTF-EBCDIC) in source code
153 Predeclare global variable names (obsolete)
157 Control VMS-specific language features
161 Control optional warnings
163 =item warnings::register
165 Warnings import function
169 =head2 Standard Modules
171 Standard, bundled modules are all expected to behave in a well-defined
172 manner with respect to namespace pollution because they use the
173 Exporter module. See their own documentation for details.
179 Provide framework for multiple DBMs
181 =item Attribute::Handlers
183 Simpler definition of attribute handlers
187 Load subroutines only on demand
191 Split a package for autoloading
199 Autogenerated data about Perl ops, used to generate bytecode
203 Assemble Perl bytecode
211 Perl compiler's bytecode backend
215 Perl compiler's C backend
219 Perl compiler's optimized C translation backend
223 Walk Perl syntax tree, printing concise info about ops
227 Walk Perl syntax tree, printing debug info about ops
231 Perl compiler backend to produce perl code
233 =item B::Disassembler
235 Disassemble Perl bytecode
243 Show lexical variables used in functions or files
247 Helper module for CC backend
251 Show what stashes are loaded
255 Walk Perl syntax tree, printing terse info about ops
259 Generates cross reference reports for Perl programs
263 Benchmark running times of Perl code
267 Load byte compiled perl code
271 Simple Common Gateway Interface Class
275 Backward compatibility module for CGI.pm
279 CGI routines for writing to the HTTPD (or other) error log
283 Interface to Netscape Cookies
287 CGI Interface for Fast CGI
291 Module to produce nicely formatted HTML code
295 Simple Interface to Server Push
299 Backward compatibility module for defunct CGI::Switch
303 Internal utilities used by CGI module
307 Query, download and build perl modules from CPAN sites
309 =item CPAN::FirstTime
311 Utility for CPAN::Config file Initialization
315 Wrapper around CPAN.pm without using any XS module
319 Warn of errors (from perspective of caller)
323 No user serviceable parts inside
327 Report the search path for a class's ISA tree
331 Declare struct-like datatypes as Perl classes
335 Get pathname of current working directory
339 Programmatic interface to the Perl debugging API (draft, subject to
343 Perl5 access to Berkeley DB version 1.x
345 =item Devel::SelfStubber
347 Generate stubs for a SelfLoading module
351 Modules that calculate message digests
355 Supply object methods for directory handles
359 Provides screen dump of Perl data.
365 =item Encode::EncodeFormat
367 The format of encoding tables of the Encode extension
375 Use nice English (or awk) names for ugly punctuation variables
379 Perl module that imports environment variables as scalars or arrays
383 Implements default import method for modules
385 =item Exporter::Heavy
389 =item ExtUtils::Command
391 Utilities to replace common UNIX commands in Makefiles etc.
393 =item ExtUtils::Constant
395 Generate XS code to import C header constants
397 =item ExtUtils::Embed
399 Utilities for embedding Perl in C/C++ applications
401 =item ExtUtils::Install
403 Install files from here to there
405 =item ExtUtils::Installed
407 Inventory management of installed modules
409 =item ExtUtils::Liblist
411 Determine libraries to use and how to use them
413 =item ExtUtils::MM_Cygwin
415 Methods to override UN*X behaviour in ExtUtils::MakeMaker
417 =item ExtUtils::MM_NW5
419 Methods to override UN*X behaviour in ExtUtils::MakeMaker
421 =item ExtUtils::MM_OS2
423 Methods to override UN*X behaviour in ExtUtils::MakeMaker
425 =item ExtUtils::MM_Unix
427 Methods used by ExtUtils::MakeMaker
429 =item ExtUtils::MM_VMS
431 Methods to override UN*X behaviour in ExtUtils::MakeMaker
433 =item ExtUtils::MM_Win32
435 Methods to override UN*X behaviour in ExtUtils::MakeMaker
437 =item ExtUtils::MakeMaker
439 Create an extension Makefile
441 =item ExtUtils::Manifest
443 Utilities to write and check a MANIFEST file
445 =item ExtUtils::Mkbootstrap
447 Make a bootstrap file for use by DynaLoader
449 =item ExtUtils::Mksymlists
451 Write linker options files for dynamic extension
453 =item ExtUtils::Packlist
455 Manage .packlist files
457 =item ExtUtils::testlib
459 Add blib/* directories to @INC
463 Replace functions with equivalents which succeed or die
467 Load the C Fcntl.h defines
471 Split a pathname into pieces
473 =item File::CheckTree
475 Run many filetest checks on a tree
479 Compare files or filehandles
483 Copy files or filehandles
487 DOS like globbing and then some
495 Create or remove directory trees
499 Portably perform operations on file names
501 =item File::Spec::Epoc
503 Methods for Epoc file specs
505 =item File::Spec::Functions
507 Portably perform operations on file names
509 =item File::Spec::Mac
511 File::Spec for Mac OS (Classic)
513 =item File::Spec::OS2
515 Methods for OS/2 file specs
517 =item File::Spec::Unix
519 File::Spec for Unix, base for other File::Spec modules
521 =item File::Spec::VMS
523 Methods for VMS file specs
525 =item File::Spec::Win32
527 Methods for Win32 file specs
531 Return name and handle of a temporary file safely
535 By-name interface to Perl's built-in stat() functions
539 Keep more files open than the system permits
543 Supply object methods for filehandles
547 Simplified source filtering
551 Locate directory of original perl script
555 Extended processing of command line options
559 Process single-character switches with switch clustering
563 Compare 8-bit scalar data according to the current locale
567 Functions for dealing with RFC3066-style language tags
569 =item I18N::LangTags::List
571 Tags and names for human languages
575 Load various IO modules
579 Open a process for both reading and writing
583 Open a process for reading, writing, and error handling
585 =item Locale::Constants
587 Constants for Locale codes
589 =item Locale::Country
591 ISO codes for country identification (ISO 3166)
593 =item Locale::Currency
595 ISO three letter codes for currency identification (ISO 4217)
597 =item Locale::Language
599 ISO two letter codes for language identification (ISO 639)
601 =item Locale::Maketext
603 Framework for localization
605 =item Locale::Maketext::TPJ13
607 Article about software localization
611 Arbitrary size floating point math package
615 Arbitrary size integer math package
617 =item Math::BigInt::Calc
619 Pure Perl module to support Math::BigInt
623 Complex numbers and associated mathematical functions
627 Trigonometric functions
631 Make your functions faster by trading space for time
633 =item Memoize::AnyDBM_File
635 Glue to provide EXISTS for AnyDBM_File for Storable use
637 =item Memoize::Expire
639 Plug-in module for automatic expiration of memoized values
641 =item Memoize::ExpireFile
643 Test for Memoize expiration semantics
645 =item Memoize::ExpireTest
647 Test for Memoize expiration semantics
649 =item Memoize::NDBM_File
651 Glue to provide EXISTS for NDBM_File for Storable use
653 =item Memoize::SDBM_File
655 Glue to provide EXISTS for SDBM_File for Storable use
659 Plug-in module to specify which return values should be memoized
661 =item Memoize::Storable
663 Store Memoized data in Storable database
667 Tied access to ndbm files
671 Provide a pseudo-class NEXT that allows method redispatch
675 Network Command class (as used by FTP, SMTP etc)
679 Local configuration data for libnet
683 Attempt to evaluate the current host's internet name and domain
695 OO interface to users netrc file
699 Post Office Protocol 3 Client class (RFC1081)
703 Check a remote host for reachability
707 Simple Mail Transfer Protocol Client
711 Time and daytime network client interface
715 By-name interface to Perl's built-in gethost*() functions
719 Libnet Frequently Asked Questions
723 By-name interface to Perl's built-in getnet*() functions
727 By-name interface to Perl's built-in getproto*() functions
731 By-name interface to Perl's built-in getserv*() functions
735 Generic interface to Perl Compiler backends
739 Tied access to odbm files
743 Disable named opcodes when compiling perl code
747 Perl interface to IEEE Std 1003.1
751 On demand loader for PerlIO layers and root of PerlIO::* name space
755 Check pod documents for syntax errors
759 Find POD documents in directory trees
763 Module to convert pod files to HTML
765 =item Pod::InputObjects
767 Objects representing POD input paragraphs, commands, etc.
771 Convert Pod data to formatted Latex
775 Convert POD data to formatted *roff input
779 Parse an LE<lt>E<gt> formatting code in POD text
781 =item Pod::ParseUtils
783 Helpers for POD parsing and conversion
787 Base class for creating POD filters and translators
791 Perl extension for converting Pod to old style Pod.
795 Extract selected sections of POD from input
799 Convert POD data to formatted ASCII text
801 =item Pod::Text::Color
803 Convert POD data to formatted color ASCII text
805 =item Pod::Text::Overstrike
807 Convert POD data to formatted overstrike text
809 =item Pod::Text::Termcap
811 Convert POD data to ASCII text with format escapes
815 Print a usage message from embedded pod documentation
819 Test of various basic POD features in translators.
823 Tied access to sdbm files
827 Compile and execute code in restricted compartments
831 Search for key in dictionary file
835 Save and restore selected file handle
839 Load functions only on demand
843 Run shell commands transparently within perl
847 Load the C socket.h defines and structure manipulators
851 Persistency for perl data structures
855 A switch statement for Perl
859 Manipulate Perl symbols and their names
861 =item Term::ANSIColor
863 Color screen output using ANSI escape sequences
867 Perl termcap interface
871 Perl word completion module
875 Perl interface to various C<readline> packages. If
879 Provides a simple framework for writing test scripts
883 Backend for building test libraries
887 Run perl standard test scripts with statistics
891 Yet another framework for writing test scripts
895 Basic utilities for writing tests.
899 A tutorial about writing really basic tests
903 Create an abbreviation table from a list
907 Extract delimited text sequences from strings.
909 =item Text::ParseWords
911 Parse text into an array of tokens or array of arrays
915 Implementation of the Soundex Algorithm as Described by Knuth
919 Expand and unexpand tabs per the unix expand(1) and unexpand(1)
923 Line wrapping to form simple paragraphs
927 Manipulate threads in Perl
931 Base class for tied arrays
935 Base class definitions for tied handles
939 Base class definitions for tied hashes
943 Use references as hash keys
947 Base class definitions for tied scalars
949 =item Tie::SubstrHash
951 Fixed-table-size, fixed-key-length hashing
955 Efficiently compute time from local and GMT time
959 By-name interface to Perl's built-in gmtime() function
961 =item Time::localtime
963 By-name interface to Perl's built-in localtime() function
967 Internal object used by Time::gmtime and Time::localtime
971 Base class for ALL classes (blessed references)
973 =item Unicode::Collate
975 Use UCA (Unicode Collation Algorithm)
979 Unicode character database
983 By-name interface to Perl's built-in getgr*() functions
987 By-name interface to Perl's built-in getpw*() functions
991 Interfaces to some Win32 API Functions
995 To find out I<all> modules installed on your system, including
996 those without documentation or outside the standard release,
999 % find `perl -e 'print "@INC"'` -name '*.pm' -print
1001 They should all have their own documentation installed and accessible
1002 via your system man(1) command. If you do not have a B<find>
1003 program, you can use the Perl B<find2perl> program instead, which
1004 generates Perl code as output you can run through perl. If you
1005 have a B<man> program but it doesn't find your modules, you'll have
1006 to fix your manpath. See L<perl> for details. If you have no
1007 system B<man> command, you might try the B<perldoc> program.
1009 =head2 Extension Modules
1011 Extension modules are written in C (or a mix of Perl and C). They
1012 are usually dynamically loaded into Perl if and when you need them,
1013 but may also be linked in statically. Supported extension modules
1014 include Socket, Fcntl, and POSIX.
1016 Many popular C extension modules do not come bundled (at least, not
1017 completely) due to their sizes, volatility, or simply lack of time
1018 for adequate testing and configuration across the multitude of
1019 platforms on which Perl was beta-tested. You are encouraged to
1020 look for them on CPAN (described below), or using web search engines
1021 like Alta Vista or Deja News.
1025 CPAN stands for Comprehensive Perl Archive Network; it's a globally
1026 replicated trove of Perl materials, including documentation, style
1027 guides, tricks and traps, alternate ports to non-Unix systems and
1028 occasional binary distributions for these. Search engines for
1029 CPAN can be found at http://cpan.perl.com/ and at
1030 http://theory.uwinnipeg.ca/mod_perl/cpan-search.pl .
1032 Most importantly, CPAN includes around a thousand unbundled modules,
1033 some of which require a C compiler to build. Major categories of
1040 Language Extensions and Documentation Tools
1048 Operating System Interfaces
1052 Networking, Device Control (modems) and InterProcess Communication
1056 Data Types and Data Type Utilities
1068 Interfaces to / Emulations of Other Programming Languages
1072 File Names, File Systems and File Locking (see also File Handles)
1076 String Processing, Language Text Processing, Parsing, and Searching
1080 Option, Argument, Parameter, and Configuration File Processing
1084 Internationalization and Locale
1088 Authentication, Security, and Encryption
1092 World Wide Web, HTML, HTTP, CGI, MIME
1096 Server and Daemon Utilities
1100 Archiving and Compression
1104 Images, Pixmap and Bitmap Manipulation, Drawing, and Graphing
1108 Mail and Usenet News
1112 Control Flow Utilities (callbacks and exceptions etc)
1116 File Handle and Input/Output Stream Utilities
1120 Miscellaneous Modules
1124 Registered CPAN sites as of this writing include the following.
1125 You should try to choose one close to you:
1135 ftp://ftp.is.co.za/programming/perl/CPAN/
1136 ftp://ftp.mweb.co.za/pub/mirrors/cpan/
1137 ftp://ftp.saix.net/pub/CPAN/
1138 ftp://ftp.sun.ac.za/CPAN/
1150 ftp://freesoft.cei.gov.cn/pub/languages/perl/CPAN/
1151 http://www2.linuxforum.net/mirror/CPAN/
1152 http://CPAN.pacific.net.hk/
1153 ftp://ftp.pacific.net.hk/pub/mirror/CPAN/
1154 http://cpan.shellhung.org/
1155 ftp://ftp.shellhung.org/pub/CPAN
1161 http://cpan.in.freeos.com
1162 ftp://cpan.in.freeos.com/pub/CPAN/
1168 http://cpan.itb.web.id/
1169 ftp://mirrors.piksi.itb.ac.id/CPAN/
1170 http://CPAN.mweb.co.id/
1171 ftp://ftp.mweb.co.id/pub/languages/perl/CPAN/
1177 http://www.iglu.org.il:/pub/CPAN/
1178 ftp://ftp.iglu.org.il/pub/CPAN/
1179 http://cpan.lerner.co.il/
1180 http://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
1181 ftp://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
1187 ftp://ftp.u-aizu.ac.jp/pub/CPAN
1188 ftp://ftp.kddlabs.co.jp/CPAN/
1189 http://mirror.nucba.ac.jp/mirror/Perl/
1190 ftp://mirror.nucba.ac.jp/mirror/Perl/
1191 ftp://ftp.meisei-u.ac.jp/pub/CPAN/
1192 ftp://ftp.jaist.ac.jp/pub/lang/perl/CPAN/
1193 ftp://ftp.dti.ad.jp/pub/lang/CPAN/
1194 ftp://ftp.ring.gr.jp/pub/lang/perl/CPAN/
1200 http://mirror.Mazic.org/pub/CPAN
1201 ftp://mirror.Mazic.org/pub/CPAN
1207 http://www.adzu.edu.ph/CPAN
1213 http://cpan.tomsk.ru
1214 ftp://cpan.tomsk.ru/pub/CPAN
1220 ftp://ftp.isu.net.sa/pub/CPAN/
1226 http://cpan.hjc.edu.sg
1232 http://CPAN.bora.net/
1233 ftp://ftp.bora.net/pub/CPAN/
1234 http://ftp.kornet.net/pub/CPAN/
1235 ftp://ftp.kornet.net/pub/CPAN/
1236 ftp://ftp.nuri.net/pub/CPAN/
1242 ftp://coda.nctu.edu.tw/UNIX/perl/CPAN
1243 ftp://ftp.ee.ncku.edu.tw/pub/perl/CPAN/
1244 ftp://ftp1.sinica.edu.tw/pub1/perl/CPAN/
1245 http://ftp.tku.edu.tw/pub/CPAN/
1246 ftp://ftp.tku.edu.tw/pub/CPAN/
1252 http://download.nectec.or.th/CPAN/
1253 ftp://ftp.nectec.or.th/pub/languages/CPAN/
1254 ftp://ftp.cs.riubon.ac.th/pub/mirrors/CPAN/
1258 =head2 Central America
1266 ftp://ftp.linux.co.cr/mirrors/CPAN/
1267 http://ftp.ucr.ac.cr/Unix/CPAN/
1268 ftp://ftp.ucr.ac.cr/pub/Unix/CPAN/
1280 ftp://ftp.tuwien.ac.at/pub/CPAN/
1286 http://ftp.easynet.be/pub/CPAN/
1287 ftp://ftp.easynet.be/pub/CPAN/
1288 http://cpan.skynet.be
1289 ftp://ftp.skynet.be/pub/CPAN
1290 ftp://ftp.kulnet.kuleuven.ac.be/pub/mirror/CPAN/
1296 ftp://ftp.ntrl.net/pub/mirrors/CPAN/
1302 ftp://ftp.linux.hr/pub/CPAN/
1308 http://ftp.fi.muni.cz/pub/CPAN/
1309 ftp://ftp.fi.muni.cz/pub/CPAN/
1310 ftp://sunsite.mff.cuni.cz/MIRRORS/ftp.funet.fi/pub/languages/perl/CPAN/
1316 http://mirrors.sunsite.dk/cpan/
1317 ftp://sunsite.dk/mirrors/cpan/
1318 http://www.cpan.dk/CPAN/
1319 ftp://www.cpan.dk/ftp.cpan.org/CPAN/
1325 http://www.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN
1326 ftp://ftp.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN/
1327 http://cpan.crazygreek.co.uk
1328 ftp://ftp.demon.co.uk/pub/CPAN/
1329 ftp://ftp.flirble.org/pub/languages/perl/CPAN/
1330 ftp://ftp.plig.org/pub/CPAN/
1331 ftp://sunsite.doc.ic.ac.uk/packages/CPAN/
1332 http://mirror.uklinux.net/CPAN/
1333 ftp://mirror.uklinux.net/pub/CPAN/
1334 ftp://usit.shef.ac.uk/pub/packages/CPAN/
1340 ftp://ftp.ut.ee/pub/languages/perl/CPAN/
1346 ftp://ftp.funet.fi/pub/languages/perl/CPAN/
1347 http://cpan.kpnqwest.fi/
1353 ftp://cpan.ftp.worldonline.fr/pub/CPAN/
1354 http://cpan.mirrors.easynet.fr/
1355 ftp://cpan.mirrors.easynet.fr/pub/ftp.cpan.org/
1356 ftp://ftp.club-internet.fr/pub/perl/CPAN/
1358 ftp://ftp.lip6.fr/pub/perl/CPAN/
1359 ftp://ftp.oleane.net/pub/mirrors/CPAN/
1360 ftp://ftp.pasteur.fr/pub/computing/CPAN/
1361 http://cpan.cict.fr/
1362 ftp://cpan.cict.fr/pub/CPAN/
1363 ftp://ftp.uvsq.fr/pub/perl/CPAN/
1369 ftp://ftp.rz.ruhr-uni-bochum.de/pub/CPAN/
1370 ftp://ftp.freenet.de/pub/ftp.cpan.org/pub/CPAN/
1371 ftp://ftp.uni-erlangen.de/pub/source/CPAN/
1372 ftp://ftp-stud.fht-esslingen.de/pub/Mirrors/CPAN
1373 ftp://ftp.gigabell.net/pub/CPAN/
1374 http://ftp.gwdg.de/pub/languages/perl/CPAN/
1375 ftp://ftp.gwdg.de/pub/languages/perl/CPAN/
1376 ftp://ftp.uni-hamburg.de/pub/soft/lang/perl/CPAN/
1377 ftp://ftp.leo.org/pub/CPAN/
1378 http://cpan.noris.de/
1379 ftp://cpan.noris.de/pub/CPAN/
1380 ftp://ftp.mpi-sb.mpg.de/pub/perl/CPAN/
1381 ftp://ftp.gmd.de/mirrors/CPAN/
1387 ftp://ftp.forthnet.gr/pub/languages/perl/CPAN
1388 ftp://ftp.ntua.gr/pub/lang/perl/
1394 http://cpan.artifact.hu/
1395 ftp://cpan.artifact.hu/CPAN/
1396 http://ftp.kfki.hu/pub/CPAN/
1397 ftp://ftp.kfki.hu/pub/CPAN/
1403 http://ftp.rhnet.is/pub/CPAN/
1404 ftp://ftp.rhnet.is/pub/CPAN/
1410 http://cpan.indigo.ie/
1411 ftp://cpan.indigo.ie/pub/CPAN/
1412 http://sunsite.compapp.dcu.ie/pub/perl/
1413 ftp://sunsite.compapp.dcu.ie/pub/perl/
1419 http://cpan.nettuno.it/
1420 http://gusp.dyndns.org/CPAN/
1421 ftp://gusp.dyndns.org/pub/CPAN
1422 http://softcity.iol.it/cpan
1423 ftp://softcity.iol.it/pub/cpan
1424 ftp://ftp.unina.it/pub/Other/CPAN/
1425 ftp://ftp.unipi.it/pub/mirror/perl/CPAN/
1426 ftp://cis.uniRoma2.it/CPAN/
1427 ftp://ftp.edisontel.it/pub/CPAN_Mirror/
1428 ftp://ftp.flashnet.it/pub/CPAN/
1434 http://kvin.lv/pub/CPAN/
1440 ftp://ftp.unix.lt/pub/CPAN/
1446 ftp://download.xs4all.nl/pub/mirror/CPAN/
1447 ftp://ftp.nl.uu.net/pub/CPAN/
1448 ftp://ftp.nluug.nl/pub/languages/perl/CPAN/
1449 http://cpan.cybercomm.nl/
1450 ftp://mirror.cybercomm.nl/pub/cpan/
1451 ftp://ftp.cpan.nl/pub/CPAN/
1452 http://www.cs.uu.nl/mirror/CPAN/
1453 ftp://ftp.cs.uu.nl/mirror/CPAN/
1459 ftp://ftp.uninett.no/pub/languages/perl/CPAN
1460 ftp://ftp.uit.no/pub/languages/perl/cpan/
1466 ftp://ftp.pk.edu.pl/pub/lang/perl/CPAN/
1467 http://www.fic.uni.lodz.pl/pub/CPAN
1468 ftp://ftp.fic.uni.lodz.pl/pub/CPAN
1469 ftp://ftp.mega.net.pl/pub/mirrors/ftp.perl.com/
1470 ftp://ftp.man.torun.pl/pub/doc/CPAN/
1471 ftp://sunsite.icm.edu.pl/pub/CPAN/
1477 ftp://ftp.ua.pt/pub/CPAN/
1478 ftp://perl.di.uminho.pt/pub/CPAN/
1480 ftp://cpan.ip.pt/pub/perl/
1481 ftp://ftp.ist.utl.pt/pub/CPAN/
1483 ftp://cpan.ip.pt/pub/cpan/
1484 ftp://ftp.netc.pt/pub/CPAN/
1485 ftp://ftp.up.pt/pub/CPAN
1491 ftp://archive.logicnet.ro/mirrors/ftp.cpan.org/CPAN/
1492 ftp://ftp.kappa.ro/pub/mirrors/ftp.perl.org/pub/CPAN/
1493 ftp://ftp.dntis.ro/pub/cpan/
1494 ftp://ftp.opsynet.com/cpan/
1495 ftp://ftp.dnttm.ro/pub/CPAN/
1496 ftp://ftp.lasting.ro/pub/CPAN
1497 ftp://ftp.timisoara.roedu.net/mirrors/CPAN/
1503 ftp://ftp.chg.ru/pub/lang/perl/CPAN/
1504 http://cpan.rinet.ru/
1505 ftp://cpan.rinet.ru/pub/mirror/CPAN/
1506 ftp://ftp.aha.ru/pub/CPAN/
1507 http://cpan.sai.msu.ru/
1508 ftp://ftp.sai.msu.su/pub/lang/perl/CPAN/
1514 ftp://ftp.entry.sk/pub/languages/perl/CPAN/
1520 ftp://ftp.arnes.si/software/perl/CPAN/
1526 ftp://ftp.rediris.es/mirror/CPAN/
1527 ftp://ftp.etse.urv.es/pub/perl/
1533 http://ftp.du.se/CPAN/
1534 ftp://ftp.du.se/pub/CPAN/
1535 ftp://mirror.dataphone.se/pub/CPAN
1536 ftp://ftp.sunet.se/pub/lang/perl/CPAN/
1542 ftp://ftp.danyk.ch/CPAN/
1543 ftp://sunsite.cnlab-switch.ch/mirror/CPAN/
1549 ftp://sunsite.bilkent.edu.tr/pub/languages/CPAN/
1557 ftp://ftp.perl.org.ua/pub/CPAN/
1561 =head2 North America
1575 http://sunsite.ualberta.ca/pub/Mirror/CPAN/
1576 ftp://sunsite.ualberta.ca/pub/Mirror/CPAN/
1582 http://theoryx5.uwinnipeg.ca/pub/CPAN/
1583 ftp://theoryx5.uwinnipeg.ca/pub/CPAN/
1589 ftp://cpan.chebucto.ns.ca/pub/CPAN/
1595 ftp://ftp.crc.ca/pub/CPAN/
1601 http://cpan.mirror.smartworker.org/
1602 ftp://cpan.mirror.smartworker.org/pub/CPAN
1610 http://cpan.azc.uam.mx
1611 ftp://cpan.azc.uam.mx/mirrors/CPAN
1612 http://cpan.unam.mx/
1613 ftp://cpan.unam.mx/pub/CPAN
1614 http://www.msg.com.mx/CPAN/
1615 ftp://ftp.msg.com.mx/pub/CPAN/
1627 http://mirror.hiwaay.net/CPAN/
1628 ftp://mirror.hiwaay.net/CPAN/
1634 http://www.cpan.org/
1635 ftp://cpan.valueclick.com/pub/CPAN/
1636 http://mirrors.gossamer-threads.com/CPAN
1637 ftp://cpan.nas.nasa.gov/pub/perl/CPAN/
1638 ftp://ftp.digital.com/pub/plan/perl/CPAN/
1639 http://mirrors.kernel.org/cpan/
1640 ftp://mirrors.kernel.org/pub/CPAN
1641 http://cpan.digisle.net/
1642 ftp://cpan.digisle.net/pub/CPAN
1643 http://www.linuxjar.com/CPAN
1644 ftp://linuxjar.com/pub/CPAN
1645 http://www.perl.com/CPAN/
1646 http://download.sourceforge.net/mirrors/CPAN/
1652 ftp://ftp.cs.colorado.edu/pub/perl/CPAN/
1656 District of Columbia
1658 ftp://ftp.dc.us.telia.net/pub/cpan/
1664 ftp://ftp.cise.ufl.edu/pub/mirrors/CPAN/
1665 http://mirror.csit.fsu.edu/pub/CPAN/
1666 ftp://mirror.csit.fsu.edu/pub/CPAN/
1672 http://uiarchive.uiuc.edu/mirrors/ftp/cpan.cse.msu.edu/
1673 ftp://uiarchive.uiuc.edu/mirrors/ftp/cpan.cse.msu.edu/
1679 ftp://ftp.uwsg.indiana.edu/pub/perl/CPAN/
1680 http://cpan.nitco.com/
1681 ftp://cpan.nitco.com/pub/CPAN/
1682 http://archive.progeny.com/CPAN/
1683 ftp://archive.progeny.com/CPAN/
1684 ftp://cpan.in-span.net/
1685 http://csociety-ftp.ecn.purdue.edu/pub/CPAN
1686 ftp://csociety-ftp.ecn.purdue.edu/pub/CPAN
1692 http://cpan.uky.edu/
1693 ftp://cpan.uky.edu/pub/CPAN/
1699 ftp://ftp.ccs.neu.edu/net/mirrors/ftp.funet.fi/pub/languages/perl/CPAN/
1700 http://cpan.mirrors.netnumina.com/
1701 ftp://mirrors.netnumina.com/cpan/
1702 ftp://ftp.iguide.com/pub/mirrors/packages/perl/CPAN/
1708 ftp://cpan.cse.msu.edu/
1714 ftp://ftp.cpanel.net/pub/CPAN/
1720 ftp://ftp.freesoftware.com/pub/perl/CPAN/
1721 ftp://ftp.stealth.net/pub/CPAN/
1722 http://www.rge.com/pub/languages/perl/
1723 ftp://ftp.rge.com/pub/languages/perl/
1724 ftp://mirrors.cloud9.net/pub/mirrors/CPAN/
1730 ftp://ftp.duke.edu/pub/perl/
1736 ftp://ftp.loaded.net/pub/CPAN/
1742 ftp://ftp.ou.edu/mirrors/CPAN/
1748 ftp://ftp.orst.edu/pub/CPAN
1754 http://ftp.epix.net/CPAN/
1755 ftp://ftp.epix.net/pub/languages/perl/
1756 http://mirrors.phenominet.com/pub/CPAN/
1757 ftp://mirrors.phenominet.com/pub/CPAN/
1758 ftp://carroll.cac.psu.edu/pub/CPAN/
1764 ftp://ftp.sunsite.utk.edu/pub/CPAN/
1770 http://ftp.sedl.org/pub/mirrors/CPAN/
1776 ftp://mirror.xmission.com/CPAN/
1782 http://mirrors.rcn.net/pub/lang/CPAN/
1783 ftp://mirrors.rcn.net/pub/lang/CPAN/
1784 ftp://ruff.cs.jmu.edu/pub/CPAN/
1785 http://perl.Liquidation.com/CPAN/
1791 http://cpan.llarian.net/
1792 ftp://cpan.llarian.net/pub/CPAN/
1793 http://cpan.mirrorcentral.com/
1794 ftp://ftp.mirrorcentral.com/pub/CPAN/
1795 ftp://ftp-mirror.internap.com/pub/CPAN/
1809 http://ftp.planetmirror.com/pub/CPAN/
1810 ftp://ftp.planetmirror.com/pub/CPAN/
1811 ftp://mirror.aarnet.edu.au/pub/perl/CPAN/
1812 ftp://cpan.topend.com.au/pub/CPAN/
1817 ftp://ftp.auckland.ac.nz/pub/perl/CPAN/
1821 =head2 South America
1829 ftp://mirrors.bannerlandia.com.ar/mirrors/CPAN/
1835 ftp://cpan.pop-mg.com.br/pub/CPAN/
1836 ftp://ftp.matrix.com.br/pub/perl/CPAN/
1842 ftp://ftp.psinet.cl/pub/programming/perl/CPAN/
1843 ftp://sunsite.dcc.uchile.cl/pub/lang/perl/
1848 For an up-to-date listing of CPAN sites,
1849 see http://www.cpan.org/SITES or ftp://www.cpan.org/SITES .
1851 =head1 Modules: Creation, Use, and Abuse
1853 (The following section is borrowed directly from Tim Bunce's modules
1854 file, available at your nearest CPAN site.)
1856 Perl implements a class using a package, but the presence of a
1857 package doesn't imply the presence of a class. A package is just a
1858 namespace. A class is a package that provides subroutines that can be
1859 used as methods. A method is just a subroutine that expects, as its
1860 first argument, either the name of a package (for "static" methods),
1861 or a reference to something (for "virtual" methods).
1863 A module is a file that (by convention) provides a class of the same
1864 name (sans the .pm), plus an import method in that class that can be
1865 called to fetch exported symbols. This module may implement some of
1866 its methods by loading dynamic C or C++ objects, but that should be
1867 totally transparent to the user of the module. Likewise, the module
1868 might set up an AUTOLOAD function to slurp in subroutine definitions on
1869 demand, but this is also transparent. Only the F<.pm> file is required to
1870 exist. See L<perlsub>, L<perltoot>, and L<AutoLoader> for details about
1871 the AUTOLOAD mechanism.
1873 =head2 Guidelines for Module Creation
1879 Do similar modules already exist in some form?
1881 If so, please try to reuse the existing modules either in whole or
1882 by inheriting useful features into a new class. If this is not
1883 practical try to get together with the module authors to work on
1884 extending or enhancing the functionality of the existing modules.
1885 A perfect example is the plethora of packages in perl4 for dealing
1886 with command line options.
1888 If you are writing a module to expand an already existing set of
1889 modules, please coordinate with the author of the package. It
1890 helps if you follow the same naming scheme and module interaction
1891 scheme as the original author.
1895 Try to design the new module to be easy to extend and reuse.
1897 Try to C<use warnings;> (or C<use warnings qw(...);>).
1898 Remember that you can add C<no warnings qw(...);> to individual blocks
1899 of code that need less warnings.
1901 Use blessed references. Use the two argument form of bless to bless
1902 into the class name given as the first parameter of the constructor,
1907 return bless {}, $class;
1910 or even this if you'd like it to be used as either a static
1911 or a virtual method.
1915 my $class = ref($self) || $self;
1916 return bless {}, $class;
1919 Pass arrays as references so more parameters can be added later
1920 (it's also faster). Convert functions into methods where
1921 appropriate. Split large methods into smaller more flexible ones.
1922 Inherit methods from other modules if appropriate.
1924 Avoid class name tests like: C<die "Invalid" unless ref $ref eq 'FOO'>.
1925 Generally you can delete the C<eq 'FOO'> part with no harm at all.
1926 Let the objects look after themselves! Generally, avoid hard-wired
1927 class names as far as possible.
1929 Avoid C<< $r->Class::func() >> where using C<@ISA=qw(... Class ...)> and
1930 C<< $r->func() >> would work (see L<perlbot> for more details).
1932 Use autosplit so little used or newly added functions won't be a
1933 burden to programs that don't use them. Add test functions to
1934 the module after __END__ either using AutoSplit or by saying:
1936 eval join('',<main::DATA>) || die $@ unless caller();
1938 Does your module pass the 'empty subclass' test? If you say
1939 C<@SUBCLASS::ISA = qw(YOURCLASS);> your applications should be able
1940 to use SUBCLASS in exactly the same way as YOURCLASS. For example,
1941 does your application still work if you change: C<$obj = new YOURCLASS;>
1942 into: C<$obj = new SUBCLASS;> ?
1944 Avoid keeping any state information in your packages. It makes it
1945 difficult for multiple other packages to use yours. Keep state
1946 information in objects.
1950 Try to C<use strict;> (or C<use strict qw(...);>).
1951 Remember that you can add C<no strict qw(...);> to individual blocks
1952 of code that need less strictness.
1956 Follow the guidelines in the perlstyle(1) manual.
1962 Some simple style guidelines
1964 The perlstyle manual supplied with Perl has many helpful points.
1966 Coding style is a matter of personal taste. Many people evolve their
1967 style over several years as they learn what helps them write and
1968 maintain good code. Here's one set of assorted suggestions that
1969 seem to be widely used by experienced developers:
1971 Use underscores to separate words. It is generally easier to read
1972 $var_names_like_this than $VarNamesLikeThis, especially for
1973 non-native speakers of English. It's also a simple rule that works
1974 consistently with VAR_NAMES_LIKE_THIS.
1976 Package/Module names are an exception to this rule. Perl informally
1977 reserves lowercase module names for 'pragma' modules like integer
1978 and strict. Other modules normally begin with a capital letter and
1979 use mixed case with no underscores (need to be short and portable).
1981 You may find it helpful to use letter case to indicate the scope
1982 or nature of a variable. For example:
1984 $ALL_CAPS_HERE constants only (beware clashes with Perl vars)
1985 $Some_Caps_Here package-wide global/static
1986 $no_caps_here function scope my() or local() variables
1988 Function and method names seem to work best as all lowercase.
1989 e.g., C<< $obj->as_string() >>.
1991 You can use a leading underscore to indicate that a variable or
1992 function should not be used outside the package that defined it.
1996 Select what to export.
1998 Do NOT export method names!
2000 Do NOT export anything else by default without a good reason!
2002 Exports pollute the namespace of the module user. If you must
2003 export try to use @EXPORT_OK in preference to @EXPORT and avoid
2004 short or common names to reduce the risk of name clashes.
2006 Generally anything not exported is still accessible from outside the
2007 module using the ModuleName::item_name (or C<< $blessed_ref->method >>)
2008 syntax. By convention you can use a leading underscore on names to
2009 indicate informally that they are 'internal' and not for public use.
2011 (It is actually possible to get private functions by saying:
2012 C<my $subref = sub { ... }; &$subref;>. But there's no way to call that
2013 directly as a method, because a method must have a name in the symbol
2016 As a general rule, if the module is trying to be object oriented
2017 then export nothing. If it's just a collection of functions then
2018 @EXPORT_OK anything but use @EXPORT with caution.
2022 Select a name for the module.
2024 This name should be as descriptive, accurate, and complete as
2025 possible. Avoid any risk of ambiguity. Always try to use two or
2026 more whole words. Generally the name should reflect what is special
2027 about what the module does rather than how it does it. Please use
2028 nested module names to group informally or categorize a module.
2029 There should be a very good reason for a module not to have a nested name.
2030 Module names should begin with a capital letter.
2032 Having 57 modules all called Sort will not make life easy for anyone
2033 (though having 23 called Sort::Quick is only marginally better :-).
2034 Imagine someone trying to install your module alongside many others.
2035 If in any doubt ask for suggestions in comp.lang.perl.misc.
2037 If you are developing a suite of related modules/classes it's good
2038 practice to use nested classes with a common prefix as this will
2039 avoid namespace clashes. For example: Xyz::Control, Xyz::View,
2040 Xyz::Model etc. Use the modules in this list as a naming guide.
2042 If adding a new module to a set, follow the original author's
2043 standards for naming modules and the interface to methods in
2046 If developing modules for private internal or project specific use,
2047 that will never be released to the public, then you should ensure
2048 that their names will not clash with any future public module. You
2049 can do this either by using the reserved Local::* category or by
2050 using a category name that includes an underscore like Foo_Corp::*.
2052 To be portable each component of a module name should be limited to
2053 11 characters. If it might be used on MS-DOS then try to ensure each is
2054 unique in the first 8 characters. Nested modules make this easier.
2058 Have you got it right?
2060 How do you know that you've made the right decisions? Have you
2061 picked an interface design that will cause problems later? Have
2062 you picked the most appropriate name? Do you have any questions?
2064 The best way to know for sure, and pick up many helpful suggestions,
2065 is to ask someone who knows. Comp.lang.perl.misc is read by just about
2066 all the people who develop modules and it's the best place to ask.
2068 All you need to do is post a short summary of the module, its
2069 purpose and interfaces. A few lines on each of the main methods is
2070 probably enough. (If you post the whole module it might be ignored
2071 by busy people - generally the very people you want to read it!)
2073 Don't worry about posting if you can't say when the module will be
2074 ready - just say so in the message. It might be worth inviting
2075 others to help you, they may be able to complete it for you!
2079 README and other Additional Files.
2081 It's well known that software developers usually fully document the
2082 software they write. If, however, the world is in urgent need of
2083 your software and there is not enough time to write the full
2084 documentation please at least provide a README file containing:
2090 A description of the module/package/extension etc.
2094 A copyright notice - see below.
2098 Prerequisites - what else you may need to have.
2102 How to build it - possible changes to Makefile.PL etc.
2110 Recent changes in this release, especially incompatibilities
2114 Changes / enhancements you plan to make in the future.
2118 If the README file seems to be getting too large you may wish to
2119 split out some of the sections into separate files: INSTALL,
2126 Adding a Copyright Notice.
2128 How you choose to license your work is a personal decision.
2129 The general mechanism is to assert your Copyright and then make
2130 a declaration of how others may copy/use/modify your work.
2132 Perl, for example, is supplied with two types of licence: The GNU
2133 GPL and The Artistic Licence (see the files README, Copying, and
2134 Artistic). Larry has good reasons for NOT just using the GNU GPL.
2136 My personal recommendation, out of respect for Larry, Perl, and the
2137 Perl community at large is to state something simply like:
2139 Copyright (c) 1995 Your Name. All rights reserved.
2140 This program is free software; you can redistribute it and/or
2141 modify it under the same terms as Perl itself.
2143 This statement should at least appear in the README file. You may
2144 also wish to include it in a Copying file and your source files.
2145 Remember to include the other words in addition to the Copyright.
2149 Give the module a version/issue/release number.
2151 To be fully compatible with the Exporter and MakeMaker modules you
2152 should store your module's version number in a non-my package
2153 variable called $VERSION. This should be a floating point
2154 number with at least two digits after the decimal (i.e., hundredths,
2155 e.g, C<$VERSION = "0.01">). Don't use a "1.3.2" style version.
2156 See L<Exporter> for details.
2158 It may be handy to add a function or method to retrieve the number.
2159 Use the number in announcements and archive file names when
2160 releasing the module (ModuleName-1.02.tar.Z).
2161 See perldoc ExtUtils::MakeMaker.pm for details.
2165 How to release and distribute a module.
2167 It's good idea to post an announcement of the availability of your
2168 module (or the module itself if small) to the comp.lang.perl.announce
2169 Usenet newsgroup. This will at least ensure very wide once-off
2172 If possible, register the module with CPAN. You should
2173 include details of its location in your announcement.
2175 Some notes about ftp archives: Please use a long descriptive file
2176 name that includes the version number. Most incoming directories
2177 will not be readable/listable, i.e., you won't be able to see your
2178 file after uploading it. Remember to send your email notification
2179 message as soon as possible after uploading else your file may get
2180 deleted automatically. Allow time for the file to be processed
2181 and/or check the file has been processed before announcing its
2184 FTP Archives for Perl Modules:
2186 Follow the instructions and links on:
2188 http://www.cpan.org/modules/00modlist.long.html
2189 http://www.cpan.org/modules/04pause.html
2191 or upload to one of these sites:
2193 https://pause.kbx.de/pause/
2194 http://pause.perl.org/pause/
2196 and notify <modules@perl.org>.
2198 By using the WWW interface you can ask the Upload Server to mirror
2199 your modules from your ftp or WWW site into your own directory on
2202 Please remember to send me an updated entry for the Module list!
2206 Take care when changing a released module.
2208 Always strive to remain compatible with previous released versions.
2209 Otherwise try to add a mechanism to revert to the
2210 old behavior if people rely on it. Document incompatible changes.
2216 =head2 Guidelines for Converting Perl 4 Library Scripts into Modules
2222 There is no requirement to convert anything.
2224 If it ain't broke, don't fix it! Perl 4 library scripts should
2225 continue to work with no problems. You may need to make some minor
2226 changes (like escaping non-array @'s in double quoted strings) but
2227 there is no need to convert a .pl file into a Module for just that.
2231 Consider the implications.
2233 All Perl applications that make use of the script will need to
2234 be changed (slightly) if the script is converted into a module. Is
2235 it worth it unless you plan to make other changes at the same time?
2239 Make the most of the opportunity.
2241 If you are going to convert the script to a module you can use the
2242 opportunity to redesign the interface. The guidelines for module
2243 creation above include many of the issues you should consider.
2247 The pl2pm utility will get you started.
2249 This utility will read *.pl files (given as parameters) and write
2250 corresponding *.pm files. The pl2pm utilities does the following:
2256 Adds the standard Module prologue lines
2260 Converts package specifiers from ' to ::
2264 Converts die(...) to croak(...)
2268 Several other minor changes
2272 Being a mechanical process pl2pm is not bullet proof. The converted
2273 code will need careful checking, especially any package statements.
2274 Don't delete the original .pl file till the new .pm one works!
2278 =head2 Guidelines for Reusing Application Code
2284 Complete applications rarely belong in the Perl Module Library.
2288 Many applications contain some Perl code that could be reused.
2290 Help save the world! Share your code in a form that makes it easy
2295 Break-out the reusable code into one or more separate module files.
2299 Take the opportunity to reconsider and redesign the interfaces.
2303 In some cases the 'application' can then be reduced to a small
2305 fragment of code built on top of the reusable modules. In these cases
2306 the application could invoked as:
2308 % perl -e 'use Module::Name; method(@ARGV)' ...
2310 % perl -mModule::Name ... (in perl5.002 or higher)
2316 Perl does not enforce private and public parts of its modules as you may
2317 have been used to in other languages like C++, Ada, or Modula-17. Perl
2318 doesn't have an infatuation with enforced privacy. It would prefer
2319 that you stayed out of its living room because you weren't invited, not
2320 because it has a shotgun.
2322 The module and its user have a contract, part of which is common law,
2323 and part of which is "written". Part of the common law contract is
2324 that a module doesn't pollute any namespace it wasn't asked to. The
2325 written contract for the module (A.K.A. documentation) may make other
2326 provisions. But then you know when you C<use RedefineTheWorld> that
2327 you're redefining the world and willing to take the consequences.