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 (or UTF-EBCDIC) 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
169 =item Attribute::Handlers
171 Simpler definition of attribute handlers
175 Load subroutines only on demand
179 Split a package for autoloading
187 Autogenerated data about Perl ops, used to generate bytecode
191 Assemble Perl bytecode
199 Perl compiler's bytecode backend
203 Perl compiler's C backend
207 Perl compiler's optimized C translation backend
211 Walk Perl syntax tree, printing concise info about ops
215 Walk Perl syntax tree, printing debug info about ops
219 Perl compiler backend to produce perl code
221 =item B::Disassembler
223 Disassemble Perl bytecode
231 Show lexical variables used in functions or files
235 Helper module for CC backend
239 Show what stashes are loaded
243 Walk Perl syntax tree, printing terse info about ops
247 Generates cross reference reports for Perl programs
251 Benchmark running times of Perl code
255 Load byte compiled perl code
259 Simple Common Gateway Interface Class
263 Backward compatibility module for CGI.pm
267 CGI routines for writing to the HTTPD (or other) error log
271 Interface to Netscape Cookies
275 CGI Interface for Fast CGI
279 Module to produce nicely formatted HTML code
283 Simple Interface to Server Push
287 Backward compatibility module for defunct CGI::Switch
291 Internal utilities used by CGI module
295 Query, download and build perl modules from CPAN sites
297 =item CPAN::FirstTime
299 Utility for CPAN::Config file Initialization
303 Wrapper around CPAN.pm without using any XS module
307 Warn of errors (from perspective of caller)
311 No user serviceable parts inside
315 Report the search path for a class's ISA tree
319 Declare struct-like datatypes as Perl classes
323 Get pathname of current working directory
327 Programmatic interface to the Perl debugging API (draft, subject to
331 Perl5 access to Berkeley DB version 1.x
333 =item Devel::SelfStubber
335 Generate stubs for a SelfLoading module
339 Modules that calculate message digests
343 Supply object methods for directory handles
347 Provides screen dump of Perl data.
353 =item Encode::EncodeFormat
355 The format of encoding tables of the Encode extension
363 Use nice English (or awk) names for ugly punctuation variables
367 Perl module that imports environment variables as scalars or arrays
371 Implements default import method for modules
373 =item Exporter::Heavy
377 =item ExtUtils::Command
379 Utilities to replace common UNIX commands in Makefiles etc.
381 =item ExtUtils::Constant
383 Generate XS code to import C header constants
385 =item ExtUtils::Embed
387 Utilities for embedding Perl in C/C++ applications
389 =item ExtUtils::Install
391 Install files from here to there
393 =item ExtUtils::Installed
395 Inventory management of installed modules
397 =item ExtUtils::Liblist
399 Determine libraries to use and how to use them
401 =item ExtUtils::MM_Cygwin
403 Methods to override UN*X behaviour in ExtUtils::MakeMaker
405 =item ExtUtils::MM_OS2
407 Methods to override UN*X behaviour in ExtUtils::MakeMaker
409 =item ExtUtils::MM_Unix
411 Methods used by ExtUtils::MakeMaker
413 =item ExtUtils::MM_VMS
415 Methods to override UN*X behaviour in ExtUtils::MakeMaker
417 =item ExtUtils::MM_Win32
419 Methods to override UN*X behaviour in ExtUtils::MakeMaker
421 =item ExtUtils::MakeMaker
423 Create an extension Makefile
425 =item ExtUtils::Manifest
427 Utilities to write and check a MANIFEST file
429 =item ExtUtils::Mkbootstrap
431 Make a bootstrap file for use by DynaLoader
433 =item ExtUtils::Mksymlists
435 Write linker options files for dynamic extension
437 =item ExtUtils::Packlist
439 Manage .packlist files
441 =item ExtUtils::testlib
443 Add blib/* directories to @INC
447 Replace functions with equivalents which succeed or die
451 Load the C Fcntl.h defines
455 Split a pathname into pieces
457 =item File::CheckTree
459 Run many filetest checks on a tree
463 Compare files or filehandles
467 Copy files or filehandles
471 DOS like globbing and then some
479 Create or remove directory trees
483 Portably perform operations on file names
485 =item File::Spec::Epoc
487 Methods for Epoc file specs
489 =item File::Spec::Functions
491 Portably perform operations on file names
493 =item File::Spec::Mac
497 =item File::Spec::OS2
499 Methods for OS/2 file specs
501 =item File::Spec::Unix
503 Methods used by File::Spec
505 =item File::Spec::VMS
507 Methods for VMS file specs
509 =item File::Spec::Win32
511 Methods for Win32 file specs
515 Return name and handle of a temporary file safely
519 By-name interface to Perl's built-in stat() functions
523 Keep more files open than the system permits
527 Supply object methods for filehandles
531 Simplified source filtering
535 Locate directory of original perl script
539 Extended processing of command line options
543 Process single-character switches with switch clustering
547 Compare 8-bit scalar data according to the current locale
551 Functions for dealing with RFC3066-style language tags
553 =item I18N::LangTags::List
555 List of tags for human languages
559 Load various IO modules
563 Open a process for both reading and writing
567 Open a process for reading, writing, and error handling
569 =item Locale::Constants
571 Constants for Locale codes
573 =item Locale::Country
575 ISO codes for country identification (ISO 3166)
577 =item Locale::Currency
579 ISO three letter codes for currency identification (ISO 4217)
581 =item Locale::Language
583 ISO two letter codes for language identification (ISO 639)
585 =item Locale::Maketext
587 Framework for localization
589 =item Locale::Maketext::TPJ13
591 Article about software localization
595 Arbitrary length float math package
599 Arbitrary size integer math package
603 Complex numbers and associated mathematical functions
607 Trigonometric functions
611 Tied access to ndbm files
615 Provide a pseudo-class NEXT that allows method redispatch
619 Check a remote host for reachability
623 By-name interface to Perl's built-in gethost*() functions
627 By-name interface to Perl's built-in getnet*() functions
631 By-name interface to Perl's built-in getproto*() functions
635 By-name interface to Perl's built-in getserv*() functions
639 Generic interface to Perl Compiler backends
643 Tied access to odbm files
647 Disable named opcodes when compiling perl code
651 Perl interface to IEEE Std 1003.1
655 On demand loader for PerlIO layers and root of PerlIO::* name space
659 Check pod documents for syntax errors
663 Find POD documents in directory trees
667 Module to convert pod files to HTML
669 =item Pod::InputObjects
671 Objects representing POD input paragraphs, commands, etc.
675 Convert Pod data to formatted Latex
679 Convert POD data to formatted *roff input
681 =item Pod::ParseUtils
683 Helpers for POD parsing and conversion
687 Base class for creating POD filters and translators
691 Perl extension for converting Pod to old style Pod.
695 Extract selected sections of POD from input
699 Convert POD data to formatted ASCII text
701 =item Pod::Text::Color
703 Convert POD data to formatted color ASCII text
705 =item Pod::Text::Overstrike
707 Convert POD data to formatted overstrike text
709 =item Pod::Text::Termcap
711 Convert POD data to ASCII text with format escapes
715 Print a usage message from embedded pod documentation
719 Tied access to sdbm files
723 Compile and execute code in restricted compartments
727 Search for key in dictionary file
731 Save and restore selected file handle
735 Load functions only on demand
739 Run shell commands transparently within perl
743 Load the C socket.h defines and structure manipulators
747 Persistency for perl data structures
751 A switch statement for Perl
755 Manipulate Perl symbols and their names
757 =item Term::ANSIColor
759 Color screen output using ANSI escape sequences
763 Perl termcap interface
767 Perl word completion module
771 Perl interface to various C<readline> packages. If
775 Provides a simple framework for writing test scripts
779 Run perl standard test scripts with statistics
783 Create an abbreviation table from a list
787 Extract delimited text sequences from strings.
789 =item Text::ParseWords
791 Parse text into an array of tokens or array of arrays
795 Implementation of the Soundex Algorithm as Described by Knuth
799 Expand and unexpand tabs per the unix expand(1) and unexpand(1)
803 Line wrapping to form simple paragraphs
807 Base class for tied arrays
811 Base class definitions for tied handles
815 Base class definitions for tied hashes
819 Use references as hash keys
823 Base class definitions for tied scalars
825 =item Tie::SubstrHash
827 Fixed-table-size, fixed-key-length hashing
831 Efficiently compute time from local and GMT time
835 By-name interface to Perl's built-in gmtime() function
837 =item Time::localtime
839 By-name interface to Perl's built-in localtime() function
843 Internal object used by Time::gmtime and Time::localtime
847 Base class for ALL classes (blessed references)
851 By-name interface to Perl's built-in getgr*() functions
855 By-name interface to Perl's built-in getpw*() functions
859 Interfaces to some Win32 API Functions
863 To find out I<all> modules installed on your system, including
864 those without documentation or outside the standard release,
867 % find `perl -e 'print "@INC"'` -name '*.pm' -print
869 They should all have their own documentation installed and accessible
870 via your system man(1) command. If you do not have a B<find>
871 program, you can use the Perl B<find2perl> program instead, which
872 generates Perl code as output you can run through perl. If you
873 have a B<man> program but it doesn't find your modules, you'll have
874 to fix your manpath. See L<perl> for details. If you have no
875 system B<man> command, you might try the B<perldoc> program.
877 =head2 Extension Modules
879 Extension modules are written in C (or a mix of Perl and C). They
880 are usually dynamically loaded into Perl if and when you need them,
881 but may also be be linked in statically. Supported extension modules
882 include Socket, Fcntl, and POSIX.
884 Many popular C extension modules do not come bundled (at least, not
885 completely) due to their sizes, volatility, or simply lack of time
886 for adequate testing and configuration across the multitude of
887 platforms on which Perl was beta-tested. You are encouraged to
888 look for them on CPAN (described below), or using web search engines
889 like Alta Vista or Deja News.
893 CPAN stands for Comprehensive Perl Archive Network; it's a globally
894 replicated trove of Perl materials, including documentation, style
895 guides, tricks and traps, alternate ports to non-Unix systems and
896 occasional binary distributions for these. Search engines for
897 CPAN can be found at http://cpan.perl.com/ and at
898 http://theory.uwinnipeg.ca/mod_perl/cpan-search.pl .
900 Most importantly, CPAN includes around a thousand unbundled modules,
901 some of which require a C compiler to build. Major categories of
908 Language Extensions and Documentation Tools
916 Operating System Interfaces
920 Networking, Device Control (modems) and InterProcess Communication
924 Data Types and Data Type Utilities
936 Interfaces to / Emulations of Other Programming Languages
940 File Names, File Systems and File Locking (see also File Handles)
944 String Processing, Language Text Processing, Parsing, and Searching
948 Option, Argument, Parameter, and Configuration File Processing
952 Internationalization and Locale
956 Authentication, Security, and Encryption
960 World Wide Web, HTML, HTTP, CGI, MIME
964 Server and Daemon Utilities
968 Archiving and Compression
972 Images, Pixmap and Bitmap Manipulation, Drawing, and Graphing
980 Control Flow Utilities (callbacks and exceptions etc)
984 File Handle and Input/Output Stream Utilities
988 Miscellaneous Modules
992 Registered CPAN sites as of this writing include the following.
993 You should try to choose one close to you:
1003 ftp://ftp.is.co.za/programming/perl/CPAN/
1004 ftp://ftp.saix.net/pub/CPAN/
1005 ftp://ftpza.co.za/pub/mirrors/cpan/
1006 ftp://ftp.sun.ac.za/CPAN/
1018 ftp://freesoft.cei.gov.cn/pub/languages/perl/CPAN/
1019 http://www2.linuxforum.net/mirror/CPAN/
1020 http://cpan.shellhung.org/
1021 ftp://ftp.shellhung.org/pub/CPAN
1027 http://CPAN.pacific.net.hk/
1028 ftp://ftp.pacific.net.hk/pub/mirror/CPAN/
1034 http://piksi.itb.ac.id/CPAN/
1035 ftp://mirrors.piksi.itb.ac.id/CPAN/
1036 http://CPAN.mweb.co.id/
1037 ftp://ftp.mweb.co.id/pub/languages/perl/CPAN/
1043 http://www.iglu.org.il:/pub/CPAN/
1044 ftp://ftp.iglu.org.il/pub/CPAN/
1045 http://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
1046 ftp://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
1052 ftp://ftp.u-aizu.ac.jp/pub/lang/perl/CPAN/
1053 ftp://ftp.kddlabs.co.jp/CPAN/
1054 http://mirror.nucba.ac.jp/mirror/Perl/
1055 ftp://mirror.nucba.ac.jp/mirror/Perl/
1056 ftp://ftp.meisei-u.ac.jp/pub/CPAN/
1057 ftp://ftp.jaist.ac.jp/pub/lang/perl/CPAN/
1058 ftp://ftp.dti.ad.jp/pub/lang/CPAN/
1059 ftp://ftp.ring.gr.jp/pub/lang/perl/CPAN/
1065 ftp://ftp.isu.net.sa/pub/CPAN/
1071 http://cpan.hjc.edu.sg
1072 http://ftp.nus.edu.sg/unix/perl/CPAN/
1073 ftp://ftp.nus.edu.sg/pub/unix/perl/CPAN/
1079 http://CPAN.bora.net/
1080 ftp://ftp.bora.net/pub/CPAN/
1081 http://ftp.kornet.net/CPAN/
1082 ftp://ftp.kornet.net/pub/CPAN/
1083 ftp://ftp.nuri.net/pub/CPAN/
1089 ftp://coda.nctu.edu.tw/UNIX/perl/CPAN
1090 ftp://ftp.ee.ncku.edu.tw/pub/perl/CPAN/
1091 ftp://ftp1.sinica.edu.tw/pub1/perl/CPAN/
1097 http://download.nectec.or.th/CPAN/
1098 ftp://ftp.nectec.or.th/pub/languages/CPAN/
1099 ftp://ftp.cs.riubon.ac.th/pub/mirrors/CPAN/
1103 =head2 Central America
1111 ftp://ftp.linux.co.cr/mirrors/CPAN/
1112 http://ftp.ucr.ac.cr/Unix/CPAN/
1113 ftp://ftp.ucr.ac.cr/pub/Unix/CPAN/
1125 ftp://ftp.tuwien.ac.at/pub/languages/perl/CPAN/
1131 http://ftp.easynet.be/CPAN/
1132 ftp://ftp.easynet.be/CPAN/
1133 ftp://ftp.kulnet.kuleuven.ac.be/pub/mirror/CPAN/
1139 ftp://ftp.ntrl.net/pub/mirrors/CPAN/
1145 ftp://ftp.linux.hr/pub/CPAN/
1151 http://www.fi.muni.cz/pub/perl/
1152 ftp://ftp.fi.muni.cz/pub/perl/
1153 ftp://sunsite.mff.cuni.cz/MIRRORS/ftp.funet.fi/pub/languages/perl/CPAN/
1159 ftp://sunsite.auc.dk/pub/languages/perl/CPAN/
1160 http://www.cpan.dk/CPAN/
1161 ftp://www.cpan.dk/ftp.cpan.org/CPAN/
1167 http://www.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN
1168 ftp://ftp.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN/
1169 ftp://ftp.demon.co.uk/pub/mirrors/perl/CPAN/
1170 ftp://ftp.flirble.org/pub/languages/perl/CPAN/
1171 ftp://ftp.plig.org/pub/CPAN/
1172 ftp://sunsite.doc.ic.ac.uk/packages/CPAN/
1173 http://mirror.uklinux.net/CPAN/
1174 ftp://mirror.uklinux.net/pub/CPAN/
1175 ftp://usit.shef.ac.uk/pub/packages/CPAN/
1181 ftp://ftp.ut.ee/pub/languages/perl/CPAN/
1187 ftp://ftp.funet.fi/pub/languages/perl/CPAN/
1193 ftp://cpan.ftp.worldonline.fr/pub/CPAN/
1194 ftp://ftp.club-internet.fr/pub/perl/CPAN/
1195 ftp://ftp.lip6.fr/pub/perl/CPAN/
1196 ftp://ftp.oleane.net/pub/mirrors/CPAN/
1197 ftp://ftp.pasteur.fr/pub/computing/CPAN/
1198 ftp://cpan.cict.fr/pub/CPAN/
1199 ftp://ftp.uvsq.fr/pub/perl/CPAN/
1205 ftp://ftp.rz.ruhr-uni-bochum.de/pub/CPAN/
1206 ftp://ftp.freenet.de/pub/ftp.cpan.org/pub/CPAN/
1207 ftp://ftp.uni-erlangen.de/pub/source/CPAN/
1208 ftp://ftp-stud.fht-esslingen.de/pub/Mirrors/CPAN
1209 ftp://ftp.gigabell.net/pub/CPAN/
1210 http://ftp.gwdg.de/pub/languages/perl/CPAN/
1211 ftp://ftp.gwdg.de/pub/languages/perl/CPAN/
1212 ftp://ftp.uni-hamburg.de/pub/soft/lang/perl/CPAN/
1213 ftp://ftp.leo.org/pub/comp/general/programming/languages/script/perl/CPAN/
1214 ftp://ftp.mpi-sb.mpg.de/pub/perl/CPAN/
1215 ftp://ftp.gmd.de/mirrors/CPAN/
1221 ftp://ftp.forthnet.gr/pub/languages/perl/CPAN
1222 ftp://ftp.ntua.gr/pub/lang/perl/
1228 http://cpan.artifact.hu/
1229 ftp://cpan.artifact.hu/CPAN/
1230 ftp://ftp.kfki.hu/pub/packages/perl/CPAN/
1237 ftp://ftp.gm.is/pub/CPAN/
1243 http://cpan.indigo.ie/
1244 ftp://cpan.indigo.ie/pub/CPAN/
1245 http://sunsite.compapp.dcu.ie/pub/perl/
1246 ftp://sunsite.compapp.dcu.ie/pub/perl/
1252 http://cpan.nettuno.it/
1253 http://gusp.dyndns.org/CPAN/
1254 ftp://gusp.dyndns.org/pub/CPAN
1255 http://softcity.iol.it/cpan
1256 ftp://softcity.iol.it/pub/cpan
1257 ftp://ftp.unina.it/pub/Other/CPAN/
1258 ftp://ftp.unipi.it/pub/mirror/perl/CPAN/
1259 ftp://cis.uniRoma2.it/CPAN/
1260 ftp://ftp.edisontel.it/pub/CPAN_Mirror/
1261 ftp://ftp.flashnet.it/pub/CPAN/
1267 http://kvin.lv/pub/CPAN/
1273 ftp://download.xs4all.nl/pub/mirror/CPAN/
1274 ftp://ftp.nl.uu.net/pub/CPAN/
1275 ftp://ftp.nluug.nl/pub/languages/perl/CPAN/
1276 ftp://ftp.cpan.nl/pub/CPAN/
1277 http://www.cs.uu.nl/mirror/CPAN/
1278 ftp://ftp.cs.uu.nl/mirror/CPAN/
1284 ftp://sunsite.uio.no/pub/languages/perl/CPAN/
1285 ftp://ftp.uit.no/pub/languages/perl/cpan/
1291 ftp://ftp.pk.edu.pl/pub/lang/perl/CPAN/
1292 ftp://ftp.mega.net.pl/pub/mirrors/ftp.perl.com/
1293 ftp://ftp.man.torun.pl/pub/doc/CPAN/
1294 ftp://sunsite.icm.edu.pl/pub/CPAN/
1300 ftp://ftp.ua.pt/pub/CPAN/
1301 ftp://perl.di.uminho.pt/pub/CPAN/
1302 ftp://ftp.ist.utl.pt/pub/CPAN/
1303 ftp://ftp.netc.pt/pub/CPAN/
1309 ftp://archive.logicnet.ro/mirrors/ftp.cpan.org/CPAN/
1310 ftp://ftp.kappa.ro/pub/mirrors/ftp.perl.org/pub/CPAN/
1311 ftp://ftp.dntis.ro/pub/cpan/
1312 ftp://ftp.opsynet.com/cpan/
1313 ftp://ftp.dnttm.ro/pub/CPAN/
1314 ftp://ftp.timisoara.roedu.net/mirrors/CPAN/
1320 ftp://ftp.chg.ru/pub/lang/perl/CPAN/
1321 http://cpan.rinet.ru/
1322 ftp://cpan.rinet.ru/pub/mirror/CPAN/
1323 ftp://ftp.aha.ru/pub/CPAN/
1324 ftp://ftp.sai.msu.su/pub/lang/perl/CPAN/
1330 ftp://ftp.entry.sk/pub/languages/perl/CPAN/
1336 ftp://ftp.arnes.si/software/perl/CPAN/
1342 ftp://ftp.rediris.es/mirror/CPAN/
1343 ftp://ftp.etse.urv.es/pub/perl/
1349 http://ftp.du.se/CPAN/
1350 ftp://ftp.du.se/pub/CPAN/
1351 ftp://ftp.sunet.se/pub/lang/perl/CPAN/
1357 ftp://ftp.danyk.ch/CPAN/
1358 ftp://sunsite.cnlab-switch.ch/mirror/CPAN/
1364 ftp://sunsite.bilkent.edu.tr/pub/languages/CPAN/
1368 =head2 North America
1382 http://sunsite.ualberta.ca/pub/Mirror/CPAN/
1383 ftp://sunsite.ualberta.ca/pub/Mirror/CPAN/
1389 http://theoryx5.uwinnipeg.ca/pub/CPAN/
1390 ftp://theoryx5.uwinnipeg.ca/pub/CPAN/
1396 ftp://cpan.chebucto.ns.ca/pub/CPAN/
1402 ftp://ftp.crc.ca/pub/packages/lang/perl/CPAN/
1408 http://www.msg.com.mx/CPAN/
1409 ftp://ftp.msg.com.mx/pub/CPAN/
1423 http://mirror.hiwaay.net/CPAN/
1424 ftp://mirror.hiwaay.net/CPAN/
1430 http://www.cpan.org/
1431 ftp://ftp.cpan.org/CPAN/
1432 ftp://cpan.nas.nasa.gov/pub/perl/CPAN/
1433 ftp://ftp.digital.com/pub/plan/perl/CPAN/
1434 http://www.kernel.org/pub/mirrors/cpan/
1435 ftp://ftp.kernel.org/pub/mirrors/cpan/
1436 http://www.perl.com/CPAN/
1437 http://download.sourceforge.net/mirrors/CPAN/
1443 ftp://ftp.cs.colorado.edu/pub/perl/CPAN/
1449 ftp://ftp.cise.ufl.edu/pub/perl/CPAN/
1455 ftp://ftp.twoguys.org/CPAN/
1461 http://www.neurogames.com/mirrors/CPAN
1462 http://uiarchive.uiuc.edu/mirrors/ftp/ftp.cpan.org/pub/CPAN/
1463 ftp://uiarchive.uiuc.edu/mirrors/ftp/ftp.cpan.org/pub/CPAN/
1469 ftp://ftp.uwsg.indiana.edu/pub/perl/CPAN/
1470 http://cpan.nitco.com/
1471 ftp://cpan.nitco.com/pub/CPAN/
1472 ftp://cpan.in-span.net/
1473 http://csociety-ftp.ecn.purdue.edu/pub/CPAN
1474 ftp://csociety-ftp.ecn.purdue.edu/pub/CPAN
1480 http://cpan.uky.edu/
1481 ftp://cpan.uky.edu/pub/CPAN/
1487 ftp://ftp.ccs.neu.edu/net/mirrors/ftp.funet.fi/pub/languages/perl/CPAN/
1488 ftp://ftp.iguide.com/pub/mirrors/packages/perl/CPAN/
1494 ftp://ftp.cpanel.net/pub/CPAN/
1500 ftp://ftp.freesoftware.com/pub/perl/CPAN/
1501 http://www.deao.net/mirrors/CPAN/
1502 ftp://ftp.deao.net/pub/CPAN/
1503 ftp://ftp.stealth.net/pub/mirrors/ftp.cpan.org/pub/CPAN/
1504 http://mirror.nyc.anidea.com/CPAN/
1505 ftp://mirror.nyc.anidea.com/pub/CPAN/
1506 http://www.rge.com/pub/languages/perl/
1507 ftp://ftp.rge.com/pub/languages/perl/
1508 ftp://mirrors.cloud9.net/pub/mirrors/CPAN/
1514 ftp://ftp.duke.edu/pub/perl/
1520 ftp://ftp.loaded.net/pub/CPAN/
1526 ftp://ftp.ou.edu/mirrors/CPAN/
1532 ftp://ftp.orst.edu/pub/packages/CPAN/
1538 http://ftp.epix.net/CPAN/
1539 ftp://ftp.epix.net/pub/languages/perl/
1540 ftp://carroll.cac.psu.edu/pub/CPAN/
1546 ftp://ftp.sunsite.utk.edu/pub/CPAN/
1552 http://ftp.sedl.org/pub/mirrors/CPAN/
1553 http://jhcloos.com/pub/mirror/CPAN/
1554 ftp://jhcloos.com/pub/mirror/CPAN/
1560 ftp://mirror.xmission.com/CPAN/
1566 http://mirrors.rcn.net/pub/lang/CPAN/
1567 ftp://mirrors.rcn.net/pub/lang/CPAN/
1568 ftp://ruff.cs.jmu.edu/pub/CPAN/
1569 http://perl.Liquidation.com/CPAN/
1575 http://cpan.llarian.net/
1576 ftp://cpan.llarian.net/pub/CPAN/
1577 ftp://ftp-mirror.internap.com/pub/CPAN/
1578 ftp://ftp.spu.edu/pub/CPAN/
1592 http://ftp.planetmirror.com/pub/CPAN/
1593 ftp://ftp.planetmirror.com/pub/CPAN/
1594 ftp://mirror.aarnet.edu.au/pub/perl/CPAN/
1595 ftp://cpan.topend.com.au/pub/CPAN/
1601 ftp://ftp.auckland.ac.nz/pub/perl/CPAN/
1605 =head2 South America
1613 ftp://mirrors.bannerlandia.com.ar/mirrors/CPAN/
1619 ftp://cpan.pop-mg.com.br/pub/CPAN/
1620 ftp://ftp.matrix.com.br/pub/perl/
1621 ftp://cpan.if.usp.br/pub/mirror/CPAN/
1627 ftp://ftp.psinet.cl/pub/programming/perl/CPAN/
1628 ftp://sunsite.dcc.uchile.cl/pub/lang/perl/
1632 For an up-to-date listing of CPAN sites,
1633 see http://www.cpan.org/SITES or ftp://www.cpan.org/SITES .
1635 =head1 Modules: Creation, Use, and Abuse
1637 (The following section is borrowed directly from Tim Bunce's modules
1638 file, available at your nearest CPAN site.)
1640 Perl implements a class using a package, but the presence of a
1641 package doesn't imply the presence of a class. A package is just a
1642 namespace. A class is a package that provides subroutines that can be
1643 used as methods. A method is just a subroutine that expects, as its
1644 first argument, either the name of a package (for "static" methods),
1645 or a reference to something (for "virtual" methods).
1647 A module is a file that (by convention) provides a class of the same
1648 name (sans the .pm), plus an import method in that class that can be
1649 called to fetch exported symbols. This module may implement some of
1650 its methods by loading dynamic C or C++ objects, but that should be
1651 totally transparent to the user of the module. Likewise, the module
1652 might set up an AUTOLOAD function to slurp in subroutine definitions on
1653 demand, but this is also transparent. Only the F<.pm> file is required to
1654 exist. See L<perlsub>, L<perltoot>, and L<AutoLoader> for details about
1655 the AUTOLOAD mechanism.
1657 =head2 Guidelines for Module Creation
1663 Do similar modules already exist in some form?
1665 If so, please try to reuse the existing modules either in whole or
1666 by inheriting useful features into a new class. If this is not
1667 practical try to get together with the module authors to work on
1668 extending or enhancing the functionality of the existing modules.
1669 A perfect example is the plethora of packages in perl4 for dealing
1670 with command line options.
1672 If you are writing a module to expand an already existing set of
1673 modules, please coordinate with the author of the package. It
1674 helps if you follow the same naming scheme and module interaction
1675 scheme as the original author.
1679 Try to design the new module to be easy to extend and reuse.
1681 Try to C<use warnings;> (or C<use warnings qw(...);>).
1682 Remember that you can add C<no warnings qw(...);> to individual blocks
1683 of code that need less warnings.
1685 Use blessed references. Use the two argument form of bless to bless
1686 into the class name given as the first parameter of the constructor,
1691 return bless {}, $class;
1694 or even this if you'd like it to be used as either a static
1695 or a virtual method.
1699 my $class = ref($self) || $self;
1700 return bless {}, $class;
1703 Pass arrays as references so more parameters can be added later
1704 (it's also faster). Convert functions into methods where
1705 appropriate. Split large methods into smaller more flexible ones.
1706 Inherit methods from other modules if appropriate.
1708 Avoid class name tests like: C<die "Invalid" unless ref $ref eq 'FOO'>.
1709 Generally you can delete the C<eq 'FOO'> part with no harm at all.
1710 Let the objects look after themselves! Generally, avoid hard-wired
1711 class names as far as possible.
1713 Avoid C<< $r->Class::func() >> where using C<@ISA=qw(... Class ...)> and
1714 C<< $r->func() >> would work (see L<perlbot> for more details).
1716 Use autosplit so little used or newly added functions won't be a
1717 burden to programs that don't use them. Add test functions to
1718 the module after __END__ either using AutoSplit or by saying:
1720 eval join('',<main::DATA>) || die $@ unless caller();
1722 Does your module pass the 'empty subclass' test? If you say
1723 C<@SUBCLASS::ISA = qw(YOURCLASS);> your applications should be able
1724 to use SUBCLASS in exactly the same way as YOURCLASS. For example,
1725 does your application still work if you change: C<$obj = new YOURCLASS;>
1726 into: C<$obj = new SUBCLASS;> ?
1728 Avoid keeping any state information in your packages. It makes it
1729 difficult for multiple other packages to use yours. Keep state
1730 information in objects.
1734 Try to C<use strict;> (or C<use strict qw(...);>).
1735 Remember that you can add C<no strict qw(...);> to individual blocks
1736 of code that need less strictness.
1740 Follow the guidelines in the perlstyle(1) manual.
1746 Some simple style guidelines
1748 The perlstyle manual supplied with Perl has many helpful points.
1750 Coding style is a matter of personal taste. Many people evolve their
1751 style over several years as they learn what helps them write and
1752 maintain good code. Here's one set of assorted suggestions that
1753 seem to be widely used by experienced developers:
1755 Use underscores to separate words. It is generally easier to read
1756 $var_names_like_this than $VarNamesLikeThis, especially for
1757 non-native speakers of English. It's also a simple rule that works
1758 consistently with VAR_NAMES_LIKE_THIS.
1760 Package/Module names are an exception to this rule. Perl informally
1761 reserves lowercase module names for 'pragma' modules like integer
1762 and strict. Other modules normally begin with a capital letter and
1763 use mixed case with no underscores (need to be short and portable).
1765 You may find it helpful to use letter case to indicate the scope
1766 or nature of a variable. For example:
1768 $ALL_CAPS_HERE constants only (beware clashes with Perl vars)
1769 $Some_Caps_Here package-wide global/static
1770 $no_caps_here function scope my() or local() variables
1772 Function and method names seem to work best as all lowercase.
1773 e.g., C<< $obj->as_string() >>.
1775 You can use a leading underscore to indicate that a variable or
1776 function should not be used outside the package that defined it.
1780 Select what to export.
1782 Do NOT export method names!
1784 Do NOT export anything else by default without a good reason!
1786 Exports pollute the namespace of the module user. If you must
1787 export try to use @EXPORT_OK in preference to @EXPORT and avoid
1788 short or common names to reduce the risk of name clashes.
1790 Generally anything not exported is still accessible from outside the
1791 module using the ModuleName::item_name (or C<< $blessed_ref->method >>)
1792 syntax. By convention you can use a leading underscore on names to
1793 indicate informally that they are 'internal' and not for public use.
1795 (It is actually possible to get private functions by saying:
1796 C<my $subref = sub { ... }; &$subref;>. But there's no way to call that
1797 directly as a method, because a method must have a name in the symbol
1800 As a general rule, if the module is trying to be object oriented
1801 then export nothing. If it's just a collection of functions then
1802 @EXPORT_OK anything but use @EXPORT with caution.
1806 Select a name for the module.
1808 This name should be as descriptive, accurate, and complete as
1809 possible. Avoid any risk of ambiguity. Always try to use two or
1810 more whole words. Generally the name should reflect what is special
1811 about what the module does rather than how it does it. Please use
1812 nested module names to group informally or categorize a module.
1813 There should be a very good reason for a module not to have a nested name.
1814 Module names should begin with a capital letter.
1816 Having 57 modules all called Sort will not make life easy for anyone
1817 (though having 23 called Sort::Quick is only marginally better :-).
1818 Imagine someone trying to install your module alongside many others.
1819 If in any doubt ask for suggestions in comp.lang.perl.misc.
1821 If you are developing a suite of related modules/classes it's good
1822 practice to use nested classes with a common prefix as this will
1823 avoid namespace clashes. For example: Xyz::Control, Xyz::View,
1824 Xyz::Model etc. Use the modules in this list as a naming guide.
1826 If adding a new module to a set, follow the original author's
1827 standards for naming modules and the interface to methods in
1830 If developing modules for private internal or project specific use,
1831 that will never be released to the public, then you should ensure
1832 that their names will not clash with any future public module. You
1833 can do this either by using the reserved Local::* category or by
1834 using a category name that includes an underscore like Foo_Corp::*.
1836 To be portable each component of a module name should be limited to
1837 11 characters. If it might be used on MS-DOS then try to ensure each is
1838 unique in the first 8 characters. Nested modules make this easier.
1842 Have you got it right?
1844 How do you know that you've made the right decisions? Have you
1845 picked an interface design that will cause problems later? Have
1846 you picked the most appropriate name? Do you have any questions?
1848 The best way to know for sure, and pick up many helpful suggestions,
1849 is to ask someone who knows. Comp.lang.perl.misc is read by just about
1850 all the people who develop modules and it's the best place to ask.
1852 All you need to do is post a short summary of the module, its
1853 purpose and interfaces. A few lines on each of the main methods is
1854 probably enough. (If you post the whole module it might be ignored
1855 by busy people - generally the very people you want to read it!)
1857 Don't worry about posting if you can't say when the module will be
1858 ready - just say so in the message. It might be worth inviting
1859 others to help you, they may be able to complete it for you!
1863 README and other Additional Files.
1865 It's well known that software developers usually fully document the
1866 software they write. If, however, the world is in urgent need of
1867 your software and there is not enough time to write the full
1868 documentation please at least provide a README file containing:
1874 A description of the module/package/extension etc.
1878 A copyright notice - see below.
1882 Prerequisites - what else you may need to have.
1886 How to build it - possible changes to Makefile.PL etc.
1894 Recent changes in this release, especially incompatibilities
1898 Changes / enhancements you plan to make in the future.
1902 If the README file seems to be getting too large you may wish to
1903 split out some of the sections into separate files: INSTALL,
1908 =item Adding a Copyright Notice.
1911 How you choose to license your work is a personal decision.
1912 The general mechanism is to assert your Copyright and then make
1913 a declaration of how others may copy/use/modify your work.
1915 Perl, for example, is supplied with two types of licence: The GNU
1916 GPL and The Artistic Licence (see the files README, Copying, and
1917 Artistic). Larry has good reasons for NOT just using the GNU GPL.
1919 My personal recommendation, out of respect for Larry, Perl, and the
1920 Perl community at large is to state something simply like:
1922 Copyright (c) 1995 Your Name. All rights reserved.
1923 This program is free software; you can redistribute it and/or
1924 modify it under the same terms as Perl itself.
1926 This statement should at least appear in the README file. You may
1927 also wish to include it in a Copying file and your source files.
1928 Remember to include the other words in addition to the Copyright.
1932 Give the module a version/issue/release number.
1934 To be fully compatible with the Exporter and MakeMaker modules you
1935 should store your module's version number in a non-my package
1936 variable called $VERSION. This should be a floating point
1937 number with at least two digits after the decimal (i.e., hundredths,
1938 e.g, C<$VERSION = "0.01">). Don't use a "1.3.2" style version.
1939 See L<Exporter> for details.
1941 It may be handy to add a function or method to retrieve the number.
1942 Use the number in announcements and archive file names when
1943 releasing the module (ModuleName-1.02.tar.Z).
1944 See perldoc ExtUtils::MakeMaker.pm for details.
1948 How to release and distribute a module.
1950 It's good idea to post an announcement of the availability of your
1951 module (or the module itself if small) to the comp.lang.perl.announce
1952 Usenet newsgroup. This will at least ensure very wide once-off
1955 If possible, register the module with CPAN. You should
1956 include details of its location in your announcement.
1958 Some notes about ftp archives: Please use a long descriptive file
1959 name that includes the version number. Most incoming directories
1960 will not be readable/listable, i.e., you won't be able to see your
1961 file after uploading it. Remember to send your email notification
1962 message as soon as possible after uploading else your file may get
1963 deleted automatically. Allow time for the file to be processed
1964 and/or check the file has been processed before announcing its
1967 FTP Archives for Perl Modules:
1969 Follow the instructions and links on:
1971 http://www.cpan.org/modules/00modlist.long.html
1972 http://www.cpan.org/modules/04pause.html
1974 or upload to one of these sites:
1976 https://pause.kbx.de/pause/
1977 http://pause.perl.org/pause/
1979 and notify <modules@perl.org>.
1981 By using the WWW interface you can ask the Upload Server to mirror
1982 your modules from your ftp or WWW site into your own directory on
1985 Please remember to send me an updated entry for the Module list!
1989 Take care when changing a released module.
1991 Always strive to remain compatible with previous released versions.
1992 Otherwise try to add a mechanism to revert to the
1993 old behavior if people rely on it. Document incompatible changes.
1999 =head2 Guidelines for Converting Perl 4 Library Scripts into Modules
2005 There is no requirement to convert anything.
2007 If it ain't broke, don't fix it! Perl 4 library scripts should
2008 continue to work with no problems. You may need to make some minor
2009 changes (like escaping non-array @'s in double quoted strings) but
2010 there is no need to convert a .pl file into a Module for just that.
2014 Consider the implications.
2016 All Perl applications that make use of the script will need to
2017 be changed (slightly) if the script is converted into a module. Is
2018 it worth it unless you plan to make other changes at the same time?
2022 Make the most of the opportunity.
2024 If you are going to convert the script to a module you can use the
2025 opportunity to redesign the interface. The guidelines for module
2026 creation above include many of the issues you should consider.
2030 The pl2pm utility will get you started.
2032 This utility will read *.pl files (given as parameters) and write
2033 corresponding *.pm files. The pl2pm utilities does the following:
2039 Adds the standard Module prologue lines
2043 Converts package specifiers from ' to ::
2047 Converts die(...) to croak(...)
2051 Several other minor changes
2055 Being a mechanical process pl2pm is not bullet proof. The converted
2056 code will need careful checking, especially any package statements.
2057 Don't delete the original .pl file till the new .pm one works!
2061 =head2 Guidelines for Reusing Application Code
2067 Complete applications rarely belong in the Perl Module Library.
2071 Many applications contain some Perl code that could be reused.
2073 Help save the world! Share your code in a form that makes it easy
2078 Break-out the reusable code into one or more separate module files.
2082 Take the opportunity to reconsider and redesign the interfaces.
2086 In some cases the 'application' can then be reduced to a small
2088 fragment of code built on top of the reusable modules. In these cases
2089 the application could invoked as:
2091 % perl -e 'use Module::Name; method(@ARGV)' ...
2093 % perl -mModule::Name ... (in perl5.002 or higher)
2099 Perl does not enforce private and public parts of its modules as you may
2100 have been used to in other languages like C++, Ada, or Modula-17. Perl
2101 doesn't have an infatuation with enforced privacy. It would prefer
2102 that you stayed out of its living room because you weren't invited, not
2103 because it has a shotgun.
2105 The module and its user have a contract, part of which is common law,
2106 and part of which is "written". Part of the common law contract is
2107 that a module doesn't pollute any namespace it wasn't asked to. The
2108 written contract for the module (A.K.A. documentation) may make other
2109 provisions. But then you know when you C<use RedefineTheWorld> that
2110 you're redefining the world and willing to take the consequences.