Archive::Extract - small pod update
[p5sagit/p5-mst-13.2.git] / pod / perlmodlib.pod
1 =for maintainers
2 Generated by perlmodlib.PL -- DO NOT EDIT!
3
4 =head1 NAME
5
6 perlmodlib - constructing new Perl modules and finding existing ones
7
8 =head1 THE PERL MODULE LIBRARY
9
10 Many modules are included in the Perl distribution.  These are described
11 below, and all end in F<.pm>.  You may discover compiled library
12 files (usually ending in F<.so>) or small pieces of modules to be
13 autoloaded (ending in F<.al>); these were automatically generated
14 by the installation process.  You may also discover files in the
15 library directory that end in either F<.pl> or F<.ph>.  These are
16 old libraries supplied so that old programs that use them still
17 run.  The F<.pl> files will all eventually be converted into standard
18 modules, and the F<.ph> files made by B<h2ph> will probably end up
19 as extension modules made by B<h2xs>.  (Some F<.ph> values may
20 already be available through the POSIX, Errno, or Fcntl modules.)
21 The B<pl2pm> file in the distribution may help in your conversion,
22 but it's just a mechanical process and therefore far from bulletproof.
23
24 =head2 Pragmatic Modules
25
26 They work somewhat like compiler directives (pragmata) in that they
27 tend to affect the compilation of your program, and thus will usually
28 work well only when used within a C<use>, or C<no>.  Most of these
29 are lexically scoped, so an inner BLOCK may countermand them
30 by saying:
31
32     no integer;
33     no strict 'refs';
34     no warnings;
35
36 which lasts until the end of that BLOCK.
37
38 Some pragmas are lexically scoped--typically those that affect the
39 C<$^H> hints variable.  Others affect the current package instead,
40 like C<use vars> and C<use subs>, which allow you to predeclare a
41 variables or subroutines within a particular I<file> rather than
42 just a block.  Such declarations are effective for the entire file
43 for which they were declared.  You cannot rescind them with C<no
44 vars> or C<no subs>.
45
46 The following pragmas are defined (and have their own documentation).
47
48 =over 12
49
50 =item attributes
51
52 Get/set subroutine or variable attributes
53
54 =item attrs
55
56 Set/get attributes of a subroutine (deprecated)
57
58 =item autouse
59
60 Postpone load of modules until a function is used
61
62 =item base
63
64 Establish IS-A relationship with base classes at compile time
65
66 =item bigint
67
68 Transparent BigInteger support for Perl
69
70 =item bignum
71
72 Transparent BigNumber support for Perl
73
74 =item bigrat
75
76 Transparent BigNumber/BigRational support for Perl
77
78 =item blib
79
80 Use MakeMaker's uninstalled version of a package
81
82 =item bytes
83
84 Force byte semantics rather than character semantics
85
86 =item charnames
87
88 Define character names for C<\N{named}> string literal escapes
89
90 =item constant
91
92 Declare constants
93
94 =item diagnostics
95
96 Produce verbose warning diagnostics
97
98 =item encoding
99
100 Allows you to write your script in non-ascii or non-utf8
101
102 =item encoding::warnings
103
104 Warn on implicit encoding conversions
105
106 =item feature
107
108 Enable new syntactic features
109
110 =item fields
111
112 Compile-time class fields
113
114 =item filetest
115
116 Control the filetest permission operators
117
118 =item if
119
120 C<use> a Perl module if a condition holds
121
122 =item integer
123
124 Use integer arithmetic instead of floating point
125
126 =item less
127
128 Request less of something
129
130 =item lib
131
132 Manipulate @INC at compile time
133
134 =item locale
135
136 Use and avoid POSIX locales for built-in operations
137
138 =item mro
139
140 Method Resolution Order
141
142 =item open
143
144 Set default PerlIO layers for input and output
145
146 =item ops
147
148 Restrict unsafe operations when compiling
149
150 =item overload
151
152 Package for overloading Perl operations
153
154 =item re
155
156 Alter regular expression behaviour
157
158 =item sigtrap
159
160 Enable simple signal handling
161
162 =item sort
163
164 Control sort() behaviour
165
166 =item strict
167
168 Restrict unsafe constructs
169
170 =item subs
171
172 Predeclare sub names
173
174 =item threads
175
176 Perl interpreter-based threads
177
178 =item threads::shared
179
180 Perl extension for sharing data structures between threads
181
182 =item utf8
183
184 Enable/disable UTF-8 (or UTF-EBCDIC) in source code
185
186 =item vars
187
188 Predeclare global variable names (obsolete)
189
190 =item version
191
192 Perl extension for Version Objects
193
194 =item vmsish
195
196 Control VMS-specific language features
197
198 =item warnings
199
200 Control optional warnings
201
202 =item warnings::register
203
204 Warnings import function
205
206 =back
207
208 =head2 Standard Modules
209
210 Standard, bundled modules are all expected to behave in a well-defined
211 manner with respect to namespace pollution because they use the
212 Exporter module.  See their own documentation for details.
213
214 It's possible that not all modules listed below are installed on your
215 system. For example, the GDBM_File module will not be installed if you
216 don't have the gdbm library.
217
218 =over 12
219
220 =item AnyDBM_File
221
222 Provide framework for multiple DBMs
223
224 =item Archive::Extract
225
226 A generic archive extracting mechanism
227
228 =item Archive::Tar
229
230 Module for manipulations of tar archives
231
232 =item Archive::Tar::File
233
234 A subclass for in-memory extracted file from Archive::Tar
235
236 =item Attribute::Handlers
237
238 Simpler definition of attribute handlers
239
240 =item AutoLoader
241
242 Load subroutines only on demand
243
244 =item AutoSplit
245
246 Split a package for autoloading
247
248 =item B
249
250 The Perl Compiler
251
252 =item B::Concise
253
254 Walk Perl syntax tree, printing concise info about ops
255
256 =item B::Debug
257
258 Walk Perl syntax tree, printing debug info about ops
259
260 =item B::Deparse
261
262 Perl compiler backend to produce perl code
263
264 =item B::Lint
265
266 Perl lint
267
268 =item B::Showlex
269
270 Show lexical variables used in functions or files
271
272 =item B::Terse
273
274 Walk Perl syntax tree, printing terse info about ops
275
276 =item B::Xref
277
278 Generates cross reference reports for Perl programs
279
280 =item Benchmark
281
282 Benchmark running times of Perl code
283
284 =item CGI
285
286 Simple Common Gateway Interface Class
287
288 =item CGI::Apache
289
290 Backward compatibility module for CGI.pm
291
292 =item CGI::Carp
293
294 CGI routines for writing to the HTTPD (or other) error log
295
296 =item CGI::Cookie
297
298 Interface to Netscape Cookies
299
300 =item CGI::Fast
301
302 CGI Interface for Fast CGI
303
304 =item CGI::Pretty
305
306 Module to produce nicely formatted HTML code
307
308 =item CGI::Push
309
310 Simple Interface to Server Push
311
312 =item CGI::Switch
313
314 Backward compatibility module for defunct CGI::Switch
315
316 =item CGI::Util
317
318 Internal utilities used by CGI module
319
320 =item CPAN
321
322 Query, download and build perl modules from CPAN sites
323
324 =item CPAN::FirstTime
325
326 Utility for CPAN::Config file Initialization
327
328 =item CPAN::Kwalify
329
330 Interface between CPAN.pm and Kwalify.pm
331
332 =item CPAN::Nox
333
334 Wrapper around CPAN.pm without using any XS module
335
336 =item CPAN::Version
337
338 Utility functions to compare CPAN versions
339
340 =item CPANPLUS
341
342 API & CLI access to the CPAN mirrors
343
344 =item CPANPLUS::Dist::Base
345
346 Base class for custom distribution classes
347
348 =item CPANPLUS::Dist::Sample
349
350 Sample code to create your own Dist::* plugin
351
352 =item CPANPLUS::Shell::Classic
353
354 CPAN.pm emulation for CPANPLUS
355
356 =item CPANPLUS::Shell::Default::Plugins::HOWTO
357
358 Documentation on how to write your own plugins
359
360 =item Carp
361
362 Warn of errors (from perspective of caller)
363
364 =item Carp::Heavy
365
366 Heavy machinery, no user serviceable parts inside
367
368 =item Class::ISA
369
370 Report the search path for a class's ISA tree
371
372 =item Class::Struct
373
374 Declare struct-like datatypes as Perl classes
375
376 =item Compress::Raw::Zlib
377
378 Low-Level Interface to zlib compression library
379
380 =item Compress::Zlib
381
382 Interface to zlib compression library
383
384 =item Config
385
386 Access Perl configuration information
387
388 =item Cwd
389
390 Get pathname of current working directory
391
392 =item DB
393
394 Programmatic interface to the Perl debugging API (draft, subject to
395
396 =item DBM_Filter
397
398 Filter DBM keys/values 
399
400 =item DBM_Filter::compress
401
402 Filter for DBM_Filter
403
404 =item DBM_Filter::encode
405
406 Filter for DBM_Filter
407
408 =item DBM_Filter::int32
409
410 Filter for DBM_Filter
411
412 =item DBM_Filter::null
413
414 Filter for DBM_Filter
415
416 =item DBM_Filter::utf8
417
418 Filter for DBM_Filter
419
420 =item DB_File
421
422 Perl5 access to Berkeley DB version 1.x
423
424 =item Data::Dumper
425
426 Stringified perl data structures, suitable for both printing and C<eval>
427
428 =item Devel::DProf
429
430 A Perl code profiler
431
432 =item Devel::InnerPackage
433
434 Find all the inner packages of a package
435
436 =item Devel::Peek
437
438 A data debugging tool for the XS programmer
439
440 =item Devel::SelfStubber
441
442 Generate stubs for a SelfLoading module
443
444 =item Digest
445
446 Modules that calculate message digests
447
448 =item Digest::MD5
449
450 Perl interface to the MD5 Algorithm
451
452 =item Digest::SHA
453
454 Perl extension for SHA-1/224/256/384/512
455
456 =item Digest::base
457
458 Digest base class
459
460 =item Digest::file
461
462 Calculate digests of files
463
464 =item DirHandle
465
466 Supply object methods for directory handles
467
468 =item Dumpvalue
469
470 Provides screen dump of Perl data.
471
472 =item DynaLoader
473
474 Dynamically load C libraries into Perl code
475
476 =item Encode
477
478 Character encodings
479
480 =item Encode::Alias
481
482 Alias definitions to encodings
483
484 =item Encode::Byte
485
486 Single Byte Encodings
487
488 =item Encode::CJKConstants
489
490 Internally used by Encode::??::ISO_2022_*
491
492 =item Encode::CN
493
494 China-based Chinese Encodings
495
496 =item Encode::CN::HZ
497
498 Internally used by Encode::CN
499
500 =item Encode::Config
501
502 Internally used by Encode
503
504 =item Encode::EBCDIC
505
506 EBCDIC Encodings
507
508 =item Encode::Encoder
509
510 Object Oriented Encoder
511
512 =item Encode::Encoding
513
514 Encode Implementation Base Class
515
516 =item Encode::GSM0338
517
518 ESTI GSM 03.38 Encoding
519
520 =item Encode::Guess
521
522 Guesses encoding from data
523
524 =item Encode::JP
525
526 Japanese Encodings
527
528 =item Encode::JP::H2Z
529
530 Internally used by Encode::JP::2022_JP*
531
532 =item Encode::JP::JIS7
533
534 Internally used by Encode::JP
535
536 =item Encode::KR
537
538 Korean Encodings
539
540 =item Encode::KR::2022_KR
541
542 Internally used by Encode::KR
543
544 =item Encode::MIME::Header
545
546 MIME 'B' and 'Q' header encoding
547
548 =item Encode::MIME::Name
549
550 Internally used by Encode
551
552 =item Encode::PerlIO
553
554 A detailed document on Encode and PerlIO
555
556 =item Encode::Supported
557
558 Encodings supported by Encode
559
560 =item Encode::Symbol
561
562 Symbol Encodings
563
564 =item Encode::TW
565
566 Taiwan-based Chinese Encodings
567
568 =item Encode::Unicode
569
570 Various Unicode Transformation Formats
571
572 =item Encode::Unicode::UTF7
573
574 UTF-7 encoding
575
576 =item English
577
578 Use nice English (or awk) names for ugly punctuation variables
579
580 =item Env
581
582 Perl module that imports environment variables as scalars or arrays
583
584 =item Errno
585
586 System errno constants
587
588 =item Exporter
589
590 Implements default import method for modules
591
592 =item Exporter::Heavy
593
594 Exporter guts
595
596 =item ExtUtils::CBuilder
597
598 Compile and link C code for Perl modules
599
600 =item ExtUtils::CBuilder::Platform::Windows
601
602 Builder class for Windows platforms
603
604 =item ExtUtils::Command
605
606 Utilities to replace common UNIX commands in Makefiles etc.
607
608 =item ExtUtils::Command::MM
609
610 Commands for the MM's to use in Makefiles
611
612 =item ExtUtils::Constant
613
614 Generate XS code to import C header constants
615
616 =item ExtUtils::Constant::Base
617
618 Base class for ExtUtils::Constant objects
619
620 =item ExtUtils::Constant::Utils
621
622 Helper functions for ExtUtils::Constant
623
624 =item ExtUtils::Constant::XS
625
626 Base class for ExtUtils::Constant objects
627
628 =item ExtUtils::Embed
629
630 Utilities for embedding Perl in C/C++ applications
631
632 =item ExtUtils::Install
633
634 Install files from here to there
635
636 =item ExtUtils::Installed
637
638 Inventory management of installed modules
639
640 =item ExtUtils::Liblist
641
642 Determine libraries to use and how to use them
643
644 =item ExtUtils::MM
645
646 OS adjusted ExtUtils::MakeMaker subclass
647
648 =item ExtUtils::MM_AIX
649
650 AIX specific subclass of ExtUtils::MM_Unix
651
652 =item ExtUtils::MM_Any
653
654 Platform-agnostic MM methods
655
656 =item ExtUtils::MM_BeOS
657
658 Methods to override UN*X behaviour in ExtUtils::MakeMaker
659
660 =item ExtUtils::MM_Cygwin
661
662 Methods to override UN*X behaviour in ExtUtils::MakeMaker
663
664 =item ExtUtils::MM_DOS
665
666 DOS specific subclass of ExtUtils::MM_Unix
667
668 =item ExtUtils::MM_MacOS
669
670 Once produced Makefiles for MacOS Classic
671
672 =item ExtUtils::MM_NW5
673
674 Methods to override UN*X behaviour in ExtUtils::MakeMaker
675
676 =item ExtUtils::MM_OS2
677
678 Methods to override UN*X behaviour in ExtUtils::MakeMaker
679
680 =item ExtUtils::MM_QNX
681
682 QNX specific subclass of ExtUtils::MM_Unix
683
684 =item ExtUtils::MM_UWIN
685
686 U/WIN specific subclass of ExtUtils::MM_Unix
687
688 =item ExtUtils::MM_Unix
689
690 Methods used by ExtUtils::MakeMaker
691
692 =item ExtUtils::MM_VMS
693
694 Methods to override UN*X behaviour in ExtUtils::MakeMaker
695
696 =item ExtUtils::MM_VOS
697
698 VOS specific subclass of ExtUtils::MM_Unix
699
700 =item ExtUtils::MM_Win32
701
702 Methods to override UN*X behaviour in ExtUtils::MakeMaker
703
704 =item ExtUtils::MM_Win95
705
706 Method to customize MakeMaker for Win9X
707
708 =item ExtUtils::MY
709
710 ExtUtils::MakeMaker subclass for customization
711
712 =item ExtUtils::MakeMaker
713
714 Create a module Makefile
715
716 =item ExtUtils::MakeMaker::Config
717
718 Wrapper around Config.pm
719
720 =item ExtUtils::MakeMaker::FAQ
721
722 Frequently Asked Questions About MakeMaker
723
724 =item ExtUtils::MakeMaker::Tutorial
725
726 Writing a module with MakeMaker
727
728 =item ExtUtils::MakeMaker::bytes
729
730 Version-agnostic bytes.pm
731
732 =item ExtUtils::MakeMaker::vmsish
733
734 Platform-agnostic vmsish.pm
735
736 =item ExtUtils::Manifest
737
738 Utilities to write and check a MANIFEST file
739
740 =item ExtUtils::Mkbootstrap
741
742 Make a bootstrap file for use by DynaLoader
743
744 =item ExtUtils::Mksymlists
745
746 Write linker options files for dynamic extension
747
748 =item ExtUtils::Packlist
749
750 Manage .packlist files
751
752 =item ExtUtils::ParseXS
753
754 Converts Perl XS code into C code
755
756 =item ExtUtils::testlib
757
758 Add blib/* directories to @INC
759
760 =item Fatal
761
762 Replace functions with equivalents which succeed or die
763
764 =item Fcntl
765
766 Load the C Fcntl.h defines
767
768 =item File::Basename
769
770 Parse file paths into directory, filename and suffix.
771
772 =item File::CheckTree
773
774 Run many filetest checks on a tree
775
776 =item File::Compare
777
778 Compare files or filehandles
779
780 =item File::Copy
781
782 Copy files or filehandles
783
784 =item File::DosGlob
785
786 DOS like globbing and then some
787
788 =item File::Fetch
789
790 A generic file fetching mechanism
791
792 =item File::Find
793
794 Traverse a directory tree.
795
796 =item File::Glob
797
798 Perl extension for BSD glob routine
799
800 =item File::GlobMapper
801
802 Extend File Glob to Allow Input and Output Files
803
804 =item File::Path
805
806 Create or remove directory trees
807
808 =item File::Spec
809
810 Portably perform operations on file names
811
812 =item File::Spec::Cygwin
813
814 Methods for Cygwin file specs
815
816 =item File::Spec::Epoc
817
818 Methods for Epoc file specs
819
820 =item File::Spec::Functions
821
822 Portably perform operations on file names
823
824 =item File::Spec::Mac
825
826 File::Spec for Mac OS (Classic)
827
828 =item File::Spec::OS2
829
830 Methods for OS/2 file specs
831
832 =item File::Spec::Unix
833
834 File::Spec for Unix, base for other File::Spec modules
835
836 =item File::Spec::VMS
837
838 Methods for VMS file specs
839
840 =item File::Spec::Win32
841
842 Methods for Win32 file specs
843
844 =item File::Temp
845
846 Return name and handle of a temporary file safely
847
848 =item File::stat
849
850 By-name interface to Perl's built-in stat() functions
851
852 =item FileCache
853
854 Keep more files open than the system permits
855
856 =item FileHandle
857
858 Supply object methods for filehandles
859
860 =item Filter::Simple
861
862 Simplified source filtering
863
864 =item Filter::Util::Call
865
866 Perl Source Filter Utility Module
867
868 =item FindBin
869
870 Locate directory of original perl script
871
872 =item GDBM_File
873
874 Perl5 access to the gdbm library.
875
876 =item Getopt::Long
877
878 Extended processing of command line options
879
880 =item Getopt::Std
881
882 Process single-character switches with switch clustering
883
884 =item Hash::Util
885
886 A selection of general-utility hash subroutines
887
888 =item Hash::Util::FieldHash
889
890 Support for Inside-Out Classes
891
892 =item I18N::Collate
893
894 Compare 8-bit scalar data according to the current locale
895
896 =item I18N::LangTags
897
898 Functions for dealing with RFC3066-style language tags
899
900 =item I18N::LangTags::Detect
901
902 Detect the user's language preferences
903
904 =item I18N::LangTags::List
905
906 Tags and names for human languages
907
908 =item I18N::Langinfo
909
910 Query locale information
911
912 =item IO
913
914 Load various IO modules
915
916 =item IO::Compress::Base
917
918 Base Class for IO::Compress modules 
919
920 =item IO::Compress::Deflate
921
922 Write RFC 1950 files/buffers
923
924 =item IO::Compress::Gzip
925
926 Write RFC 1952 files/buffers
927
928 =item IO::Compress::RawDeflate
929
930 Write RFC 1951 files/buffers
931
932 =item IO::Compress::Zip
933
934 Write zip files/buffers
935
936 =item IO::Dir
937
938 Supply object methods for directory handles
939
940 =item IO::File
941
942 Supply object methods for filehandles
943
944 =item IO::Handle
945
946 Supply object methods for I/O handles
947
948 =item IO::Pipe
949
950 Supply object methods for pipes
951
952 =item IO::Poll
953
954 Object interface to system poll call
955
956 =item IO::Seekable
957
958 Supply seek based methods for I/O objects
959
960 =item IO::Select
961
962 OO interface to the select system call
963
964 =item IO::Socket
965
966 Object interface to socket communications
967
968 =item IO::Socket::INET
969
970 Object interface for AF_INET domain sockets
971
972 =item IO::Socket::UNIX
973
974 Object interface for AF_UNIX domain sockets
975
976 =item IO::Uncompress::AnyInflate
977
978 Uncompress zlib-based (zip, gzip) file/buffer
979
980 =item IO::Uncompress::AnyUncompress
981
982 Uncompress gzip, zip, bzip2 or lzop file/buffer
983
984 =item IO::Uncompress::Base
985
986 Base Class for IO::Uncompress modules 
987
988 =item IO::Uncompress::Gunzip
989
990 Read RFC 1952 files/buffers
991
992 =item IO::Uncompress::Inflate
993
994 Read RFC 1950 files/buffers
995
996 =item IO::Uncompress::RawInflate
997
998 Read RFC 1951 files/buffers
999
1000 =item IO::Uncompress::Unzip
1001
1002 Read zip files/buffers
1003
1004 =item IO::Zlib
1005
1006 IO:: style interface to L<Compress::Zlib>
1007
1008 =item IPC::Cmd
1009
1010 Finding and running system commands made easy
1011
1012 =item IPC::Open2
1013
1014 Open a process for both reading and writing
1015
1016 =item IPC::Open3
1017
1018 Open a process for reading, writing, and error handling
1019
1020 =item IPC::SysV
1021
1022 SysV IPC constants
1023
1024 =item IPC::SysV::Msg
1025
1026 SysV Msg IPC object class
1027
1028 =item IPC::SysV::Semaphore
1029
1030 SysV Semaphore IPC object class
1031
1032 =item List::Util
1033
1034 A selection of general-utility list subroutines
1035
1036 =item Locale::Constants
1037
1038 Constants for Locale codes
1039
1040 =item Locale::Country
1041
1042 ISO codes for country identification (ISO 3166)
1043
1044 =item Locale::Currency
1045
1046 ISO three letter codes for currency identification (ISO 4217)
1047
1048 =item Locale::Language
1049
1050 ISO two letter codes for language identification (ISO 639)
1051
1052 =item Locale::Maketext
1053
1054 Framework for localization
1055
1056 =item Locale::Maketext::Simple
1057
1058 Simple interface to Locale::Maketext::Lexicon
1059
1060 =item Locale::Maketext::TPJ13
1061
1062 Article about software localization
1063
1064 =item Locale::Script
1065
1066 ISO codes for script identification (ISO 15924)
1067
1068 =item Log::Message
1069
1070 A generic message storing mechanism;
1071
1072 =item Log::Message::Config
1073
1074 Configuration options for Log::Message
1075
1076 =item Log::Message::Handlers
1077
1078 Message handlers for Log::Message
1079
1080 =item Log::Message::Item
1081
1082 Message objects for Log::Message
1083
1084 =item MIME::Base64
1085
1086 Encoding and decoding of base64 strings
1087
1088 =item MIME::Base64::QuotedPrint
1089
1090 Encoding and decoding of quoted-printable strings
1091
1092 =item Math::BigFloat
1093
1094 Arbitrary size floating point math package
1095
1096 =item Math::BigInt
1097
1098 Arbitrary size integer/float math package
1099
1100 =item Math::BigInt::Calc
1101
1102 Pure Perl module to support Math::BigInt
1103
1104 =item Math::BigInt::CalcEmu
1105
1106 Emulate low-level math with BigInt code
1107
1108 =item Math::BigInt::FastCalc
1109
1110 Math::BigInt::Calc with some XS for more speed
1111
1112 =item Math::BigRat
1113
1114 Arbitrary big rational numbers
1115
1116 =item Math::Complex
1117
1118 Complex numbers and associated mathematical functions
1119
1120 =item Math::Trig
1121
1122 Trigonometric functions
1123
1124 =item Memoize
1125
1126 Make functions faster by trading space for time
1127
1128 =item Memoize::AnyDBM_File
1129
1130 Glue to provide EXISTS for AnyDBM_File for Storable use
1131
1132 =item Memoize::Expire
1133
1134 Plug-in module for automatic expiration of memoized values
1135
1136 =item Memoize::ExpireFile
1137
1138 Test for Memoize expiration semantics
1139
1140 =item Memoize::ExpireTest
1141
1142 Test for Memoize expiration semantics
1143
1144 =item Memoize::NDBM_File
1145
1146 Glue to provide EXISTS for NDBM_File for Storable use
1147
1148 =item Memoize::SDBM_File
1149
1150 Glue to provide EXISTS for SDBM_File for Storable use
1151
1152 =item Memoize::Storable
1153
1154 Store Memoized data in Storable database
1155
1156 =item Module::Build
1157
1158 Build and install Perl modules
1159
1160 =item Module::Build::API
1161
1162 API Reference for Module Authors
1163
1164 =item Module::Build::Authoring
1165
1166 Authoring Module::Build modules
1167
1168 =item Module::Build::Base
1169
1170 Default methods for Module::Build
1171
1172 =item Module::Build::Compat
1173
1174 Compatibility with ExtUtils::MakeMaker
1175
1176 =item Module::Build::ConfigData
1177
1178 Configuration for Module::Build
1179
1180 =item Module::Build::Cookbook
1181
1182 Examples of Module::Build Usage
1183
1184 =item Module::Build::ModuleInfo
1185
1186 Gather package and POD information from a perl module files
1187
1188 =item Module::Build::Notes
1189
1190 Configuration for $module_name
1191
1192 =item Module::Build::PPMMaker
1193
1194 Perl Package Manager file creation
1195
1196 =item Module::Build::Platform::Amiga
1197
1198 Builder class for Amiga platforms
1199
1200 =item Module::Build::Platform::Default
1201
1202 Stub class for unknown platforms
1203
1204 =item Module::Build::Platform::EBCDIC
1205
1206 Builder class for EBCDIC platforms
1207
1208 =item Module::Build::Platform::MPEiX
1209
1210 Builder class for MPEiX platforms
1211
1212 =item Module::Build::Platform::MacOS
1213
1214 Builder class for MacOS platforms
1215
1216 =item Module::Build::Platform::RiscOS
1217
1218 Builder class for RiscOS platforms
1219
1220 =item Module::Build::Platform::Unix
1221
1222 Builder class for Unix platforms
1223
1224 =item Module::Build::Platform::VMS
1225
1226 Builder class for VMS platforms
1227
1228 =item Module::Build::Platform::VOS
1229
1230 Builder class for VOS platforms
1231
1232 =item Module::Build::Platform::Windows
1233
1234 Builder class for Windows platforms
1235
1236 =item Module::Build::Platform::aix
1237
1238 Builder class for AIX platform
1239
1240 =item Module::Build::Platform::cygwin
1241
1242 Builder class for Cygwin platform
1243
1244 =item Module::Build::Platform::darwin
1245
1246 Builder class for Mac OS X platform
1247
1248 =item Module::Build::Platform::os2
1249
1250 Builder class for OS/2 platform
1251
1252 =item Module::Build::YAML
1253
1254 Provides just enough YAML support so that Module::Build works even if YAML.pm is not installed
1255
1256 =item Module::CoreList
1257
1258 What modules shipped with versions of perl
1259
1260 =item Module::Load
1261
1262 Runtime require of both modules and files
1263
1264 =item Module::Load::Conditional
1265
1266 Looking up module information / loading at runtime
1267
1268 =item Module::Loaded
1269
1270 Mark modules as loaded or unloaded
1271
1272 =item Module::Pluggable
1273
1274 Automatically give your module the ability to have plugins
1275
1276 =item Module::Pluggable::Object
1277
1278 Automatically give your module the ability to have plugins
1279
1280 =item NDBM_File
1281
1282 Tied access to ndbm files
1283
1284 =item NEXT
1285
1286 Provide a pseudo-class NEXT (et al) that allows method redispatch
1287
1288 =item Net::Cmd
1289
1290 Network Command class (as used by FTP, SMTP etc)
1291
1292 =item Net::Config
1293
1294 Local configuration data for libnet
1295
1296 =item Net::Domain
1297
1298 Attempt to evaluate the current host's internet name and domain
1299
1300 =item Net::FTP
1301
1302 FTP Client class
1303
1304 =item Net::NNTP
1305
1306 NNTP Client class
1307
1308 =item Net::Netrc
1309
1310 OO interface to users netrc file
1311
1312 =item Net::POP3
1313
1314 Post Office Protocol 3 Client class (RFC1939)
1315
1316 =item Net::Ping
1317
1318 Check a remote host for reachability
1319
1320 =item Net::SMTP
1321
1322 Simple Mail Transfer Protocol Client
1323
1324 =item Net::Time
1325
1326 Time and daytime network client interface
1327
1328 =item Net::hostent
1329
1330 By-name interface to Perl's built-in gethost*() functions
1331
1332 =item Net::libnetFAQ
1333
1334 Libnet Frequently Asked Questions
1335
1336 =item Net::netent
1337
1338 By-name interface to Perl's built-in getnet*() functions
1339
1340 =item Net::protoent
1341
1342 By-name interface to Perl's built-in getproto*() functions
1343
1344 =item Net::servent
1345
1346 By-name interface to Perl's built-in getserv*() functions
1347
1348 =item O
1349
1350 Generic interface to Perl Compiler backends
1351
1352 =item ODBM_File
1353
1354 Tied access to odbm files
1355
1356 =item Opcode
1357
1358 Disable named opcodes when compiling perl code
1359
1360 =item POSIX
1361
1362 Perl interface to IEEE Std 1003.1
1363
1364 =item Package::Constants
1365
1366 List all constants declared in a package
1367
1368 =item Params::Check
1369
1370 A generic input parsing/checking mechanism.
1371
1372 =item PerlIO
1373
1374 On demand loader for PerlIO layers and root of PerlIO::* name space
1375
1376 =item PerlIO::encoding
1377
1378 Encoding layer
1379
1380 =item PerlIO::scalar
1381
1382 In-memory IO, scalar IO
1383
1384 =item PerlIO::via
1385
1386 Helper class for PerlIO layers implemented in perl
1387
1388 =item PerlIO::via::QuotedPrint
1389
1390 PerlIO layer for quoted-printable strings
1391
1392 =item Pod::Checker
1393
1394 Check pod documents for syntax errors
1395
1396 =item Pod::Escapes
1397
1398 For resolving Pod EE<lt>...E<gt> sequences
1399
1400 =item Pod::Find
1401
1402 Find POD documents in directory trees
1403
1404 =item Pod::Functions
1405
1406 Group Perl's functions a la perlfunc.pod
1407
1408 =item Pod::Html
1409
1410 Module to convert pod files to HTML
1411
1412 =item Pod::InputObjects
1413
1414 Objects representing POD input paragraphs, commands, etc.
1415
1416 =item Pod::LaTeX
1417
1418 Convert Pod data to formatted Latex
1419
1420 =item Pod::Man
1421
1422 Convert POD data to formatted *roff input
1423
1424 =item Pod::ParseLink
1425
1426 Parse an LE<lt>E<gt> formatting code in POD text
1427
1428 =item Pod::ParseUtils
1429
1430 Helpers for POD parsing and conversion
1431
1432 =item Pod::Parser
1433
1434 Base class for creating POD filters and translators
1435
1436 =item Pod::Perldoc::ToChecker
1437
1438 Let Perldoc check Pod for errors
1439
1440 =item Pod::Perldoc::ToMan
1441
1442 Let Perldoc render Pod as man pages
1443
1444 =item Pod::Perldoc::ToNroff
1445
1446 Let Perldoc convert Pod to nroff
1447
1448 =item Pod::Perldoc::ToPod
1449
1450 Let Perldoc render Pod as ... Pod!
1451
1452 =item Pod::Perldoc::ToRtf
1453
1454 Let Perldoc render Pod as RTF
1455
1456 =item Pod::Perldoc::ToText
1457
1458 Let Perldoc render Pod as plaintext
1459
1460 =item Pod::Perldoc::ToTk
1461
1462 Let Perldoc use Tk::Pod to render Pod
1463
1464 =item Pod::Perldoc::ToXml
1465
1466 Let Perldoc render Pod as XML
1467
1468 =item Pod::PlainText
1469
1470 Convert POD data to formatted ASCII text
1471
1472 =item Pod::Plainer
1473
1474 Perl extension for converting Pod to old style Pod.
1475
1476 =item Pod::Select
1477
1478 Extract selected sections of POD from input
1479
1480 =item Pod::Simple
1481
1482 Framework for parsing Pod
1483
1484 =item Pod::Simple::Checker
1485
1486 Check the Pod syntax of a document
1487
1488 =item Pod::Simple::Debug
1489
1490 Put Pod::Simple into trace/debug mode
1491
1492 =item Pod::Simple::DumpAsText
1493
1494 Dump Pod-parsing events as text
1495
1496 =item Pod::Simple::DumpAsXML
1497
1498 Turn Pod into XML
1499
1500 =item Pod::Simple::HTML
1501
1502 Convert Pod to HTML
1503
1504 =item Pod::Simple::HTMLBatch
1505
1506 Convert several Pod files to several HTML files
1507
1508 =item Pod::Simple::LinkSection
1509
1510 Represent "section" attributes of L codes
1511
1512 =item Pod::Simple::Methody
1513
1514 Turn Pod::Simple events into method calls
1515
1516 =item Pod::Simple::PullParser
1517
1518 A pull-parser interface to parsing Pod
1519
1520 =item Pod::Simple::PullParserEndToken
1521
1522 End-tokens from Pod::Simple::PullParser
1523
1524 =item Pod::Simple::PullParserStartToken
1525
1526 Start-tokens from Pod::Simple::PullParser
1527
1528 =item Pod::Simple::PullParserTextToken
1529
1530 Text-tokens from Pod::Simple::PullParser
1531
1532 =item Pod::Simple::PullParserToken
1533
1534 Tokens from Pod::Simple::PullParser
1535
1536 =item Pod::Simple::RTF
1537
1538 Format Pod as RTF
1539
1540 =item Pod::Simple::Search
1541
1542 Find POD documents in directory trees
1543
1544 =item Pod::Simple::SimpleTree
1545
1546 Parse Pod into a simple parse tree 
1547
1548 =item Pod::Simple::Subclassing
1549
1550 Write a formatter as a Pod::Simple subclass
1551
1552 =item Pod::Simple::Text
1553
1554 Format Pod as plaintext
1555
1556 =item Pod::Simple::TextContent
1557
1558 Get the text content of Pod
1559
1560 =item Pod::Simple::XMLOutStream
1561
1562 Turn Pod into XML
1563
1564 =item Pod::Text
1565
1566 Convert POD data to formatted ASCII text
1567
1568 =item Pod::Text::Color
1569
1570 Convert POD data to formatted color ASCII text
1571
1572 =item Pod::Text::Overstrike
1573
1574 Convert POD data to formatted overstrike text
1575
1576 =item Pod::Text::Termcap
1577
1578 Convert POD data to ASCII text with format escapes
1579
1580 =item Pod::Usage
1581
1582 Print a usage message from embedded pod documentation
1583
1584 =item SDBM_File
1585
1586 Tied access to sdbm files
1587
1588 =item Safe
1589
1590 Compile and execute code in restricted compartments
1591
1592 =item Scalar::Util
1593
1594 A selection of general-utility scalar subroutines
1595
1596 =item Search::Dict
1597
1598 Search for key in dictionary file
1599
1600 =item SelectSaver
1601
1602 Save and restore selected file handle
1603
1604 =item SelfLoader
1605
1606 Load functions only on demand
1607
1608 =item Shell
1609
1610 Run shell commands transparently within perl
1611
1612 =item Socket
1613
1614 Load the C socket.h defines and structure manipulators 
1615
1616 =item Storable
1617
1618 Persistence for Perl data structures
1619
1620 =item Switch
1621
1622 A switch statement for Perl
1623
1624 =item Symbol
1625
1626 Manipulate Perl symbols and their names
1627
1628 =item Sys::Hostname
1629
1630 Try every conceivable way to get hostname
1631
1632 =item Sys::Syslog
1633
1634 Perl interface to the UNIX syslog(3) calls
1635
1636 =item Term::ANSIColor
1637
1638 Color screen output using ANSI escape sequences
1639
1640 =item Term::Cap
1641
1642 Perl termcap interface
1643
1644 =item Term::Complete
1645
1646 Perl word completion module
1647
1648 =item Term::ReadLine
1649
1650 Perl interface to various C<readline> packages.
1651
1652 =item Term::UI
1653
1654 Term::ReadLine UI made easy
1655
1656 =item Test
1657
1658 Provides a simple framework for writing test scripts
1659
1660 =item Test::Builder
1661
1662 Backend for building test libraries
1663
1664 =item Test::Builder::Module
1665
1666 Base class for test modules
1667
1668 =item Test::Builder::Tester
1669
1670 Test testsuites that have been built with
1671
1672 =item Test::Builder::Tester::Color
1673
1674 Turn on colour in Test::Builder::Tester
1675
1676 =item Test::Harness
1677
1678 Run Perl standard test scripts with statistics
1679
1680 =item Test::Harness::Assert
1681
1682 Simple assert
1683
1684 =item Test::Harness::Iterator
1685
1686 Internal Test::Harness Iterator
1687
1688 =item Test::Harness::Point
1689
1690 Object for tracking a single test point
1691
1692 =item Test::Harness::Results
1693
1694 Object for tracking results from a single test file
1695
1696 =item Test::Harness::Straps
1697
1698 Detailed analysis of test results
1699
1700 =item Test::Harness::TAP
1701
1702 Documentation for the TAP format
1703
1704 =item Test::Harness::Util
1705
1706 Utility functions for Test::Harness::*
1707
1708 =item Test::More
1709
1710 Yet another framework for writing test scripts
1711
1712 =item Test::Simple
1713
1714 Basic utilities for writing tests.
1715
1716 =item Test::Tutorial
1717
1718 A tutorial about writing really basic tests
1719
1720 =item Text::Abbrev
1721
1722 Create an abbreviation table from a list
1723
1724 =item Text::Balanced
1725
1726 Extract delimited text sequences from strings.
1727
1728 =item Text::ParseWords
1729
1730 Parse text into an array of tokens or array of arrays
1731
1732 =item Text::Soundex
1733
1734 Implementation of the Soundex Algorithm as Described by Knuth
1735
1736 =item Text::Tabs
1737
1738 Expand and unexpand tabs per the unix expand(1) and unexpand(1)
1739
1740 =item Text::Wrap
1741
1742 Line wrapping to form simple paragraphs
1743
1744 =item Thread
1745
1746 Manipulate threads in Perl (for old code only)
1747
1748 =item Thread::Queue
1749
1750 Thread-safe queues
1751
1752 =item Thread::Semaphore
1753
1754 Thread-safe semaphores
1755
1756 =item Tie::Array
1757
1758 Base class for tied arrays
1759
1760 =item Tie::File
1761
1762 Access the lines of a disk file via a Perl array
1763
1764 =item Tie::Handle
1765
1766 Base class definitions for tied handles
1767
1768 =item Tie::Hash
1769
1770 Base class definitions for tied hashes
1771
1772 =item Tie::Hash::NamedCapture
1773
1774 Named regexp capture buffers
1775
1776 =item Tie::Memoize
1777
1778 Add data to hash when needed
1779
1780 =item Tie::RefHash
1781
1782 Use references as hash keys
1783
1784 =item Tie::Scalar
1785
1786 Base class definitions for tied scalars
1787
1788 =item Tie::SubstrHash
1789
1790 Fixed-table-size, fixed-key-length hashing
1791
1792 =item Time::HiRes
1793
1794 High resolution alarm, sleep, gettimeofday, interval timers
1795
1796 =item Time::Local
1797
1798 Efficiently compute time from local and GMT time
1799
1800 =item Time::Piece
1801
1802 Object Oriented time objects
1803
1804 =item Time::Piece::Seconds
1805
1806 A simple API to convert seconds to other date values
1807
1808 =item Time::gmtime
1809
1810 By-name interface to Perl's built-in gmtime() function
1811
1812 =item Time::localtime
1813
1814 By-name interface to Perl's built-in localtime() function
1815
1816 =item Time::tm
1817
1818 Internal object used by Time::gmtime and Time::localtime
1819
1820 =item UNIVERSAL
1821
1822 Base class for ALL classes (blessed references)
1823
1824 =item Unicode::Collate
1825
1826 Unicode Collation Algorithm
1827
1828 =item Unicode::Normalize
1829
1830 Unicode Normalization Forms
1831
1832 =item Unicode::UCD
1833
1834 Unicode character database
1835
1836 =item User::grent
1837
1838 By-name interface to Perl's built-in getgr*() functions
1839
1840 =item User::pwent
1841
1842 By-name interface to Perl's built-in getpw*() functions
1843
1844 =item Win32
1845
1846 Interfaces to some Win32 API Functions
1847
1848 =item Win32API::File
1849
1850 Low-level access to Win32 system API calls for files/dirs.
1851
1852 =item XS::APItest
1853
1854 Test the perl C API
1855
1856 =item XS::Typemap
1857
1858 Module to test the XS typemaps distributed with perl
1859
1860 =item XSLoader
1861
1862 Dynamically load C libraries into Perl code
1863
1864 =back
1865
1866 To find out I<all> modules installed on your system, including
1867 those without documentation or outside the standard release,
1868 just use the following command (under the default win32 shell,
1869 double quotes should be used instead of single quotes).
1870
1871     % perl -MFile::Find=find -MFile::Spec::Functions -Tlwe \
1872       'find { wanted => sub { print canonpath $_ if /\.pm\z/ },
1873       no_chdir => 1 }, @INC'
1874
1875 (The -T is here to prevent '.' from being listed in @INC.)
1876 They should all have their own documentation installed and accessible
1877 via your system man(1) command.  If you do not have a B<find>
1878 program, you can use the Perl B<find2perl> program instead, which
1879 generates Perl code as output you can run through perl.  If you
1880 have a B<man> program but it doesn't find your modules, you'll have
1881 to fix your manpath.  See L<perl> for details.  If you have no
1882 system B<man> command, you might try the B<perldoc> program.
1883
1884 Note also that the command C<perldoc perllocal> gives you a (possibly
1885 incomplete) list of the modules that have been further installed on
1886 your system. (The perllocal.pod file is updated by the standard MakeMaker
1887 install process.)
1888
1889 =head2 Extension Modules
1890
1891 Extension modules are written in C (or a mix of Perl and C).  They
1892 are usually dynamically loaded into Perl if and when you need them,
1893 but may also be linked in statically.  Supported extension modules
1894 include Socket, Fcntl, and POSIX.
1895
1896 Many popular C extension modules do not come bundled (at least, not
1897 completely) due to their sizes, volatility, or simply lack of time
1898 for adequate testing and configuration across the multitude of
1899 platforms on which Perl was beta-tested.  You are encouraged to
1900 look for them on CPAN (described below), or using web search engines
1901 like Alta Vista or Google.
1902
1903 =head1 CPAN
1904
1905 CPAN stands for Comprehensive Perl Archive Network; it's a globally
1906 replicated trove of Perl materials, including documentation, style
1907 guides, tricks and traps, alternate ports to non-Unix systems and
1908 occasional binary distributions for these.   Search engines for
1909 CPAN can be found at http://www.cpan.org/
1910
1911 Most importantly, CPAN includes around a thousand unbundled modules,
1912 some of which require a C compiler to build.  Major categories of
1913 modules are:
1914
1915 =over
1916
1917 =item *
1918
1919 Language Extensions and Documentation Tools
1920
1921 =item *
1922
1923 Development Support
1924
1925 =item *
1926
1927 Operating System Interfaces
1928
1929 =item *
1930
1931 Networking, Device Control (modems) and InterProcess Communication
1932
1933 =item *
1934
1935 Data Types and Data Type Utilities
1936
1937 =item *
1938
1939 Database Interfaces
1940
1941 =item *
1942
1943 User Interfaces
1944
1945 =item *
1946
1947 Interfaces to / Emulations of Other Programming Languages
1948
1949 =item *
1950
1951 File Names, File Systems and File Locking (see also File Handles)
1952
1953 =item *
1954
1955 String Processing, Language Text Processing, Parsing, and Searching
1956
1957 =item *
1958
1959 Option, Argument, Parameter, and Configuration File Processing
1960
1961 =item *
1962
1963 Internationalization and Locale
1964
1965 =item *
1966
1967 Authentication, Security, and Encryption
1968
1969 =item *
1970
1971 World Wide Web, HTML, HTTP, CGI, MIME
1972
1973 =item *
1974
1975 Server and Daemon Utilities
1976
1977 =item *
1978
1979 Archiving and Compression
1980
1981 =item *
1982
1983 Images, Pixmap and Bitmap Manipulation, Drawing, and Graphing
1984
1985 =item *
1986
1987 Mail and Usenet News
1988
1989 =item *
1990
1991 Control Flow Utilities (callbacks and exceptions etc)
1992
1993 =item *
1994
1995 File Handle and Input/Output Stream Utilities
1996
1997 =item *
1998
1999 Miscellaneous Modules
2000
2001 =back
2002
2003 The list of the registered CPAN sites as of this writing follows.
2004 Please note that the sorting order is alphabetical on fields:
2005
2006 Continent
2007    |
2008    |-->Country
2009          |
2010          |-->[state/province]
2011                    |
2012                    |-->ftp
2013                    |
2014                    |-->[http]
2015
2016 and thus the North American servers happen to be listed between the
2017 European and the South American sites.
2018
2019 You should try to choose one close to you.
2020
2021 =head2 Africa
2022
2023 =over 4
2024
2025 =item South Africa
2026
2027                       http://ftp.rucus.ru.ac.za/pub/perl/CPAN/
2028                       ftp://ftp.rucus.ru.ac.za/pub/perl/CPAN/
2029                       ftp://ftp.is.co.za/programming/perl/CPAN/
2030                       ftp://ftp.saix.net/pub/CPAN/
2031                       ftp://ftp.sun.ac.za/CPAN/CPAN/
2032
2033 =back
2034
2035 =head2 Asia
2036
2037 =over 4
2038
2039 =item China
2040
2041                       http://cpan.linuxforum.net/
2042                       http://cpan.shellhung.org/
2043                       ftp://ftp.shellhung.org/pub/CPAN
2044                       ftp://mirrors.hknet.com/CPAN
2045
2046 =item Indonesia
2047
2048                       http://mirrors.tf.itb.ac.id/cpan/
2049                       http://cpan.cbn.net.id/
2050                       ftp://ftp.cbn.net.id/mirror/CPAN
2051
2052 =item Israel
2053
2054                       ftp://ftp.iglu.org.il/pub/CPAN/
2055                       http://cpan.lerner.co.il/
2056                       http://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
2057                       ftp://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
2058
2059 =item Japan
2060
2061                       ftp://ftp.u-aizu.ac.jp/pub/CPAN
2062                       ftp://ftp.kddlabs.co.jp/CPAN/
2063                       ftp://ftp.ayamura.org/pub/CPAN/
2064                       ftp://ftp.jaist.ac.jp/pub/lang/perl/CPAN/
2065                       http://ftp.cpan.jp/
2066                       ftp://ftp.cpan.jp/CPAN/
2067                       ftp://ftp.dti.ad.jp/pub/lang/CPAN/
2068                       ftp://ftp.ring.gr.jp/pub/lang/perl/CPAN/
2069
2070 =item Malaysia
2071
2072                       http://cpan.MyBSD.org.my
2073                       http://mirror.leafbug.org/pub/CPAN
2074                       http://ossig.mncc.com.my/mirror/pub/CPAN
2075
2076 =item Russian Federation
2077
2078                       http://cpan.tomsk.ru
2079                       ftp://cpan.tomsk.ru/
2080
2081 =item Saudi Arabia
2082
2083                       ftp://ftp.isu.net.sa/pub/CPAN/
2084
2085 =item Singapore
2086
2087                       http://CPAN.en.com.sg/
2088                       ftp://cpan.en.com.sg/
2089                       http://mirror.averse.net/pub/CPAN
2090                       ftp://mirror.averse.net/pub/CPAN
2091                       http://cpan.oss.eznetsols.org
2092                       ftp://ftp.oss.eznetsols.org/cpan
2093
2094 =item South Korea
2095
2096                       http://CPAN.bora.net/
2097                       ftp://ftp.bora.net/pub/CPAN/
2098                       http://mirror.kr.FreeBSD.org/CPAN
2099                       ftp://ftp.kr.FreeBSD.org/pub/CPAN
2100
2101 =item Taiwan
2102
2103                       ftp://ftp.nctu.edu.tw/UNIX/perl/CPAN
2104                       http://cpan.cdpa.nsysu.edu.tw/
2105                       ftp://cpan.cdpa.nsysu.edu.tw/pub/CPAN
2106                       http://ftp.isu.edu.tw/pub/CPAN
2107                       ftp://ftp.isu.edu.tw/pub/CPAN
2108                       ftp://ftp1.sinica.edu.tw/pub1/perl/CPAN/
2109                       http://ftp.tku.edu.tw/pub/CPAN/
2110                       ftp://ftp.tku.edu.tw/pub/CPAN/
2111
2112 =item Thailand
2113
2114                       ftp://ftp.loxinfo.co.th/pub/cpan/
2115                       ftp://ftp.cs.riubon.ac.th/pub/mirrors/CPAN/
2116
2117 =back
2118
2119 =head2 Central America
2120
2121 =over 4
2122
2123 =item Costa Rica
2124
2125                       http://ftp.ucr.ac.cr/Unix/CPAN/
2126                       ftp://ftp.ucr.ac.cr/pub/Unix/CPAN/
2127
2128 =back
2129
2130 =head2 Europe
2131
2132 =over 4
2133
2134 =item Austria
2135
2136                       http://cpan.inode.at/
2137                       ftp://cpan.inode.at
2138                       ftp://ftp.tuwien.ac.at/pub/CPAN/
2139
2140 =item Belgium
2141
2142                       http://ftp.easynet.be/pub/CPAN/
2143                       ftp://ftp.easynet.be/pub/CPAN/
2144                       http://cpan.skynet.be
2145                       ftp://ftp.cpan.skynet.be/pub/CPAN
2146                       ftp://ftp.kulnet.kuleuven.ac.be/pub/mirror/CPAN/
2147
2148 =item Bosnia and Herzegovina
2149
2150                       http://cpan.blic.net/
2151
2152 =item Bulgaria
2153
2154                       http://cpan.online.bg
2155                       ftp://cpan.online.bg/cpan
2156                       http://cpan.zadnik.org
2157                       ftp://ftp.zadnik.org/mirrors/CPAN/
2158                       http://cpan.lirex.net/
2159                       ftp://ftp.lirex.net/pub/mirrors/CPAN
2160
2161 =item Croatia
2162
2163                       http://ftp.linux.hr/pub/CPAN/
2164                       ftp://ftp.linux.hr/pub/CPAN/
2165
2166 =item Czech Republic
2167
2168                       ftp://ftp.fi.muni.cz/pub/CPAN/
2169                       ftp://sunsite.mff.cuni.cz/MIRRORS/ftp.funet.fi/pub/languages/perl/CPAN/
2170
2171 =item Denmark
2172
2173                       http://mirrors.sunsite.dk/cpan/
2174                       ftp://sunsite.dk/mirrors/cpan/
2175                       http://cpan.cybercity.dk
2176                       http://www.cpan.dk/CPAN/
2177                       ftp://www.cpan.dk/ftp.cpan.org/CPAN/
2178
2179 =item Estonia
2180
2181                       ftp://ftp.ut.ee/pub/languages/perl/CPAN/
2182
2183 =item Finland
2184
2185                       ftp://ftp.funet.fi/pub/languages/perl/CPAN/
2186                       http://mirror.eunet.fi/CPAN
2187
2188 =item France
2189
2190                       http://www.enstimac.fr/Perl/CPAN
2191                       http://ftp.u-paris10.fr/perl/CPAN
2192                       ftp://ftp.u-paris10.fr/perl/CPAN
2193                       http://cpan.mirrors.easynet.fr/
2194                       ftp://cpan.mirrors.easynet.fr/pub/ftp.cpan.org/
2195                       ftp://ftp.club-internet.fr/pub/perl/CPAN/
2196                       http://fr.cpan.org/
2197                       ftp://ftp.lip6.fr/pub/perl/CPAN/
2198                       ftp://ftp.oleane.net/pub/mirrors/CPAN/
2199                       ftp://ftp.pasteur.fr/pub/computing/CPAN/
2200                       http://mir2.ovh.net/ftp.cpan.org
2201                       ftp://mir1.ovh.net/ftp.cpan.org
2202                       http://ftp.crihan.fr/mirrors/ftp.cpan.org/
2203                       ftp://ftp.crihan.fr/mirrors/ftp.cpan.org/
2204                       http://ftp.u-strasbg.fr/CPAN
2205                       ftp://ftp.u-strasbg.fr/CPAN
2206                       ftp://cpan.cict.fr/pub/CPAN/
2207                       ftp://ftp.uvsq.fr/pub/perl/CPAN/
2208
2209 =item Germany
2210
2211                       ftp://ftp.rub.de/pub/CPAN/
2212                       ftp://ftp.freenet.de/pub/ftp.cpan.org/pub/CPAN/
2213                       ftp://ftp.uni-erlangen.de/pub/source/CPAN/
2214                       ftp://ftp-stud.fht-esslingen.de/pub/Mirrors/CPAN
2215                       http://pandemonium.tiscali.de/pub/CPAN/
2216                       ftp://pandemonium.tiscali.de/pub/CPAN/
2217                       http://ftp.gwdg.de/pub/languages/perl/CPAN/
2218                       ftp://ftp.gwdg.de/pub/languages/perl/CPAN/
2219                       ftp://ftp.uni-hamburg.de/pub/soft/lang/perl/CPAN/
2220                       ftp://ftp.leo.org/pub/CPAN/
2221                       http://cpan.noris.de/
2222                       ftp://cpan.noris.de/pub/CPAN/
2223                       ftp://ftp.mpi-sb.mpg.de/pub/perl/CPAN/
2224                       ftp://ftp.gmd.de/mirrors/CPAN/
2225
2226 =item Greece
2227
2228                       ftp://ftp.acn.gr/pub/lang/perl
2229                       ftp://ftp.forthnet.gr/pub/languages/perl/CPAN
2230                       ftp://ftp.ntua.gr/pub/lang/perl/
2231
2232 =item Hungary
2233
2234                       http://ftp.kfki.hu/packages/perl/CPAN/
2235                       ftp://ftp.kfki.hu/pub/packages/perl/CPAN/
2236
2237 =item Iceland
2238
2239                       http://ftp.rhnet.is/pub/CPAN/
2240                       ftp://ftp.rhnet.is/pub/CPAN/
2241
2242 =item Ireland
2243
2244                       http://cpan.indigo.ie/
2245                       ftp://cpan.indigo.ie/pub/CPAN/
2246                       http://ftp.heanet.ie/mirrors/ftp.perl.org/pub/CPAN
2247                       ftp://ftp.heanet.ie/mirrors/ftp.perl.org/pub/CPAN
2248                       http://sunsite.compapp.dcu.ie/pub/perl/
2249                       ftp://sunsite.compapp.dcu.ie/pub/perl/
2250
2251 =item Italy
2252
2253                       http://cpan.nettuno.it/
2254                       http://gusp.dyndns.org/CPAN/
2255                       ftp://gusp.dyndns.org/pub/CPAN
2256                       http://softcity.iol.it/cpan
2257                       ftp://softcity.iol.it/pub/cpan
2258                       ftp://ftp.unina.it/pub/Other/CPAN/CPAN/
2259                       ftp://ftp.unipi.it/pub/mirror/perl/CPAN/
2260                       ftp://cis.uniRoma2.it/CPAN/
2261                       ftp://ftp.edisontel.it/pub/CPAN_Mirror/
2262                       http://cpan.flashnet.it/
2263                       ftp://ftp.flashnet.it/pub/CPAN/
2264
2265 =item Latvia
2266
2267                       http://kvin.lv/pub/CPAN/
2268
2269 =item Lithuania
2270
2271                       ftp://ftp.unix.lt/pub/CPAN/
2272
2273 =item Netherlands
2274
2275                       ftp://download.xs4all.nl/pub/mirror/CPAN/
2276                       ftp://ftp.nl.uu.net/pub/CPAN/
2277                       ftp://ftp.nluug.nl/pub/languages/perl/CPAN/
2278                       http://cpan.cybercomm.nl/
2279                       ftp://mirror.cybercomm.nl/pub/CPAN
2280                       ftp://mirror.vuurwerk.nl/pub/CPAN/
2281                       ftp://ftp.cpan.nl/pub/CPAN/
2282                       http://ftp.easynet.nl/mirror/CPAN
2283                       ftp://ftp.easynet.nl/mirror/CPAN
2284                       http://archive.cs.uu.nl/mirror/CPAN/
2285                       ftp://ftp.cs.uu.nl/mirror/CPAN/
2286
2287 =item Norway
2288
2289                       ftp://ftp.uninett.no/pub/languages/perl/CPAN
2290                       ftp://ftp.uit.no/pub/languages/perl/cpan/
2291
2292 =item Poland
2293
2294                       ftp://ftp.mega.net.pl/CPAN
2295                       ftp://ftp.man.torun.pl/pub/doc/CPAN/
2296                       ftp://sunsite.icm.edu.pl/pub/CPAN/
2297
2298 =item Portugal
2299
2300                       ftp://ftp.ua.pt/pub/CPAN/
2301                       ftp://perl.di.uminho.pt/pub/CPAN/
2302                       http://cpan.dei.uc.pt/
2303                       ftp://ftp.dei.uc.pt/pub/CPAN
2304                       ftp://ftp.nfsi.pt/pub/CPAN
2305                       http://ftp.linux.pt/pub/mirrors/CPAN
2306                       ftp://ftp.linux.pt/pub/mirrors/CPAN
2307                       http://cpan.ip.pt/
2308                       ftp://cpan.ip.pt/pub/cpan/
2309                       http://cpan.telepac.pt/
2310                       ftp://ftp.telepac.pt/pub/cpan/
2311
2312 =item Romania
2313
2314                       ftp://ftp.bio-net.ro/pub/CPAN
2315                       ftp://ftp.kappa.ro/pub/mirrors/ftp.perl.org/pub/CPAN/
2316                       ftp://ftp.lug.ro/CPAN
2317                       ftp://ftp.roedu.net/pub/CPAN/
2318                       ftp://ftp.dntis.ro/pub/cpan/
2319                       ftp://ftp.iasi.roedu.net/pub/mirrors/ftp.cpan.org/
2320                       http://cpan.ambra.ro/
2321                       ftp://ftp.ambra.ro/pub/CPAN
2322                       ftp://ftp.dnttm.ro/pub/CPAN/
2323                       ftp://ftp.lasting.ro/pub/CPAN
2324                       ftp://ftp.timisoara.roedu.net/mirrors/CPAN/
2325
2326 =item Russia
2327
2328                       ftp://ftp.chg.ru/pub/lang/perl/CPAN/
2329                       http://cpan.rinet.ru/
2330                       ftp://cpan.rinet.ru/pub/mirror/CPAN/
2331                       ftp://ftp.aha.ru/pub/CPAN/
2332                       ftp://ftp.corbina.ru/pub/CPAN/
2333                       http://cpan.sai.msu.ru/
2334                       ftp://ftp.sai.msu.su/pub/lang/perl/CPAN/
2335
2336 =item Slovakia
2337
2338                       ftp://ftp.cvt.stuba.sk/pub/CPAN/
2339
2340 =item Slovenia
2341
2342                       ftp://ftp.arnes.si/software/perl/CPAN/
2343
2344 =item Spain
2345
2346                       http://cpan.imasd.elmundo.es/
2347                       ftp://ftp.rediris.es/mirror/CPAN/
2348                       ftp://ftp.ri.telefonica-data.net/CPAN
2349                       ftp://ftp.etse.urv.es/pub/perl/
2350
2351 =item Sweden
2352
2353                       http://ftp.du.se/CPAN/
2354                       ftp://ftp.du.se/pub/CPAN/
2355                       http://mirror.dataphone.se/CPAN
2356                       ftp://mirror.dataphone.se/pub/CPAN
2357                       ftp://ftp.sunet.se/pub/lang/perl/CPAN/
2358
2359 =item Switzerland
2360
2361                       http://cpan.mirror.solnet.ch/
2362                       ftp://ftp.solnet.ch/mirror/CPAN/
2363                       ftp://ftp.danyk.ch/CPAN/
2364                       ftp://sunsite.cnlab-switch.ch/mirror/CPAN/
2365
2366 =item Turkey
2367
2368                       http://ftp.ulak.net.tr/perl/CPAN/
2369                       ftp://ftp.ulak.net.tr/perl/CPAN
2370                       ftp://sunsite.bilkent.edu.tr/pub/languages/CPAN/
2371
2372 =item Ukraine
2373
2374                       http://cpan.org.ua/
2375                       ftp://cpan.org.ua/
2376                       ftp://ftp.perl.org.ua/pub/CPAN/
2377                       http://no-more.kiev.ua/CPAN/
2378                       ftp://no-more.kiev.ua/pub/CPAN/
2379
2380 =item United Kingdom
2381
2382                       http://www.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN
2383                       ftp://ftp.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN/
2384                       http://cpan.teleglobe.net/
2385                       ftp://cpan.teleglobe.net/pub/CPAN
2386                       http://cpan.mirror.anlx.net/
2387                       ftp://ftp.mirror.anlx.net/CPAN/
2388                       http://cpan.etla.org/
2389                       ftp://cpan.etla.org/pub/CPAN
2390                       ftp://ftp.demon.co.uk/pub/CPAN/
2391                       http://cpan.m.flirble.org/
2392                       ftp://ftp.flirble.org/pub/languages/perl/CPAN/
2393                       ftp://ftp.plig.org/pub/CPAN/
2394                       http://cpan.hambule.co.uk/
2395                       http://cpan.mirrors.clockerz.net/
2396                       ftp://ftp.clockerz.net/pub/CPAN/
2397                       ftp://usit.shef.ac.uk/pub/packages/CPAN/
2398
2399 =back
2400
2401 =head2 North America
2402
2403 =over 4
2404
2405 =item Canada
2406
2407 =over 8
2408
2409 =item Alberta
2410
2411                       http://cpan.sunsite.ualberta.ca/
2412                       ftp://cpan.sunsite.ualberta.ca/pub/CPAN/
2413
2414 =item Manitoba
2415
2416                       http://theoryx5.uwinnipeg.ca/pub/CPAN/
2417                       ftp://theoryx5.uwinnipeg.ca/pub/CPAN/
2418
2419 =item Nova Scotia
2420
2421                       ftp://cpan.chebucto.ns.ca/pub/CPAN/
2422
2423 =item Ontario
2424
2425                       ftp://ftp.nrc.ca/pub/CPAN/
2426
2427 =back
2428
2429 =item Mexico
2430
2431                       http://cpan.azc.uam.mx
2432                       ftp://cpan.azc.uam.mx/mirrors/CPAN
2433                       http://www.cpan.unam.mx/
2434                       ftp://ftp.unam.mx/pub/CPAN
2435                       http://www.msg.com.mx/CPAN/
2436                       ftp://ftp.msg.com.mx/pub/CPAN/
2437
2438 =item United States
2439
2440 =over 8
2441
2442 =item Alabama
2443
2444                       http://mirror.hiwaay.net/CPAN/
2445                       ftp://mirror.hiwaay.net/CPAN/
2446
2447 =item California
2448
2449                       http://cpan.develooper.com/
2450                       http://www.cpan.org/
2451                       ftp://cpan.valueclick.com/pub/CPAN/
2452                       http://www.mednor.net/ftp/pub/mirrors/CPAN/
2453                       ftp://ftp.mednor.net/pub/mirrors/CPAN/
2454                       http://mirrors.gossamer-threads.com/CPAN
2455                       ftp://cpan.nas.nasa.gov/pub/perl/CPAN/
2456                       http://mirrors.kernel.org/cpan/
2457                       ftp://mirrors.kernel.org/pub/CPAN
2458                       http://cpan-sj.viaverio.com/
2459                       ftp://cpan-sj.viaverio.com/pub/CPAN/
2460                       http://cpan.digisle.net/
2461                       ftp://cpan.digisle.net/pub/CPAN
2462                       http://www.perl.com/CPAN/
2463                       http://www.uberlan.net/CPAN
2464
2465 =item Colorado
2466
2467                       ftp://ftp.cs.colorado.edu/pub/perl/CPAN/
2468                       http://cpan.four10.com
2469
2470 =item Delaware
2471
2472                       http://ftp.lug.udel.edu/pub/CPAN
2473                       ftp://ftp.lug.udel.edu/pub/CPAN
2474
2475 =item District of Columbia
2476
2477                       ftp://ftp.dc.aleron.net/pub/CPAN/
2478
2479 =item Florida
2480
2481                       ftp://ftp.cise.ufl.edu/pub/mirrors/CPAN/
2482                       http://mirror.csit.fsu.edu/pub/CPAN/
2483                       ftp://mirror.csit.fsu.edu/pub/CPAN/
2484                       http://cpan.mirrors.nks.net/
2485
2486 =item Indiana
2487
2488                       ftp://ftp.uwsg.iu.edu/pub/perl/CPAN/
2489                       http://cpan.netnitco.net/
2490                       ftp://cpan.netnitco.net/pub/mirrors/CPAN/
2491                       http://archive.progeny.com/CPAN/
2492                       ftp://archive.progeny.com/CPAN/
2493                       http://fx.saintjoe.edu/pub/CPAN
2494                       ftp://ftp.saintjoe.edu/pub/CPAN
2495                       http://csociety-ftp.ecn.purdue.edu/pub/CPAN
2496                       ftp://csociety-ftp.ecn.purdue.edu/pub/CPAN
2497
2498 =item Kentucky
2499
2500                       http://cpan.uky.edu/
2501                       ftp://cpan.uky.edu/pub/CPAN/
2502                       http://slugsite.louisville.edu/cpan
2503                       ftp://slugsite.louisville.edu/CPAN
2504
2505 =item Massachusetts
2506
2507                       http://mirrors.towardex.com/CPAN
2508                       ftp://mirrors.towardex.com/pub/CPAN
2509                       ftp://ftp.ccs.neu.edu/net/mirrors/ftp.funet.fi/pub/languages/perl/CPAN/
2510
2511 =item Michigan
2512
2513                       ftp://cpan.cse.msu.edu/
2514                       http://cpan.calvin.edu/pub/CPAN
2515                       ftp://cpan.calvin.edu/pub/CPAN
2516
2517 =item Nevada
2518
2519                       http://www.oss.redundant.com/pub/CPAN
2520                       ftp://www.oss.redundant.com/pub/CPAN
2521
2522 =item New Jersey
2523
2524                       http://ftp.cpanel.net/pub/CPAN/
2525                       ftp://ftp.cpanel.net/pub/CPAN/
2526                       http://cpan.teleglobe.net/
2527                       ftp://cpan.teleglobe.net/pub/CPAN
2528
2529 =item New York
2530
2531                       http://cpan.belfry.net/
2532                       http://cpan.erlbaum.net/
2533                       ftp://cpan.erlbaum.net/
2534                       http://cpan.thepirtgroup.com/
2535                       ftp://cpan.thepirtgroup.com/
2536                       ftp://ftp.stealth.net/pub/CPAN/
2537                       http://www.rge.com/pub/languages/perl/
2538                       ftp://ftp.rge.com/pub/languages/perl/
2539
2540 =item North Carolina
2541
2542                       http://www.ibiblio.org/pub/languages/perl/CPAN
2543                       ftp://ftp.ibiblio.org/pub/languages/perl/CPAN
2544                       ftp://ftp.duke.edu/pub/perl/
2545                       ftp://ftp.ncsu.edu/pub/mirror/CPAN/
2546
2547 =item Oklahoma
2548
2549                       ftp://ftp.ou.edu/mirrors/CPAN/
2550
2551 =item Oregon
2552
2553                       ftp://ftp.orst.edu/pub/CPAN
2554
2555 =item Pennsylvania
2556
2557                       http://ftp.epix.net/CPAN/
2558                       ftp://ftp.epix.net/pub/languages/perl/
2559                       http://mirrors.phenominet.com/pub/CPAN/
2560                       ftp://mirrors.phenominet.com/pub/CPAN/
2561                       http://cpan.pair.com/
2562                       ftp://cpan.pair.com/pub/CPAN/
2563                       ftp://carroll.cac.psu.edu/pub/CPAN/
2564
2565 =item Tennessee
2566
2567                       ftp://ftp.sunsite.utk.edu/pub/CPAN/
2568
2569 =item Texas
2570
2571                       http://ftp.sedl.org/pub/mirrors/CPAN/
2572                       http://www.binarycode.org/cpan
2573                       ftp://mirror.telentente.com/pub/CPAN
2574                       http://mirrors.theonlinerecordstore.com/CPAN
2575
2576 =item Utah
2577
2578                       ftp://mirror.xmission.com/CPAN/
2579
2580 =item Virginia
2581
2582                       http://cpan-du.viaverio.com/
2583                       ftp://cpan-du.viaverio.com/pub/CPAN/
2584                       http://mirrors.rcn.net/pub/lang/CPAN/
2585                       ftp://mirrors.rcn.net/pub/lang/CPAN/
2586                       http://perl.secsup.org/
2587                       ftp://perl.secsup.org/pub/perl/
2588                       http://noc.cvaix.com/mirrors/CPAN/
2589
2590 =item Washington
2591
2592                       http://cpan.llarian.net/
2593                       ftp://cpan.llarian.net/pub/CPAN/
2594                       http://cpan.mirrorcentral.com/
2595                       ftp://ftp.mirrorcentral.com/pub/CPAN/
2596                       ftp://ftp-mirror.internap.com/pub/CPAN/
2597
2598 =item Wisconsin
2599
2600                       http://mirror.sit.wisc.edu/pub/CPAN/
2601                       ftp://mirror.sit.wisc.edu/pub/CPAN/
2602                       http://mirror.aphix.com/CPAN
2603                       ftp://mirror.aphix.com/pub/CPAN
2604
2605 =back
2606
2607 =back
2608
2609 =head2 Oceania
2610
2611 =over 4
2612
2613 =item Australia
2614
2615                       http://ftp.planetmirror.com/pub/CPAN/
2616                       ftp://ftp.planetmirror.com/pub/CPAN/
2617                       ftp://mirror.aarnet.edu.au/pub/perl/CPAN/
2618                       ftp://cpan.topend.com.au/pub/CPAN/
2619                       http://cpan.mirrors.ilisys.com.au
2620
2621 =item New Zealand
2622
2623                       ftp://ftp.auckland.ac.nz/pub/perl/CPAN/
2624
2625 =item United States
2626
2627                       http://aniani.ifa.hawaii.edu/CPAN/
2628                       ftp://aniani.ifa.hawaii.edu/CPAN/
2629
2630 =back
2631
2632 =head2 South America
2633
2634 =over 4
2635
2636 =item Argentina
2637
2638                       ftp://mirrors.bannerlandia.com.ar/mirrors/CPAN/
2639                       http://www.linux.org.ar/mirrors/cpan
2640                       ftp://ftp.linux.org.ar/mirrors/cpan
2641
2642 =item Brazil
2643
2644                       ftp://cpan.pop-mg.com.br/pub/CPAN/
2645                       ftp://ftp.matrix.com.br/pub/perl/CPAN/
2646                       http://cpan.hostsul.com.br/
2647                       ftp://cpan.hostsul.com.br/
2648
2649 =item Chile
2650
2651                       http://cpan.netglobalis.net/
2652                       ftp://cpan.netglobalis.net/pub/CPAN/
2653
2654 =back
2655
2656 =head2 RSYNC Mirrors
2657
2658                       www.linux.org.ar::cpan
2659                       theoryx5.uwinnipeg.ca::CPAN
2660                       ftp.shellhung.org::CPAN
2661                       rsync.nic.funet.fi::CPAN
2662                       ftp.u-paris10.fr::CPAN
2663                       mir1.ovh.net::CPAN
2664                       rsync://ftp.crihan.fr::CPAN
2665                       ftp.gwdg.de::FTP/languages/perl/CPAN/
2666                       ftp.leo.org::CPAN
2667                       ftp.cbn.net.id::CPAN
2668                       rsync://ftp.heanet.ie/mirrors/ftp.perl.org/pub/CPAN
2669                       ftp.iglu.org.il::CPAN
2670                       gusp.dyndns.org::cpan
2671                       ftp.kddlabs.co.jp::cpan
2672                       ftp.ayamura.org::pub/CPAN/
2673                       mirror.leafbug.org::CPAN
2674                       rsync.en.com.sg::CPAN
2675                       mirror.averse.net::cpan
2676                       rsync.oss.eznetsols.org
2677                       ftp.kr.FreeBSD.org::CPAN
2678                       ftp.solnet.ch::CPAN
2679                       cpan.cdpa.nsysu.edu.tw::CPAN
2680                       cpan.teleglobe.net::CPAN
2681                       rsync://rsync.mirror.anlx.net::CPAN
2682                       ftp.sedl.org::cpan
2683                       ibiblio.org::CPAN
2684                       cpan-du.viaverio.com::CPAN
2685                       aniani.ifa.hawaii.edu::CPAN
2686                       archive.progeny.com::CPAN
2687                       rsync://slugsite.louisville.edu::CPAN
2688                       mirror.aphix.com::CPAN
2689                       cpan.teleglobe.net::CPAN
2690                       ftp.lug.udel.edu::cpan
2691                       mirrors.kernel.org::mirrors/CPAN
2692                       mirrors.phenominet.com::CPAN
2693                       cpan.pair.com::CPAN
2694                       cpan-sj.viaverio.com::CPAN
2695                       mirror.csit.fsu.edu::CPAN
2696                       csociety-ftp.ecn.purdue.edu::CPAN
2697
2698 For an up-to-date listing of CPAN sites,
2699 see http://www.cpan.org/SITES or ftp://www.cpan.org/SITES .
2700
2701 =head1 Modules: Creation, Use, and Abuse
2702
2703 (The following section is borrowed directly from Tim Bunce's modules
2704 file, available at your nearest CPAN site.)
2705
2706 Perl implements a class using a package, but the presence of a
2707 package doesn't imply the presence of a class.  A package is just a
2708 namespace.  A class is a package that provides subroutines that can be
2709 used as methods.  A method is just a subroutine that expects, as its
2710 first argument, either the name of a package (for "static" methods),
2711 or a reference to something (for "virtual" methods).
2712
2713 A module is a file that (by convention) provides a class of the same
2714 name (sans the .pm), plus an import method in that class that can be
2715 called to fetch exported symbols.  This module may implement some of
2716 its methods by loading dynamic C or C++ objects, but that should be
2717 totally transparent to the user of the module.  Likewise, the module
2718 might set up an AUTOLOAD function to slurp in subroutine definitions on
2719 demand, but this is also transparent.  Only the F<.pm> file is required to
2720 exist.  See L<perlsub>, L<perltoot>, and L<AutoLoader> for details about
2721 the AUTOLOAD mechanism.
2722
2723 =head2 Guidelines for Module Creation
2724
2725 =over 4
2726
2727 =item  *
2728
2729 Do similar modules already exist in some form?
2730
2731 If so, please try to reuse the existing modules either in whole or
2732 by inheriting useful features into a new class.  If this is not
2733 practical try to get together with the module authors to work on
2734 extending or enhancing the functionality of the existing modules.
2735 A perfect example is the plethora of packages in perl4 for dealing
2736 with command line options.
2737
2738 If you are writing a module to expand an already existing set of
2739 modules, please coordinate with the author of the package.  It
2740 helps if you follow the same naming scheme and module interaction
2741 scheme as the original author.
2742
2743 =item  *
2744
2745 Try to design the new module to be easy to extend and reuse.
2746
2747 Try to C<use warnings;> (or C<use warnings qw(...);>).
2748 Remember that you can add C<no warnings qw(...);> to individual blocks
2749 of code that need less warnings.
2750
2751 Use blessed references.  Use the two argument form of bless to bless
2752 into the class name given as the first parameter of the constructor,
2753 e.g.,:
2754
2755  sub new {
2756      my $class = shift;
2757      return bless {}, $class;
2758  }
2759
2760 or even this if you'd like it to be used as either a static
2761 or a virtual method.
2762
2763  sub new {
2764      my $self  = shift;
2765      my $class = ref($self) || $self;
2766      return bless {}, $class;
2767  }
2768
2769 Pass arrays as references so more parameters can be added later
2770 (it's also faster).  Convert functions into methods where
2771 appropriate.  Split large methods into smaller more flexible ones.
2772 Inherit methods from other modules if appropriate.
2773
2774 Avoid class name tests like: C<die "Invalid" unless ref $ref eq 'FOO'>.
2775 Generally you can delete the C<eq 'FOO'> part with no harm at all.
2776 Let the objects look after themselves! Generally, avoid hard-wired
2777 class names as far as possible.
2778
2779 Avoid C<< $r->Class::func() >> where using C<@ISA=qw(... Class ...)> and
2780 C<< $r->func() >> would work (see L<perlbot> for more details).
2781
2782 Use autosplit so little used or newly added functions won't be a
2783 burden to programs that don't use them. Add test functions to
2784 the module after __END__ either using AutoSplit or by saying:
2785
2786  eval join('',<main::DATA>) || die $@ unless caller();
2787
2788 Does your module pass the 'empty subclass' test? If you say
2789 C<@SUBCLASS::ISA = qw(YOURCLASS);> your applications should be able
2790 to use SUBCLASS in exactly the same way as YOURCLASS.  For example,
2791 does your application still work if you change:  C<< $obj = YOURCLASS->new(); >>
2792 into: C<< $obj = SUBCLASS->new(); >> ?
2793
2794 Avoid keeping any state information in your packages. It makes it
2795 difficult for multiple other packages to use yours. Keep state
2796 information in objects.
2797
2798 Always use B<-w>.
2799
2800 Try to C<use strict;> (or C<use strict qw(...);>).
2801 Remember that you can add C<no strict qw(...);> to individual blocks
2802 of code that need less strictness.
2803
2804 Always use B<-w>.
2805
2806 Follow the guidelines in the perlstyle(1) manual.
2807
2808 Always use B<-w>.
2809
2810 =item  *
2811
2812 Some simple style guidelines
2813
2814 The perlstyle manual supplied with Perl has many helpful points.
2815
2816 Coding style is a matter of personal taste. Many people evolve their
2817 style over several years as they learn what helps them write and
2818 maintain good code.  Here's one set of assorted suggestions that
2819 seem to be widely used by experienced developers:
2820
2821 Use underscores to separate words.  It is generally easier to read
2822 $var_names_like_this than $VarNamesLikeThis, especially for
2823 non-native speakers of English. It's also a simple rule that works
2824 consistently with VAR_NAMES_LIKE_THIS.
2825
2826 Package/Module names are an exception to this rule. Perl informally
2827 reserves lowercase module names for 'pragma' modules like integer
2828 and strict. Other modules normally begin with a capital letter and
2829 use mixed case with no underscores (need to be short and portable).
2830
2831 You may find it helpful to use letter case to indicate the scope
2832 or nature of a variable. For example:
2833
2834  $ALL_CAPS_HERE   constants only (beware clashes with Perl vars)
2835  $Some_Caps_Here  package-wide global/static
2836  $no_caps_here    function scope my() or local() variables
2837
2838 Function and method names seem to work best as all lowercase.
2839 e.g., C<< $obj->as_string() >>.
2840
2841 You can use a leading underscore to indicate that a variable or
2842 function should not be used outside the package that defined it.
2843
2844 =item  *
2845
2846 Select what to export.
2847
2848 Do NOT export method names!
2849
2850 Do NOT export anything else by default without a good reason!
2851
2852 Exports pollute the namespace of the module user.  If you must
2853 export try to use @EXPORT_OK in preference to @EXPORT and avoid
2854 short or common names to reduce the risk of name clashes.
2855
2856 Generally anything not exported is still accessible from outside the
2857 module using the ModuleName::item_name (or C<< $blessed_ref->method >>)
2858 syntax.  By convention you can use a leading underscore on names to
2859 indicate informally that they are 'internal' and not for public use.
2860
2861 (It is actually possible to get private functions by saying:
2862 C<my $subref = sub { ... };  &$subref;>.  But there's no way to call that
2863 directly as a method, because a method must have a name in the symbol
2864 table.)
2865
2866 As a general rule, if the module is trying to be object oriented
2867 then export nothing. If it's just a collection of functions then
2868 @EXPORT_OK anything but use @EXPORT with caution.
2869
2870 =item  *
2871
2872 Select a name for the module.
2873
2874 This name should be as descriptive, accurate, and complete as
2875 possible.  Avoid any risk of ambiguity. Always try to use two or
2876 more whole words.  Generally the name should reflect what is special
2877 about what the module does rather than how it does it.  Please use
2878 nested module names to group informally or categorize a module.
2879 There should be a very good reason for a module not to have a nested name.
2880 Module names should begin with a capital letter.
2881
2882 Having 57 modules all called Sort will not make life easy for anyone
2883 (though having 23 called Sort::Quick is only marginally better :-).
2884 Imagine someone trying to install your module alongside many others.
2885 If in any doubt ask for suggestions in comp.lang.perl.misc.
2886
2887 If you are developing a suite of related modules/classes it's good
2888 practice to use nested classes with a common prefix as this will
2889 avoid namespace clashes. For example: Xyz::Control, Xyz::View,
2890 Xyz::Model etc. Use the modules in this list as a naming guide.
2891
2892 If adding a new module to a set, follow the original author's
2893 standards for naming modules and the interface to methods in
2894 those modules.
2895
2896 If developing modules for private internal or project specific use,
2897 that will never be released to the public, then you should ensure
2898 that their names will not clash with any future public module. You
2899 can do this either by using the reserved Local::* category or by
2900 using a category name that includes an underscore like Foo_Corp::*.
2901
2902 To be portable each component of a module name should be limited to
2903 11 characters. If it might be used on MS-DOS then try to ensure each is
2904 unique in the first 8 characters. Nested modules make this easier.
2905
2906 =item  *
2907
2908 Have you got it right?
2909
2910 How do you know that you've made the right decisions? Have you
2911 picked an interface design that will cause problems later? Have
2912 you picked the most appropriate name? Do you have any questions?
2913
2914 The best way to know for sure, and pick up many helpful suggestions,
2915 is to ask someone who knows. Comp.lang.perl.misc is read by just about
2916 all the people who develop modules and it's the best place to ask.
2917
2918 All you need to do is post a short summary of the module, its
2919 purpose and interfaces. A few lines on each of the main methods is
2920 probably enough. (If you post the whole module it might be ignored
2921 by busy people - generally the very people you want to read it!)
2922
2923 Don't worry about posting if you can't say when the module will be
2924 ready - just say so in the message. It might be worth inviting
2925 others to help you, they may be able to complete it for you!
2926
2927 =item  *
2928
2929 README and other Additional Files.
2930
2931 It's well known that software developers usually fully document the
2932 software they write. If, however, the world is in urgent need of
2933 your software and there is not enough time to write the full
2934 documentation please at least provide a README file containing:
2935
2936 =over 10
2937
2938 =item *
2939
2940 A description of the module/package/extension etc.
2941
2942 =item *
2943
2944 A copyright notice - see below.
2945
2946 =item *
2947
2948 Prerequisites - what else you may need to have.
2949
2950 =item *
2951
2952 How to build it - possible changes to Makefile.PL etc.
2953
2954 =item *
2955
2956 How to install it.
2957
2958 =item *
2959
2960 Recent changes in this release, especially incompatibilities
2961
2962 =item *
2963
2964 Changes / enhancements you plan to make in the future.
2965
2966 =back
2967
2968 If the README file seems to be getting too large you may wish to
2969 split out some of the sections into separate files: INSTALL,
2970 Copying, ToDo etc.
2971
2972 =over 4
2973
2974 =item *
2975
2976 Adding a Copyright Notice.
2977
2978 How you choose to license your work is a personal decision.
2979 The general mechanism is to assert your Copyright and then make
2980 a declaration of how others may copy/use/modify your work.
2981
2982 Perl, for example, is supplied with two types of licence: The GNU GPL
2983 and The Artistic Licence (see the files README, Copying, and Artistic,
2984 or L<perlgpl> and L<perlartistic>).  Larry has good reasons for NOT
2985 just using the GNU GPL.
2986
2987 My personal recommendation, out of respect for Larry, Perl, and the
2988 Perl community at large is to state something simply like:
2989
2990  Copyright (c) 1995 Your Name. All rights reserved.
2991  This program is free software; you can redistribute it and/or
2992  modify it under the same terms as Perl itself.
2993
2994 This statement should at least appear in the README file. You may
2995 also wish to include it in a Copying file and your source files.
2996 Remember to include the other words in addition to the Copyright.
2997
2998 =item  *
2999
3000 Give the module a version/issue/release number.
3001
3002 To be fully compatible with the Exporter and MakeMaker modules you
3003 should store your module's version number in a non-my package
3004 variable called $VERSION.  This should be a floating point
3005 number with at least two digits after the decimal (i.e., hundredths,
3006 e.g, C<$VERSION = "0.01">).  Don't use a "1.3.2" style version.
3007 See L<Exporter> for details.
3008
3009 It may be handy to add a function or method to retrieve the number.
3010 Use the number in announcements and archive file names when
3011 releasing the module (ModuleName-1.02.tar.Z).
3012 See perldoc ExtUtils::MakeMaker.pm for details.
3013
3014 =item  *
3015
3016 How to release and distribute a module.
3017
3018 It's good idea to post an announcement of the availability of your
3019 module (or the module itself if small) to the comp.lang.perl.announce
3020 Usenet newsgroup.  This will at least ensure very wide once-off
3021 distribution.
3022
3023 If possible, register the module with CPAN.  You should
3024 include details of its location in your announcement.
3025
3026 Some notes about ftp archives: Please use a long descriptive file
3027 name that includes the version number. Most incoming directories
3028 will not be readable/listable, i.e., you won't be able to see your
3029 file after uploading it. Remember to send your email notification
3030 message as soon as possible after uploading else your file may get
3031 deleted automatically. Allow time for the file to be processed
3032 and/or check the file has been processed before announcing its
3033 location.
3034
3035 FTP Archives for Perl Modules:
3036
3037 Follow the instructions and links on:
3038
3039    http://www.cpan.org/modules/00modlist.long.html
3040    http://www.cpan.org/modules/04pause.html
3041
3042 or upload to one of these sites:
3043
3044    https://pause.kbx.de/pause/
3045    http://pause.perl.org/pause/
3046
3047 and notify <modules@perl.org>.
3048
3049 By using the WWW interface you can ask the Upload Server to mirror
3050 your modules from your ftp or WWW site into your own directory on
3051 CPAN!
3052
3053 Please remember to send me an updated entry for the Module list!
3054
3055 =item  *
3056
3057 Take care when changing a released module.
3058
3059 Always strive to remain compatible with previous released versions.
3060 Otherwise try to add a mechanism to revert to the
3061 old behavior if people rely on it.  Document incompatible changes.
3062
3063 =back
3064
3065 =back
3066
3067 =head2 Guidelines for Converting Perl 4 Library Scripts into Modules
3068
3069 =over 4
3070
3071 =item  *
3072
3073 There is no requirement to convert anything.
3074
3075 If it ain't broke, don't fix it! Perl 4 library scripts should
3076 continue to work with no problems. You may need to make some minor
3077 changes (like escaping non-array @'s in double quoted strings) but
3078 there is no need to convert a .pl file into a Module for just that.
3079
3080 =item  *
3081
3082 Consider the implications.
3083
3084 All Perl applications that make use of the script will need to
3085 be changed (slightly) if the script is converted into a module.  Is
3086 it worth it unless you plan to make other changes at the same time?
3087
3088 =item  *
3089
3090 Make the most of the opportunity.
3091
3092 If you are going to convert the script to a module you can use the
3093 opportunity to redesign the interface.  The guidelines for module
3094 creation above include many of the issues you should consider.
3095
3096 =item  *
3097
3098 The pl2pm utility will get you started.
3099
3100 This utility will read *.pl files (given as parameters) and write
3101 corresponding *.pm files. The pl2pm utilities does the following:
3102
3103 =over 10
3104
3105 =item *
3106
3107 Adds the standard Module prologue lines
3108
3109 =item *
3110
3111 Converts package specifiers from ' to ::
3112
3113 =item *
3114
3115 Converts die(...) to croak(...)
3116
3117 =item *
3118
3119 Several other minor changes
3120
3121 =back
3122
3123 Being a mechanical process pl2pm is not bullet proof. The converted
3124 code will need careful checking, especially any package statements.
3125 Don't delete the original .pl file till the new .pm one works!
3126
3127 =back
3128
3129 =head2 Guidelines for Reusing Application Code
3130
3131 =over 4
3132
3133 =item  *
3134
3135 Complete applications rarely belong in the Perl Module Library.
3136
3137 =item  *
3138
3139 Many applications contain some Perl code that could be reused.
3140
3141 Help save the world! Share your code in a form that makes it easy
3142 to reuse.
3143
3144 =item  *
3145
3146 Break-out the reusable code into one or more separate module files.
3147
3148 =item  *
3149
3150 Take the opportunity to reconsider and redesign the interfaces.
3151
3152 =item  *
3153
3154 In some cases the 'application' can then be reduced to a small
3155
3156 fragment of code built on top of the reusable modules. In these cases
3157 the application could invoked as:
3158
3159      % perl -e 'use Module::Name; method(@ARGV)' ...
3160 or
3161      % perl -mModule::Name ...    (in perl5.002 or higher)
3162
3163 =back
3164
3165 =head1 NOTE
3166
3167 Perl does not enforce private and public parts of its modules as you may
3168 have been used to in other languages like C++, Ada, or Modula-17.  Perl
3169 doesn't have an infatuation with enforced privacy.  It would prefer
3170 that you stayed out of its living room because you weren't invited, not
3171 because it has a shotgun.
3172
3173 The module and its user have a contract, part of which is common law,
3174 and part of which is "written".  Part of the common law contract is
3175 that a module doesn't pollute any namespace it wasn't asked to.  The
3176 written contract for the module (A.K.A. documentation) may make other
3177 provisions.  But then you know when you C<use RedefineTheWorld> that
3178 you're redefining the world and willing to take the consequences.