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 escape.
85 Perl compiler pragma to force verbose warning diagnostics
89 Compile-time class fields
93 Control the filetest permission operators
97 Use integer arithmetic instead of floating point
101 Request less of something from the compiler
105 Use and avoid POSIX locales for built-in operations
109 Set default disciplines for input and output
113 Restrict unsafe operations when compiling
117 Package for overloading perl operations
121 Alter regular expression behaviour
125 Enable simple signal handling
129 Restrict unsafe constructs
135 =item unicode::distinct
137 Strictly distinguish UTF8 data and non-UTF data.
141 Enable/disable UTF-8 in source code
145 Predeclare global variable names (obsolete)
149 Control optional warnings
151 =item warnings::register
153 Warnings import function
157 =head2 Standard Modules
159 Standard, bundled modules are all expected to behave in a well-defined
160 manner with respect to namespace pollution because they use the
161 Exporter module. See their own documentation for details.
167 Provide framework for multiple DBMs
171 Load subroutines only on demand
175 Split a package for autoloading
183 Autogenerated data about Perl ops, used to generate bytecode
187 Assemble Perl bytecode
195 Perl compiler's bytecode backend
199 Perl compiler's C backend
203 Perl compiler's optimized C translation backend
207 Walk Perl syntax tree, printing concise info about ops
211 Walk Perl syntax tree, printing debug info about ops
215 Perl compiler backend to produce perl code
217 =item B::Disassembler
219 Disassemble Perl bytecode
227 Show lexical variables used in functions or files
231 Helper module for CC backend
235 Show what stashes are loaded
239 Walk Perl syntax tree, printing terse info about ops
243 Generates cross reference reports for Perl programs
247 Benchmark running times of Perl code
251 Load byte compiled perl code
255 Simple Common Gateway Interface Class
259 Backward compatibility module for CGI.pm
263 CGI routines for writing to the HTTPD (or other) error log
267 Interface to Netscape Cookies
271 CGI Interface for Fast CGI
275 Module to produce nicely formatted HTML code
279 Simple Interface to Server Push
283 Backward compatibility module for defunct CGI::Switch
287 Internal utilities used by CGI module
291 Query, download and build perl modules from CPAN sites
293 =item CPAN::FirstTime
295 Utility for CPAN::Config file Initialization
299 Wrapper around CPAN.pm without using any XS module
303 Warn of errors (from perspective of caller)
307 No user serviceable parts inside
311 Report the search path for a class's ISA tree
315 Declare struct-like datatypes as Perl classes
319 Get pathname of current working directory
323 Programmatic interface to the Perl debugging API (draft, subject to
327 Perl5 access to Berkeley DB version 1.x
329 =item Devel::SelfStubber
331 Generate stubs for a SelfLoading module
335 Modules that calculate message digests
339 Supply object methods for directory handles
343 Provides screen dump of Perl data.
349 =item Encode::EncodeFormat
351 The format of encoding tables of the Encode extension
359 Use nice English (or awk) names for ugly punctuation variables
363 Perl module that imports environment variables as scalars or arrays
367 Implements default import method for modules
369 =item Exporter::Heavy
373 =item ExtUtils::Command
375 Utilities to replace common UNIX commands in Makefiles etc.
377 =item ExtUtils::Embed
379 Utilities for embedding Perl in C/C++ applications
381 =item ExtUtils::Install
383 Install files from here to there
385 =item ExtUtils::Installed
387 Inventory management of installed modules
389 =item ExtUtils::Liblist
391 Determine libraries to use and how to use them
393 =item ExtUtils::MM_Cygwin
395 Methods to override UN*X behaviour in ExtUtils::MakeMaker
397 =item ExtUtils::MM_OS2
399 Methods to override UN*X behaviour in ExtUtils::MakeMaker
401 =item ExtUtils::MM_Unix
403 Methods used by ExtUtils::MakeMaker
405 =item ExtUtils::MM_VMS
407 Methods to override UN*X behaviour in ExtUtils::MakeMaker
409 =item ExtUtils::MM_Win32
411 Methods to override UN*X behaviour in ExtUtils::MakeMaker
413 =item ExtUtils::MakeMaker
415 Create an extension Makefile
417 =item ExtUtils::Manifest
419 Utilities to write and check a MANIFEST file
421 =item ExtUtils::Mkbootstrap
423 Make a bootstrap file for use by DynaLoader
425 =item ExtUtils::Mksymlists
427 Write linker options files for dynamic extension
429 =item ExtUtils::Packlist
431 Manage .packlist files
433 =item ExtUtils::testlib
435 Add blib/* directories to @INC
439 Replace functions with equivalents which succeed or die
443 Load the C Fcntl.h defines
447 Split a pathname into pieces
449 =item File::CheckTree
451 Run many filetest checks on a tree
455 Compare files or filehandles
459 Copy files or filehandles
463 DOS like globbing and then some
471 Create or remove directory trees
475 Portably perform operations on file names
477 =item File::Spec::Epoc
479 Methods for Epoc file specs
481 =item File::Spec::Functions
483 Portably perform operations on file names
485 =item File::Spec::Mac
489 =item File::Spec::OS2
491 Methods for OS/2 file specs
493 =item File::Spec::Unix
495 Methods used by File::Spec
497 =item File::Spec::VMS
499 Methods for VMS file specs
501 =item File::Spec::Win32
503 Methods for Win32 file specs
507 Return name and handle of a temporary file safely
511 By-name interface to Perl's built-in stat() functions
515 Keep more files open than the system permits
519 Supply object methods for filehandles
523 Simplified source filtering
527 Locate directory of original perl script
531 Extended processing of command line options
535 Process single-character switches with switch clustering
539 Compare 8-bit scalar data according to the current locale
543 Load various IO modules
547 Open a process for both reading and writing
551 Open a process for reading, writing, and error handling
553 =item Locale::Constants
555 Constants for Locale codes
557 =item Locale::Country
559 ISO codes for country identification (ISO 3166)
561 =item Locale::Currency
563 ISO three letter codes for currency identification (ISO 4217)
565 =item Locale::Language
567 ISO two letter codes for language identification (ISO 639)
571 Arbitrary length float math package
575 Arbitrary size integer math package
579 Complex numbers and associated mathematical functions
583 Trigonometric functions
587 Tied access to ndbm files
591 Check a remote host for reachability
595 By-name interface to Perl's built-in gethost*() functions
599 By-name interface to Perl's built-in getnet*() functions
603 By-name interface to Perl's built-in getproto*() functions
607 By-name interface to Perl's built-in getserv*() functions
611 Generic interface to Perl Compiler backends
615 Tied access to odbm files
619 Disable named opcodes when compiling perl code
623 Perl interface to IEEE Std 1003.1
627 On demand loader for PerlIO layers and root of PerlIO::* name space
631 Check pod documents for syntax errors
635 Find POD documents in directory trees
639 Module to convert pod files to HTML
641 =item Pod::InputObjects
643 Objects representing POD input paragraphs, commands, etc.
647 Convert Pod data to formatted Latex
651 Convert POD data to formatted *roff input
653 =item Pod::ParseUtils
655 Helpers for POD parsing and conversion
659 Base class for creating POD filters and translators
663 Perl extension for converting Pod to old style Pod.
667 Extract selected sections of POD from input
671 Convert POD data to formatted ASCII text
673 =item Pod::Text::Color
675 Convert POD data to formatted color ASCII text
677 =item Pod::Text::Overstrike
679 Convert POD data to formatted overstrike text
681 =item Pod::Text::Termcap
683 Convert POD data to ASCII text with format escapes
687 Print a usage message from embedded pod documentation
691 Tied access to sdbm files
695 Compile and execute code in restricted compartments
699 Search for key in dictionary file
703 Save and restore selected file handle
707 Load functions only on demand
711 Run shell commands transparently within perl
715 Load the C socket.h defines and structure manipulators
719 Persistency for perl data structures
723 A switch statement for Perl
727 Manipulate Perl symbols and their names
729 =item Term::ANSIColor
731 Color screen output using ANSI escape sequences
735 Perl termcap interface
739 Perl word completion module
743 Perl interface to various C<readline> packages. If
747 Provides a simple framework for writing test scripts
751 Run perl standard test scripts with statistics
755 Create an abbreviation table from a list
759 Extract delimited text sequences from strings.
761 =item Text::ParseWords
763 Parse text into an array of tokens or array of arrays
767 Implementation of the Soundex Algorithm as Described by Knuth
771 Expand and unexpand tabs per the unix expand(1) and unexpand(1)
775 Line wrapping to form simple paragraphs
779 Base class for tied arrays
783 Base class definitions for tied handles
787 Base class definitions for tied hashes
791 Use references as hash keys
795 Base class definitions for tied scalars
797 =item Tie::SubstrHash
799 Fixed-table-size, fixed-key-length hashing
803 Efficiently compute time from local and GMT time
807 By-name interface to Perl's built-in gmtime() function
809 =item Time::localtime
811 By-name interface to Perl's built-in localtime() function
815 Internal object used by Time::gmtime and Time::localtime
819 Base class for ALL classes (blessed references)
823 By-name interface to Perl's built-in getgr*() functions
827 By-name interface to Perl's built-in getpw*() functions
831 Interfaces to some Win32 API Functions
835 To find out I<all> modules installed on your system, including
836 those without documentation or outside the standard release,
839 % find `perl -e 'print "@INC"'` -name '*.pm' -print
841 They should all have their own documentation installed and accessible
842 via your system man(1) command. If you do not have a B<find>
843 program, you can use the Perl B<find2perl> program instead, which
844 generates Perl code as output you can run through perl. If you
845 have a B<man> program but it doesn't find your modules, you'll have
846 to fix your manpath. See L<perl> for details. If you have no
847 system B<man> command, you might try the B<perldoc> program.
849 =head2 Extension Modules
851 Extension modules are written in C (or a mix of Perl and C). They
852 are usually dynamically loaded into Perl if and when you need them,
853 but may also be be linked in statically. Supported extension modules
854 include Socket, Fcntl, and POSIX.
856 Many popular C extension modules do not come bundled (at least, not
857 completely) due to their sizes, volatility, or simply lack of time
858 for adequate testing and configuration across the multitude of
859 platforms on which Perl was beta-tested. You are encouraged to
860 look for them on CPAN (described below), or using web search engines
861 like Alta Vista or Deja News.
865 CPAN stands for Comprehensive Perl Archive Network; it's a globally
866 replicated trove of Perl materials, including documentation, style
867 guides, tricks and traps, alternate ports to non-Unix systems and
868 occasional binary distributions for these. Search engines for
869 CPAN can be found at http://cpan.perl.com/ and at
870 http://theory.uwinnipeg.ca/mod_perl/cpan-search.pl .
872 Most importantly, CPAN includes around a thousand unbundled modules,
873 some of which require a C compiler to build. Major categories of
880 Language Extensions and Documentation Tools
888 Operating System Interfaces
892 Networking, Device Control (modems) and InterProcess Communication
896 Data Types and Data Type Utilities
908 Interfaces to / Emulations of Other Programming Languages
912 File Names, File Systems and File Locking (see also File Handles)
916 String Processing, Language Text Processing, Parsing, and Searching
920 Option, Argument, Parameter, and Configuration File Processing
924 Internationalization and Locale
928 Authentication, Security, and Encryption
932 World Wide Web, HTML, HTTP, CGI, MIME
936 Server and Daemon Utilities
940 Archiving and Compression
944 Images, Pixmap and Bitmap Manipulation, Drawing, and Graphing
952 Control Flow Utilities (callbacks and exceptions etc)
956 File Handle and Input/Output Stream Utilities
960 Miscellaneous Modules
964 Registered CPAN sites as of this writing include the following.
965 You should try to choose one close to you:
975 ftp://ftp.is.co.za/programming/perl/CPAN/
976 ftp://ftp.saix.net/pub/CPAN/
977 ftp://ftpza.co.za/pub/mirrors/cpan/
978 ftp://ftp.sun.ac.za/CPAN/
990 ftp://freesoft.cei.gov.cn/pub/languages/perl/CPAN/
991 http://www2.linuxforum.net/mirror/CPAN/
992 http://cpan.shellhung.org/
993 ftp://ftp.shellhung.org/pub/CPAN
999 http://CPAN.pacific.net.hk/
1000 ftp://ftp.pacific.net.hk/pub/mirror/CPAN/
1006 http://piksi.itb.ac.id/CPAN/
1007 ftp://mirrors.piksi.itb.ac.id/CPAN/
1008 http://CPAN.mweb.co.id/
1009 ftp://ftp.mweb.co.id/pub/languages/perl/CPAN/
1015 http://www.iglu.org.il:/pub/CPAN/
1016 ftp://ftp.iglu.org.il/pub/CPAN/
1017 http://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
1018 ftp://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
1024 ftp://ftp.u-aizu.ac.jp/pub/lang/perl/CPAN/
1025 ftp://ftp.kddlabs.co.jp/CPAN/
1026 http://mirror.nucba.ac.jp/mirror/Perl/
1027 ftp://mirror.nucba.ac.jp/mirror/Perl/
1028 ftp://ftp.meisei-u.ac.jp/pub/CPAN/
1029 ftp://ftp.jaist.ac.jp/pub/lang/perl/CPAN/
1030 ftp://ftp.dti.ad.jp/pub/lang/CPAN/
1031 ftp://ftp.ring.gr.jp/pub/lang/perl/CPAN/
1037 ftp://ftp.isu.net.sa/pub/CPAN/
1043 http://cpan.hjc.edu.sg
1044 http://ftp.nus.edu.sg/unix/perl/CPAN/
1045 ftp://ftp.nus.edu.sg/pub/unix/perl/CPAN/
1051 http://CPAN.bora.net/
1052 ftp://ftp.bora.net/pub/CPAN/
1053 http://ftp.kornet.net/CPAN/
1054 ftp://ftp.kornet.net/pub/CPAN/
1055 ftp://ftp.nuri.net/pub/CPAN/
1061 ftp://coda.nctu.edu.tw/UNIX/perl/CPAN
1062 ftp://ftp.ee.ncku.edu.tw/pub/perl/CPAN/
1063 ftp://ftp1.sinica.edu.tw/pub1/perl/CPAN/
1069 http://download.nectec.or.th/CPAN/
1070 ftp://ftp.nectec.or.th/pub/languages/CPAN/
1071 ftp://ftp.cs.riubon.ac.th/pub/mirrors/CPAN/
1075 =head2 Central America
1083 ftp://ftp.linux.co.cr/mirrors/CPAN/
1084 http://ftp.ucr.ac.cr/Unix/CPAN/
1085 ftp://ftp.ucr.ac.cr/pub/Unix/CPAN/
1097 ftp://ftp.tuwien.ac.at/pub/languages/perl/CPAN/
1103 http://ftp.easynet.be/CPAN/
1104 ftp://ftp.easynet.be/CPAN/
1105 ftp://ftp.kulnet.kuleuven.ac.be/pub/mirror/CPAN/
1111 ftp://ftp.ntrl.net/pub/mirrors/CPAN/
1117 ftp://ftp.linux.hr/pub/CPAN/
1123 http://www.fi.muni.cz/pub/perl/
1124 ftp://ftp.fi.muni.cz/pub/perl/
1125 ftp://sunsite.mff.cuni.cz/MIRRORS/ftp.funet.fi/pub/languages/perl/CPAN/
1131 ftp://sunsite.auc.dk/pub/languages/perl/CPAN/
1132 http://www.cpan.dk/CPAN/
1133 ftp://www.cpan.dk/ftp.cpan.org/CPAN/
1139 http://www.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN
1140 ftp://ftp.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN/
1141 ftp://ftp.demon.co.uk/pub/mirrors/perl/CPAN/
1142 ftp://ftp.flirble.org/pub/languages/perl/CPAN/
1143 ftp://ftp.plig.org/pub/CPAN/
1144 ftp://sunsite.doc.ic.ac.uk/packages/CPAN/
1145 http://mirror.uklinux.net/CPAN/
1146 ftp://mirror.uklinux.net/pub/CPAN/
1147 ftp://usit.shef.ac.uk/pub/packages/CPAN/
1153 ftp://ftp.ut.ee/pub/languages/perl/CPAN/
1159 ftp://ftp.funet.fi/pub/languages/perl/CPAN/
1165 ftp://cpan.ftp.worldonline.fr/pub/CPAN/
1166 ftp://ftp.club-internet.fr/pub/perl/CPAN/
1167 ftp://ftp.lip6.fr/pub/perl/CPAN/
1168 ftp://ftp.oleane.net/pub/mirrors/CPAN/
1169 ftp://ftp.pasteur.fr/pub/computing/CPAN/
1170 ftp://cpan.cict.fr/pub/CPAN/
1171 ftp://ftp.uvsq.fr/pub/perl/CPAN/
1177 ftp://ftp.rz.ruhr-uni-bochum.de/pub/CPAN/
1178 ftp://ftp.freenet.de/pub/ftp.cpan.org/pub/CPAN/
1179 ftp://ftp.uni-erlangen.de/pub/source/CPAN/
1180 ftp://ftp-stud.fht-esslingen.de/pub/Mirrors/CPAN
1181 ftp://ftp.gigabell.net/pub/CPAN/
1182 http://ftp.gwdg.de/pub/languages/perl/CPAN/
1183 ftp://ftp.gwdg.de/pub/languages/perl/CPAN/
1184 ftp://ftp.uni-hamburg.de/pub/soft/lang/perl/CPAN/
1185 ftp://ftp.leo.org/pub/comp/general/programming/languages/script/perl/CPAN/
1186 ftp://ftp.mpi-sb.mpg.de/pub/perl/CPAN/
1187 ftp://ftp.gmd.de/mirrors/CPAN/
1193 ftp://ftp.forthnet.gr/pub/languages/perl/CPAN
1194 ftp://ftp.ntua.gr/pub/lang/perl/
1200 http://cpan.artifact.hu/
1201 ftp://cpan.artifact.hu/CPAN/
1202 ftp://ftp.kfki.hu/pub/packages/perl/CPAN/
1209 ftp://ftp.gm.is/pub/CPAN/
1215 http://cpan.indigo.ie/
1216 ftp://cpan.indigo.ie/pub/CPAN/
1217 http://sunsite.compapp.dcu.ie/pub/perl/
1218 ftp://sunsite.compapp.dcu.ie/pub/perl/
1224 http://cpan.nettuno.it/
1225 http://gusp.dyndns.org/CPAN/
1226 ftp://gusp.dyndns.org/pub/CPAN
1227 http://softcity.iol.it/cpan
1228 ftp://softcity.iol.it/pub/cpan
1229 ftp://ftp.unina.it/pub/Other/CPAN/
1230 ftp://ftp.unipi.it/pub/mirror/perl/CPAN/
1231 ftp://cis.uniRoma2.it/CPAN/
1232 ftp://ftp.edisontel.it/pub/CPAN_Mirror/
1233 ftp://ftp.flashnet.it/pub/CPAN/
1239 http://kvin.lv/pub/CPAN/
1245 ftp://download.xs4all.nl/pub/mirror/CPAN/
1246 ftp://ftp.nl.uu.net/pub/CPAN/
1247 ftp://ftp.nluug.nl/pub/languages/perl/CPAN/
1248 ftp://ftp.cpan.nl/pub/CPAN/
1249 http://www.cs.uu.nl/mirror/CPAN/
1250 ftp://ftp.cs.uu.nl/mirror/CPAN/
1256 ftp://sunsite.uio.no/pub/languages/perl/CPAN/
1257 ftp://ftp.uit.no/pub/languages/perl/cpan/
1263 ftp://ftp.pk.edu.pl/pub/lang/perl/CPAN/
1264 ftp://ftp.mega.net.pl/pub/mirrors/ftp.perl.com/
1265 ftp://ftp.man.torun.pl/pub/doc/CPAN/
1266 ftp://sunsite.icm.edu.pl/pub/CPAN/
1272 ftp://ftp.ua.pt/pub/CPAN/
1273 ftp://perl.di.uminho.pt/pub/CPAN/
1274 ftp://ftp.ist.utl.pt/pub/CPAN/
1275 ftp://ftp.netc.pt/pub/CPAN/
1281 ftp://archive.logicnet.ro/mirrors/ftp.cpan.org/CPAN/
1282 ftp://ftp.kappa.ro/pub/mirrors/ftp.perl.org/pub/CPAN/
1283 ftp://ftp.dntis.ro/pub/cpan/
1284 ftp://ftp.opsynet.com/cpan/
1285 ftp://ftp.dnttm.ro/pub/CPAN/
1286 ftp://ftp.timisoara.roedu.net/mirrors/CPAN/
1292 ftp://ftp.chg.ru/pub/lang/perl/CPAN/
1293 http://cpan.rinet.ru/
1294 ftp://cpan.rinet.ru/pub/mirror/CPAN/
1295 ftp://ftp.aha.ru/pub/CPAN/
1296 ftp://ftp.sai.msu.su/pub/lang/perl/CPAN/
1302 ftp://ftp.entry.sk/pub/languages/perl/CPAN/
1308 ftp://ftp.arnes.si/software/perl/CPAN/
1314 ftp://ftp.rediris.es/mirror/CPAN/
1315 ftp://ftp.etse.urv.es/pub/perl/
1321 http://ftp.du.se/CPAN/
1322 ftp://ftp.du.se/pub/CPAN/
1323 ftp://ftp.sunet.se/pub/lang/perl/CPAN/
1329 ftp://ftp.danyk.ch/CPAN/
1330 ftp://sunsite.cnlab-switch.ch/mirror/CPAN/
1336 ftp://sunsite.bilkent.edu.tr/pub/languages/CPAN/
1340 =head2 North America
1354 http://sunsite.ualberta.ca/pub/Mirror/CPAN/
1355 ftp://sunsite.ualberta.ca/pub/Mirror/CPAN/
1361 http://theoryx5.uwinnipeg.ca/pub/CPAN/
1362 ftp://theoryx5.uwinnipeg.ca/pub/CPAN/
1368 ftp://cpan.chebucto.ns.ca/pub/CPAN/
1374 ftp://ftp.crc.ca/pub/packages/lang/perl/CPAN/
1380 http://www.msg.com.mx/CPAN/
1381 ftp://ftp.msg.com.mx/pub/CPAN/
1395 http://mirror.hiwaay.net/CPAN/
1396 ftp://mirror.hiwaay.net/CPAN/
1402 http://www.cpan.org/
1403 ftp://ftp.cpan.org/CPAN/
1404 ftp://cpan.nas.nasa.gov/pub/perl/CPAN/
1405 ftp://ftp.digital.com/pub/plan/perl/CPAN/
1406 http://www.kernel.org/pub/mirrors/cpan/
1407 ftp://ftp.kernel.org/pub/mirrors/cpan/
1408 http://www.perl.com/CPAN/
1409 http://download.sourceforge.net/mirrors/CPAN/
1415 ftp://ftp.cs.colorado.edu/pub/perl/CPAN/
1421 ftp://ftp.cise.ufl.edu/pub/perl/CPAN/
1427 ftp://ftp.twoguys.org/CPAN/
1433 http://www.neurogames.com/mirrors/CPAN
1434 http://uiarchive.uiuc.edu/mirrors/ftp/ftp.cpan.org/pub/CPAN/
1435 ftp://uiarchive.uiuc.edu/mirrors/ftp/ftp.cpan.org/pub/CPAN/
1441 ftp://ftp.uwsg.indiana.edu/pub/perl/CPAN/
1442 http://cpan.nitco.com/
1443 ftp://cpan.nitco.com/pub/CPAN/
1444 ftp://cpan.in-span.net/
1445 http://csociety-ftp.ecn.purdue.edu/pub/CPAN
1446 ftp://csociety-ftp.ecn.purdue.edu/pub/CPAN
1452 http://cpan.uky.edu/
1453 ftp://cpan.uky.edu/pub/CPAN/
1459 ftp://ftp.ccs.neu.edu/net/mirrors/ftp.funet.fi/pub/languages/perl/CPAN/
1460 ftp://ftp.iguide.com/pub/mirrors/packages/perl/CPAN/
1466 ftp://ftp.cpanel.net/pub/CPAN/
1472 ftp://ftp.freesoftware.com/pub/perl/CPAN/
1473 http://www.deao.net/mirrors/CPAN/
1474 ftp://ftp.deao.net/pub/CPAN/
1475 ftp://ftp.stealth.net/pub/mirrors/ftp.cpan.org/pub/CPAN/
1476 http://mirror.nyc.anidea.com/CPAN/
1477 ftp://mirror.nyc.anidea.com/pub/CPAN/
1478 http://www.rge.com/pub/languages/perl/
1479 ftp://ftp.rge.com/pub/languages/perl/
1480 ftp://mirrors.cloud9.net/pub/mirrors/CPAN/
1486 ftp://ftp.duke.edu/pub/perl/
1492 ftp://ftp.loaded.net/pub/CPAN/
1498 ftp://ftp.ou.edu/mirrors/CPAN/
1504 ftp://ftp.orst.edu/pub/packages/CPAN/
1510 http://ftp.epix.net/CPAN/
1511 ftp://ftp.epix.net/pub/languages/perl/
1512 ftp://carroll.cac.psu.edu/pub/CPAN/
1518 ftp://ftp.sunsite.utk.edu/pub/CPAN/
1524 http://ftp.sedl.org/pub/mirrors/CPAN/
1525 http://jhcloos.com/pub/mirror/CPAN/
1526 ftp://jhcloos.com/pub/mirror/CPAN/
1532 ftp://mirror.xmission.com/CPAN/
1538 http://mirrors.rcn.net/pub/lang/CPAN/
1539 ftp://mirrors.rcn.net/pub/lang/CPAN/
1540 ftp://ruff.cs.jmu.edu/pub/CPAN/
1541 http://perl.Liquidation.com/CPAN/
1547 http://cpan.llarian.net/
1548 ftp://cpan.llarian.net/pub/CPAN/
1549 ftp://ftp-mirror.internap.com/pub/CPAN/
1550 ftp://ftp.spu.edu/pub/CPAN/
1564 http://ftp.planetmirror.com/pub/CPAN/
1565 ftp://ftp.planetmirror.com/pub/CPAN/
1566 ftp://mirror.aarnet.edu.au/pub/perl/CPAN/
1567 ftp://cpan.topend.com.au/pub/CPAN/
1573 ftp://ftp.auckland.ac.nz/pub/perl/CPAN/
1577 =head2 South America
1585 ftp://mirrors.bannerlandia.com.ar/mirrors/CPAN/
1591 ftp://cpan.pop-mg.com.br/pub/CPAN/
1592 ftp://ftp.matrix.com.br/pub/perl/
1593 ftp://cpan.if.usp.br/pub/mirror/CPAN/
1599 ftp://ftp.psinet.cl/pub/programming/perl/CPAN/
1600 ftp://sunsite.dcc.uchile.cl/pub/lang/perl/
1604 For an up-to-date listing of CPAN sites,
1605 see http://www.cpan.org/SITES or ftp://www.cpan.org/SITES .
1607 =head1 Modules: Creation, Use, and Abuse
1609 (The following section is borrowed directly from Tim Bunce's modules
1610 file, available at your nearest CPAN site.)
1612 Perl implements a class using a package, but the presence of a
1613 package doesn't imply the presence of a class. A package is just a
1614 namespace. A class is a package that provides subroutines that can be
1615 used as methods. A method is just a subroutine that expects, as its
1616 first argument, either the name of a package (for "static" methods),
1617 or a reference to something (for "virtual" methods).
1619 A module is a file that (by convention) provides a class of the same
1620 name (sans the .pm), plus an import method in that class that can be
1621 called to fetch exported symbols. This module may implement some of
1622 its methods by loading dynamic C or C++ objects, but that should be
1623 totally transparent to the user of the module. Likewise, the module
1624 might set up an AUTOLOAD function to slurp in subroutine definitions on
1625 demand, but this is also transparent. Only the F<.pm> file is required to
1626 exist. See L<perlsub>, L<perltoot>, and L<AutoLoader> for details about
1627 the AUTOLOAD mechanism.
1629 =head2 Guidelines for Module Creation
1635 Do similar modules already exist in some form?
1637 If so, please try to reuse the existing modules either in whole or
1638 by inheriting useful features into a new class. If this is not
1639 practical try to get together with the module authors to work on
1640 extending or enhancing the functionality of the existing modules.
1641 A perfect example is the plethora of packages in perl4 for dealing
1642 with command line options.
1644 If you are writing a module to expand an already existing set of
1645 modules, please coordinate with the author of the package. It
1646 helps if you follow the same naming scheme and module interaction
1647 scheme as the original author.
1651 Try to design the new module to be easy to extend and reuse.
1653 Try to C<use warnings;> (or C<use warnings qw(...);>).
1654 Remember that you can add C<no warnings qw(...);> to individual blocks
1655 of code that need less warnings.
1657 Use blessed references. Use the two argument form of bless to bless
1658 into the class name given as the first parameter of the constructor,
1663 return bless {}, $class;
1666 or even this if you'd like it to be used as either a static
1667 or a virtual method.
1671 my $class = ref($self) || $self;
1672 return bless {}, $class;
1675 Pass arrays as references so more parameters can be added later
1676 (it's also faster). Convert functions into methods where
1677 appropriate. Split large methods into smaller more flexible ones.
1678 Inherit methods from other modules if appropriate.
1680 Avoid class name tests like: C<die "Invalid" unless ref $ref eq 'FOO'>.
1681 Generally you can delete the C<eq 'FOO'> part with no harm at all.
1682 Let the objects look after themselves! Generally, avoid hard-wired
1683 class names as far as possible.
1685 Avoid C<< $r->Class::func() >> where using C<@ISA=qw(... Class ...)> and
1686 C<< $r->func() >> would work (see L<perlbot> for more details).
1688 Use autosplit so little used or newly added functions won't be a
1689 burden to programs that don't use them. Add test functions to
1690 the module after __END__ either using AutoSplit or by saying:
1692 eval join('',<main::DATA>) || die $@ unless caller();
1694 Does your module pass the 'empty subclass' test? If you say
1695 C<@SUBCLASS::ISA = qw(YOURCLASS);> your applications should be able
1696 to use SUBCLASS in exactly the same way as YOURCLASS. For example,
1697 does your application still work if you change: C<$obj = new YOURCLASS;>
1698 into: C<$obj = new SUBCLASS;> ?
1700 Avoid keeping any state information in your packages. It makes it
1701 difficult for multiple other packages to use yours. Keep state
1702 information in objects.
1706 Try to C<use strict;> (or C<use strict qw(...);>).
1707 Remember that you can add C<no strict qw(...);> to individual blocks
1708 of code that need less strictness.
1712 Follow the guidelines in the perlstyle(1) manual.
1718 Some simple style guidelines
1720 The perlstyle manual supplied with Perl has many helpful points.
1722 Coding style is a matter of personal taste. Many people evolve their
1723 style over several years as they learn what helps them write and
1724 maintain good code. Here's one set of assorted suggestions that
1725 seem to be widely used by experienced developers:
1727 Use underscores to separate words. It is generally easier to read
1728 $var_names_like_this than $VarNamesLikeThis, especially for
1729 non-native speakers of English. It's also a simple rule that works
1730 consistently with VAR_NAMES_LIKE_THIS.
1732 Package/Module names are an exception to this rule. Perl informally
1733 reserves lowercase module names for 'pragma' modules like integer
1734 and strict. Other modules normally begin with a capital letter and
1735 use mixed case with no underscores (need to be short and portable).
1737 You may find it helpful to use letter case to indicate the scope
1738 or nature of a variable. For example:
1740 $ALL_CAPS_HERE constants only (beware clashes with Perl vars)
1741 $Some_Caps_Here package-wide global/static
1742 $no_caps_here function scope my() or local() variables
1744 Function and method names seem to work best as all lowercase.
1745 e.g., C<< $obj->as_string() >>.
1747 You can use a leading underscore to indicate that a variable or
1748 function should not be used outside the package that defined it.
1752 Select what to export.
1754 Do NOT export method names!
1756 Do NOT export anything else by default without a good reason!
1758 Exports pollute the namespace of the module user. If you must
1759 export try to use @EXPORT_OK in preference to @EXPORT and avoid
1760 short or common names to reduce the risk of name clashes.
1762 Generally anything not exported is still accessible from outside the
1763 module using the ModuleName::item_name (or C<< $blessed_ref->method >>)
1764 syntax. By convention you can use a leading underscore on names to
1765 indicate informally that they are 'internal' and not for public use.
1767 (It is actually possible to get private functions by saying:
1768 C<my $subref = sub { ... }; &$subref;>. But there's no way to call that
1769 directly as a method, because a method must have a name in the symbol
1772 As a general rule, if the module is trying to be object oriented
1773 then export nothing. If it's just a collection of functions then
1774 @EXPORT_OK anything but use @EXPORT with caution.
1778 Select a name for the module.
1780 This name should be as descriptive, accurate, and complete as
1781 possible. Avoid any risk of ambiguity. Always try to use two or
1782 more whole words. Generally the name should reflect what is special
1783 about what the module does rather than how it does it. Please use
1784 nested module names to group informally or categorize a module.
1785 There should be a very good reason for a module not to have a nested name.
1786 Module names should begin with a capital letter.
1788 Having 57 modules all called Sort will not make life easy for anyone
1789 (though having 23 called Sort::Quick is only marginally better :-).
1790 Imagine someone trying to install your module alongside many others.
1791 If in any doubt ask for suggestions in comp.lang.perl.misc.
1793 If you are developing a suite of related modules/classes it's good
1794 practice to use nested classes with a common prefix as this will
1795 avoid namespace clashes. For example: Xyz::Control, Xyz::View,
1796 Xyz::Model etc. Use the modules in this list as a naming guide.
1798 If adding a new module to a set, follow the original author's
1799 standards for naming modules and the interface to methods in
1802 If developing modules for private internal or project specific use,
1803 that will never be released to the public, then you should ensure
1804 that their names will not clash with any future public module. You
1805 can do this either by using the reserved Local::* category or by
1806 using a category name that includes an underscore like Foo_Corp::*.
1808 To be portable each component of a module name should be limited to
1809 11 characters. If it might be used on MS-DOS then try to ensure each is
1810 unique in the first 8 characters. Nested modules make this easier.
1814 Have you got it right?
1816 How do you know that you've made the right decisions? Have you
1817 picked an interface design that will cause problems later? Have
1818 you picked the most appropriate name? Do you have any questions?
1820 The best way to know for sure, and pick up many helpful suggestions,
1821 is to ask someone who knows. Comp.lang.perl.misc is read by just about
1822 all the people who develop modules and it's the best place to ask.
1824 All you need to do is post a short summary of the module, its
1825 purpose and interfaces. A few lines on each of the main methods is
1826 probably enough. (If you post the whole module it might be ignored
1827 by busy people - generally the very people you want to read it!)
1829 Don't worry about posting if you can't say when the module will be
1830 ready - just say so in the message. It might be worth inviting
1831 others to help you, they may be able to complete it for you!
1835 README and other Additional Files.
1837 It's well known that software developers usually fully document the
1838 software they write. If, however, the world is in urgent need of
1839 your software and there is not enough time to write the full
1840 documentation please at least provide a README file containing:
1846 A description of the module/package/extension etc.
1850 A copyright notice - see below.
1854 Prerequisites - what else you may need to have.
1858 How to build it - possible changes to Makefile.PL etc.
1866 Recent changes in this release, especially incompatibilities
1870 Changes / enhancements you plan to make in the future.
1874 If the README file seems to be getting too large you may wish to
1875 split out some of the sections into separate files: INSTALL,
1880 =item Adding a Copyright Notice.
1883 How you choose to license your work is a personal decision.
1884 The general mechanism is to assert your Copyright and then make
1885 a declaration of how others may copy/use/modify your work.
1887 Perl, for example, is supplied with two types of licence: The GNU
1888 GPL and The Artistic Licence (see the files README, Copying, and
1889 Artistic). Larry has good reasons for NOT just using the GNU GPL.
1891 My personal recommendation, out of respect for Larry, Perl, and the
1892 Perl community at large is to state something simply like:
1894 Copyright (c) 1995 Your Name. All rights reserved.
1895 This program is free software; you can redistribute it and/or
1896 modify it under the same terms as Perl itself.
1898 This statement should at least appear in the README file. You may
1899 also wish to include it in a Copying file and your source files.
1900 Remember to include the other words in addition to the Copyright.
1904 Give the module a version/issue/release number.
1906 To be fully compatible with the Exporter and MakeMaker modules you
1907 should store your module's version number in a non-my package
1908 variable called $VERSION. This should be a floating point
1909 number with at least two digits after the decimal (i.e., hundredths,
1910 e.g, C<$VERSION = "0.01">). Don't use a "1.3.2" style version.
1911 See L<Exporter> for details.
1913 It may be handy to add a function or method to retrieve the number.
1914 Use the number in announcements and archive file names when
1915 releasing the module (ModuleName-1.02.tar.Z).
1916 See perldoc ExtUtils::MakeMaker.pm for details.
1920 How to release and distribute a module.
1922 It's good idea to post an announcement of the availability of your
1923 module (or the module itself if small) to the comp.lang.perl.announce
1924 Usenet newsgroup. This will at least ensure very wide once-off
1927 If possible, register the module with CPAN. You should
1928 include details of its location in your announcement.
1930 Some notes about ftp archives: Please use a long descriptive file
1931 name that includes the version number. Most incoming directories
1932 will not be readable/listable, i.e., you won't be able to see your
1933 file after uploading it. Remember to send your email notification
1934 message as soon as possible after uploading else your file may get
1935 deleted automatically. Allow time for the file to be processed
1936 and/or check the file has been processed before announcing its
1939 FTP Archives for Perl Modules:
1941 Follow the instructions and links on:
1943 http://www.cpan.org/modules/00modlist.long.html
1944 http://www.cpan.org/modules/04pause.html
1946 or upload to one of these sites:
1948 https://pause.kbx.de/pause/
1949 http://pause.perl.org/pause/
1951 and notify <modules@perl.org>.
1953 By using the WWW interface you can ask the Upload Server to mirror
1954 your modules from your ftp or WWW site into your own directory on
1957 Please remember to send me an updated entry for the Module list!
1961 Take care when changing a released module.
1963 Always strive to remain compatible with previous released versions.
1964 Otherwise try to add a mechanism to revert to the
1965 old behavior if people rely on it. Document incompatible changes.
1971 =head2 Guidelines for Converting Perl 4 Library Scripts into Modules
1977 There is no requirement to convert anything.
1979 If it ain't broke, don't fix it! Perl 4 library scripts should
1980 continue to work with no problems. You may need to make some minor
1981 changes (like escaping non-array @'s in double quoted strings) but
1982 there is no need to convert a .pl file into a Module for just that.
1986 Consider the implications.
1988 All Perl applications that make use of the script will need to
1989 be changed (slightly) if the script is converted into a module. Is
1990 it worth it unless you plan to make other changes at the same time?
1994 Make the most of the opportunity.
1996 If you are going to convert the script to a module you can use the
1997 opportunity to redesign the interface. The guidelines for module
1998 creation above include many of the issues you should consider.
2002 The pl2pm utility will get you started.
2004 This utility will read *.pl files (given as parameters) and write
2005 corresponding *.pm files. The pl2pm utilities does the following:
2011 Adds the standard Module prologue lines
2015 Converts package specifiers from ' to ::
2019 Converts die(...) to croak(...)
2023 Several other minor changes
2027 Being a mechanical process pl2pm is not bullet proof. The converted
2028 code will need careful checking, especially any package statements.
2029 Don't delete the original .pl file till the new .pm one works!
2033 =head2 Guidelines for Reusing Application Code
2039 Complete applications rarely belong in the Perl Module Library.
2043 Many applications contain some Perl code that could be reused.
2045 Help save the world! Share your code in a form that makes it easy
2050 Break-out the reusable code into one or more separate module files.
2054 Take the opportunity to reconsider and redesign the interfaces.
2058 In some cases the 'application' can then be reduced to a small
2060 fragment of code built on top of the reusable modules. In these cases
2061 the application could invoked as:
2063 % perl -e 'use Module::Name; method(@ARGV)' ...
2065 % perl -mModule::Name ... (in perl5.002 or higher)
2071 Perl does not enforce private and public parts of its modules as you may
2072 have been used to in other languages like C++, Ada, or Modula-17. Perl
2073 doesn't have an infatuation with enforced privacy. It would prefer
2074 that you stayed out of its living room because you weren't invited, not
2075 because it has a shotgun.
2077 The module and its user have a contract, part of which is common law,
2078 and part of which is "written". Part of the common law contract is
2079 that a module doesn't pollute any namespace it wasn't asked to. The
2080 written contract for the module (A.K.A. documentation) may make other
2081 provisions. But then you know when you C<use RedefineTheWorld> that
2082 you're redefining the world and willing to take the consequences.