This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
67ea1a314d6bd11fbcf6fdc19b98dcaba6ea612e
[perl5.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 DESCRIPTION
9
10 =head1 THE PERL MODULE LIBRARY
11
12 Many modules are included the Perl distribution.  These are described
13 below, and all end in F<.pm>.  You may discover compiled library
14 file (usually ending in F<.so>) or small pieces of modules to be
15 autoloaded (ending in F<.al>); these were automatically generated
16 by the installation process.  You may also discover files in the
17 library directory that end in either F<.pl> or F<.ph>.  These are
18 old libraries supplied so that old programs that use them still
19 run.  The F<.pl> files will all eventually be converted into standard
20 modules, and the F<.ph> files made by B<h2ph> will probably end up
21 as extension modules made by B<h2xs>.  (Some F<.ph> values may
22 already be available through the POSIX, Errno, or Fcntl modules.)
23 The B<pl2pm> file in the distribution may help in your conversion,
24 but it's just a mechanical process and therefore far from bulletproof.
25
26 =head2 Pragmatic Modules
27
28 They work somewhat like compiler directives (pragmata) in that they
29 tend to affect the compilation of your program, and thus will usually
30 work well only when used within a C<use>, or C<no>.  Most of these
31 are lexically scoped, so an inner BLOCK may countermand them
32 by saying:
33
34     no integer;
35     no strict 'refs';
36     no warnings;
37
38 which lasts until the end of that BLOCK.
39
40 Some pragmas are lexically scoped--typically those that affect the
41 C<$^H> hints variable.  Others affect the current package instead,
42 like C<use vars> and C<use subs>, which allow you to predeclare a
43 variables or subroutines within a particular I<file> rather than
44 just a block.  Such declarations are effective for the entire file
45 for which they were declared.  You cannot rescind them with C<no
46 vars> or C<no subs>.
47
48 The following pragmas are defined (and have their own documentation).
49
50 =over 12
51
52 =item attributes
53
54 Get/set subroutine or variable attributes
55
56 =item attrs
57
58 Set/get attributes of a subroutine (deprecated)
59
60 =item autouse
61
62 Postpone load of modules until a function is used
63
64 =item base
65
66 Establish IS-A relationship with base class at compile time
67
68 =item blib
69
70 Use MakeMaker's uninstalled version of a package
71
72 =item bytes
73
74 Force byte semantics rather than character semantics
75
76 =item charnames
77
78 Define character names for C<\N{named}> string literal escapes.
79
80 =item constant
81
82 Declare constants
83
84 =item diagnostics
85
86 Perl compiler pragma to force verbose warning diagnostics
87
88 =item encoding
89
90 Pragma to control the conversion of legacy data into Unicode
91
92 =item fields
93
94 Compile-time class fields
95
96 =item filetest
97
98 Control the filetest permission operators
99
100 =item integer
101
102 Use integer arithmetic instead of floating point
103
104 =item less
105
106 Request less of something from the compiler
107
108 =item locale
109
110 Use and avoid POSIX locales for built-in operations
111
112 =item open
113
114 Set default disciplines for input and output
115
116 =item ops
117
118 Restrict unsafe operations when compiling
119
120 =item overload
121
122 Package for overloading perl operations
123
124 =item re
125
126 Alter regular expression behaviour
127
128 =item sigtrap
129
130 Enable simple signal handling
131
132 =item sort
133
134 Control sort() behaviour
135
136 =item strict
137
138 Restrict unsafe constructs
139
140 =item subs
141
142 Predeclare sub names
143
144 =item utf8
145
146 Enable/disable UTF-8 (or UTF-EBCDIC) in source code
147
148 =item vars
149
150 Predeclare global variable names (obsolete)
151
152 =item vmsish
153
154 Control VMS-specific language features
155
156 =item warnings
157
158 Control optional warnings
159
160 =item warnings::register
161
162 Warnings import function
163
164 =back
165
166 =head2 Standard Modules
167
168 Standard, bundled modules are all expected to behave in a well-defined
169 manner with respect to namespace pollution because they use the
170 Exporter module.  See their own documentation for details.
171
172 =over 12
173
174 =item AnyDBM_File
175
176 Provide framework for multiple DBMs
177
178 =item AutoLoader
179
180 Load subroutines only on demand
181
182 =item AutoSplit
183
184 Split a package for autoloading
185
186 =item B
187
188 The Perl Compiler
189
190 =item B::Asmdata
191
192 Autogenerated data about Perl ops, used to generate bytecode
193
194 =item B::Assembler
195
196 Assemble Perl bytecode
197
198 =item B::Bblock
199
200 Walk basic blocks
201
202 =item B::Bytecode
203
204 Perl compiler's bytecode backend
205
206 =item B::C
207
208 Perl compiler's C backend
209
210 =item B::CC
211
212 Perl compiler's optimized C translation backend
213
214 =item B::Concise
215
216 Walk Perl syntax tree, printing concise info about ops
217
218 =item B::Debug
219
220 Walk Perl syntax tree, printing debug info about ops
221
222 =item B::Deparse
223
224 Perl compiler backend to produce perl code
225
226 =item B::Disassembler
227
228 Disassemble Perl bytecode
229
230 =item B::Lint
231
232 Perl lint
233
234 =item B::Showlex
235
236 Show lexical variables used in functions or files
237
238 =item B::Stackobj
239
240 Helper module for CC backend
241
242 =item B::Stash
243
244 Show what stashes are loaded
245
246 =item B::Terse
247
248 Walk Perl syntax tree, printing terse info about ops
249
250 =item B::Xref
251
252 Generates cross reference reports for Perl programs
253
254 =item Benchmark
255
256 Benchmark running times of Perl code
257
258 =item ByteLoader
259
260 Load byte compiled perl code
261
262 =item CGI
263
264 Simple Common Gateway Interface Class
265
266 =item CGI::Apache
267
268 Backward compatibility module for CGI.pm
269
270 =item CGI::Carp
271
272 CGI routines for writing to the HTTPD (or other) error log
273
274 =item CGI::Cookie
275
276 Interface to Netscape Cookies
277
278 =item CGI::Fast
279
280 CGI Interface for Fast CGI
281
282 =item CGI::Pretty
283
284 Module to produce nicely formatted HTML code
285
286 =item CGI::Push
287
288 Simple Interface to Server Push
289
290 =item CGI::Switch
291
292 Backward compatibility module for defunct CGI::Switch
293
294 =item CGI::Util
295
296 Internal utilities used by CGI module
297
298 =item CPAN
299
300 Query, download and build perl modules from CPAN sites
301
302 =item CPAN::FirstTime
303
304 Utility for CPAN::Config file Initialization
305
306 =item CPAN::Nox
307
308 Wrapper around CPAN.pm without using any XS module
309
310 =item Carp
311
312 Warn of errors (from perspective of caller)
313
314 =item Carp::Heavy
315
316 No user serviceable parts inside
317
318 =item Class::ISA
319
320 Report the search path for a class's ISA tree
321
322 =item Class::Struct
323
324 Declare struct-like datatypes as Perl classes
325
326 =item Cwd
327
328 Get pathname of current working directory
329
330 =item DB
331
332 Programmatic interface to the Perl debugging API (draft, subject to
333
334 =item DB_File
335
336 Perl5 access to Berkeley DB version 1.x
337
338 =item Devel::SelfStubber
339
340 Generate stubs for a SelfLoading module
341
342 =item Digest
343
344 Modules that calculate message digests
345
346 =item DirHandle
347
348 Supply object methods for directory handles
349
350 =item Dumpvalue
351
352 Provides screen dump of Perl data.
353
354 =item Encode
355
356 Character encodings
357
358 =item Encode::EncodeFormat
359
360 The format of encoding tables of the Encode extension
361
362 =item Encode::Tcl
363
364 Tcl encodings
365
366 =item English
367
368 Use nice English (or awk) names for ugly punctuation variables
369
370 =item Env
371
372 Perl module that imports environment variables as scalars or arrays
373
374 =item Exporter
375
376 Implements default import method for modules
377
378 =item Exporter::Heavy
379
380 Exporter guts
381
382 =item ExtUtils::Command
383
384 Utilities to replace common UNIX commands in Makefiles etc.
385
386 =item ExtUtils::Constant
387
388 Generate XS code to import C header constants
389
390 =item ExtUtils::Embed
391
392 Utilities for embedding Perl in C/C++ applications
393
394 =item ExtUtils::Install
395
396 Install files from here to there
397
398 =item ExtUtils::Installed
399
400 Inventory management of installed modules
401
402 =item ExtUtils::Liblist
403
404 Determine libraries to use and how to use them
405
406 =item ExtUtils::MM_Cygwin
407
408 Methods to override UN*X behaviour in ExtUtils::MakeMaker
409
410 =item ExtUtils::MM_NW5
411
412 Methods to override UN*X behaviour in ExtUtils::MakeMaker
413
414 =item ExtUtils::MM_OS2
415
416 Methods to override UN*X behaviour in ExtUtils::MakeMaker
417
418 =item ExtUtils::MM_Unix
419
420 Methods used by ExtUtils::MakeMaker
421
422 =item ExtUtils::MM_VMS
423
424 Methods to override UN*X behaviour in ExtUtils::MakeMaker
425
426 =item ExtUtils::MM_Win32
427
428 Methods to override UN*X behaviour in ExtUtils::MakeMaker
429
430 =item ExtUtils::MakeMaker
431
432 Create an extension Makefile
433
434 =item ExtUtils::Manifest
435
436 Utilities to write and check a MANIFEST file
437
438 =item ExtUtils::Mkbootstrap
439
440 Make a bootstrap file for use by DynaLoader
441
442 =item ExtUtils::Mksymlists
443
444 Write linker options files for dynamic extension
445
446 =item ExtUtils::Packlist
447
448 Manage .packlist files
449
450 =item ExtUtils::testlib
451
452 Add blib/* directories to @INC
453
454 =item Fatal
455
456 Replace functions with equivalents which succeed or die
457
458 =item Fcntl
459
460 Load the C Fcntl.h defines
461
462 =item File::Basename
463
464 Split a pathname into pieces
465
466 =item File::CheckTree
467
468 Run many filetest checks on a tree
469
470 =item File::Compare
471
472 Compare files or filehandles
473
474 =item File::Copy
475
476 Copy files or filehandles
477
478 =item File::DosGlob
479
480 DOS like globbing and then some
481
482 =item File::Find
483
484 Traverse a file tree
485
486 =item File::Path
487
488 Create or remove directory trees
489
490 =item File::Spec
491
492 Portably perform operations on file names
493
494 =item File::Spec::Epoc
495
496 Methods for Epoc file specs
497
498 =item File::Spec::Functions
499
500 Portably perform operations on file names
501
502 =item File::Spec::Mac
503
504 File::Spec for Mac OS (Classic)
505
506 =item File::Spec::OS2
507
508 Methods for OS/2 file specs
509
510 =item File::Spec::Unix
511
512 File::Spec for Unix, base for other File::Spec modules
513
514 =item File::Spec::VMS
515
516 Methods for VMS file specs
517
518 =item File::Spec::Win32
519
520 Methods for Win32 file specs
521
522 =item File::Temp
523
524 Return name and handle of a temporary file safely
525
526 =item File::stat
527
528 By-name interface to Perl's built-in stat() functions
529
530 =item FileCache
531
532 Keep more files open than the system permits
533
534 =item FileHandle
535
536 Supply object methods for filehandles
537
538 =item Filter::Simple
539
540 Simplified source filtering
541
542 =item FindBin
543
544 Locate directory of original perl script
545
546 =item Getopt::Long
547
548 Extended processing of command line options
549
550 =item Getopt::Std
551
552 Process single-character switches with switch clustering
553
554 =item I18N::Collate
555
556 Compare 8-bit scalar data according to the current locale
557
558 =item I18N::LangTags
559
560 Functions for dealing with RFC3066-style language tags
561
562 =item I18N::LangTags::List
563
564 Tags and names for human languages
565
566 =item IO
567
568 Load various IO modules
569
570 =item IPC::Open2
571
572 Open a process for both reading and writing
573
574 =item IPC::Open3
575
576 Open a process for reading, writing, and error handling
577
578 =item Locale::Constants
579
580 Constants for Locale codes
581
582 =item Locale::Country
583
584 ISO codes for country identification (ISO 3166)
585
586 =item Locale::Currency
587
588 ISO three letter codes for currency identification (ISO 4217)
589
590 =item Locale::Language
591
592 ISO two letter codes for language identification (ISO 639)
593
594 =item Locale::Maketext
595
596 Framework for localization
597
598 =item Locale::Maketext::TPJ13
599
600 Article about software localization
601
602 =item Math::BigFloat
603
604 Arbitrary size floating point math package
605
606 =item Math::BigInt
607
608 Arbitrary size integer math package
609
610 =item Math::BigInt::Calc
611
612 Pure Perl module to support Math::BigInt
613
614 =item Math::Complex
615
616 Complex numbers and associated mathematical functions
617
618 =item Math::Trig
619
620 Trigonometric functions
621
622 =item Memoize
623
624 Make your functions faster by trading space for time
625
626 =item Memoize::AnyDBM_File
627
628 Glue to provide EXISTS for AnyDBM_File for Storable use
629
630 =item Memoize::Expire
631
632 Plug-in module for automatic expiration of memoized values
633
634 =item Memoize::ExpireFile
635
636 Test for Memoize expiration semantics
637
638 =item Memoize::ExpireTest
639
640 Test for Memoize expiration semantics
641
642 =item Memoize::NDBM_File
643
644 Glue to provide EXISTS for NDBM_File for Storable use
645
646 =item Memoize::SDBM_File
647
648 Glue to provide EXISTS for SDBM_File for Storable use
649
650 =item Memoize::Storable
651
652 Store Memoized data in Storable database
653
654 =item NDBM_File
655
656 Tied access to ndbm files
657
658 =item NEXT
659
660 Provide a pseudo-class NEXT that allows method redispatch
661
662 =item Net::Cmd
663
664 Network Command class (as used by FTP, SMTP etc)
665
666 =item Net::Config
667
668 Local configuration data for libnet
669
670 =item Net::Domain
671
672 Attempt to evaluate the current host's internet name and domain
673
674 =item Net::FTP
675
676 FTP Client class
677
678 =item Net::NNTP
679
680 NNTP Client class
681
682 =item Net::Netrc
683
684 OO interface to users netrc file
685
686 =item Net::POP3
687
688 Post Office Protocol 3 Client class (RFC1081)
689
690 =item Net::Ping
691
692 Check a remote host for reachability
693
694 =item Net::SMTP
695
696 Simple Mail Transfer Protocol Client
697
698 =item Net::Time
699
700 Time and daytime network client interface
701
702 =item Net::hostent
703
704 By-name interface to Perl's built-in gethost*() functions
705
706 =item Net::libnetFAQ
707
708 Libnet Frequently Asked Questions
709
710 =item Net::netent
711
712 By-name interface to Perl's built-in getnet*() functions
713
714 =item Net::protoent
715
716 By-name interface to Perl's built-in getproto*() functions
717
718 =item Net::servent
719
720 By-name interface to Perl's built-in getserv*() functions
721
722 =item O
723
724 Generic interface to Perl Compiler backends
725
726 =item ODBM_File
727
728 Tied access to odbm files
729
730 =item Opcode
731
732 Disable named opcodes when compiling perl code
733
734 =item POSIX
735
736 Perl interface to IEEE Std 1003.1
737
738 =item PerlIO
739
740 On demand loader for PerlIO layers and root of PerlIO::* name space
741
742 =item Pod::Checker
743
744 Check pod documents for syntax errors
745
746 =item Pod::Find
747
748 Find POD documents in directory trees
749
750 =item Pod::Html
751
752 Module to convert pod files to HTML
753
754 =item Pod::InputObjects
755
756 Objects representing POD input paragraphs, commands, etc.
757
758 =item Pod::LaTeX
759
760 Convert Pod data to formatted Latex
761
762 =item Pod::Man
763
764 Convert POD data to formatted *roff input
765
766 =item Pod::ParseLink
767
768 Parse an LE<lt>E<gt> formatting code in POD text
769
770 =item Pod::ParseUtils
771
772 Helpers for POD parsing and conversion
773
774 =item Pod::Parser
775
776 Base class for creating POD filters and translators
777
778 =item Pod::Plainer
779
780 Perl extension for converting Pod to old style Pod.
781
782 =item Pod::Select
783
784 Extract selected sections of POD from input
785
786 =item Pod::Text
787
788 Convert POD data to formatted ASCII text
789
790 =item Pod::Text::Color
791
792 Convert POD data to formatted color ASCII text
793
794 =item Pod::Text::Overstrike
795
796 Convert POD data to formatted overstrike text
797
798 =item Pod::Text::Termcap
799
800 Convert POD data to ASCII text with format escapes
801
802 =item Pod::Usage
803
804 Print a usage message from embedded pod documentation
805
806 =item Pod::t::basic
807
808 Test of various basic POD features in translators.
809
810 =item SDBM_File
811
812 Tied access to sdbm files
813
814 =item Safe
815
816 Compile and execute code in restricted compartments
817
818 =item Search::Dict
819
820 Search for key in dictionary file
821
822 =item SelectSaver
823
824 Save and restore selected file handle
825
826 =item SelfLoader
827
828 Load functions only on demand
829
830 =item Shell
831
832 Run shell commands transparently within perl
833
834 =item Socket
835
836 Load the C socket.h defines and structure manipulators 
837
838 =item Storable
839
840 Persistency for perl data structures
841
842 =item Switch
843
844 A switch statement for Perl
845
846 =item Symbol
847
848 Manipulate Perl symbols and their names
849
850 =item Term::ANSIColor
851
852 Color screen output using ANSI escape sequences
853
854 =item Term::Cap
855
856 Perl termcap interface
857
858 =item Term::Complete
859
860 Perl word completion module
861
862 =item Term::ReadLine
863
864 Perl interface to various C<readline> packages. If
865
866 =item Test
867
868 Provides a simple framework for writing test scripts
869
870 =item Test::Builder
871
872 Backend for building test libraries
873
874 =item Test::Harness
875
876 Run perl standard test scripts with statistics
877
878 =item Test::More
879
880 Yet another framework for writing test scripts
881
882 =item Test::Simple
883
884 Basic utilities for writing tests.
885
886 =item Test::Tutorial
887
888 A tutorial about writing really basic tests
889
890 =item Text::Abbrev
891
892 Create an abbreviation table from a list
893
894 =item Text::Balanced
895
896 Extract delimited text sequences from strings.
897
898 =item Text::ParseWords
899
900 Parse text into an array of tokens or array of arrays
901
902 =item Text::Soundex
903
904 Implementation of the Soundex Algorithm as Described by Knuth
905
906 =item Text::Tabs
907
908 Expand and unexpand tabs per the unix expand(1) and unexpand(1)
909
910 =item Text::Wrap
911
912 Line wrapping to form simple paragraphs
913
914 =item Thread
915
916 Manipulate threads in Perl
917
918 =item Tie::Array
919
920 Base class for tied arrays
921
922 =item Tie::Handle
923
924 Base class definitions for tied handles
925
926 =item Tie::Hash
927
928 Base class definitions for tied hashes
929
930 =item Tie::RefHash
931
932 Use references as hash keys
933
934 =item Tie::Scalar
935
936 Base class definitions for tied scalars
937
938 =item Tie::SubstrHash
939
940 Fixed-table-size, fixed-key-length hashing
941
942 =item Time::Local
943
944 Efficiently compute time from local and GMT time
945
946 =item Time::gmtime
947
948 By-name interface to Perl's built-in gmtime() function
949
950 =item Time::localtime
951
952 By-name interface to Perl's built-in localtime() function
953
954 =item Time::tm
955
956 Internal object used by Time::gmtime and Time::localtime
957
958 =item UNIVERSAL
959
960 Base class for ALL classes (blessed references)
961
962 =item Unicode::Collate
963
964 Use UCA (Unicode Collation Algorithm)
965
966 =item Unicode::UCD
967
968 Unicode character database
969
970 =item User::grent
971
972 By-name interface to Perl's built-in getgr*() functions
973
974 =item User::pwent
975
976 By-name interface to Perl's built-in getpw*() functions
977
978 =item Win32
979
980 Interfaces to some Win32 API Functions
981
982 =back
983
984 To find out I<all> modules installed on your system, including
985 those without documentation or outside the standard release,
986 just do this:
987
988     % find `perl -e 'print "@INC"'` -name '*.pm' -print
989
990 They should all have their own documentation installed and accessible
991 via your system man(1) command.  If you do not have a B<find>
992 program, you can use the Perl B<find2perl> program instead, which
993 generates Perl code as output you can run through perl.  If you
994 have a B<man> program but it doesn't find your modules, you'll have
995 to fix your manpath.  See L<perl> for details.  If you have no
996 system B<man> command, you might try the B<perldoc> program.
997
998 =head2 Extension Modules
999
1000 Extension modules are written in C (or a mix of Perl and C).  They
1001 are usually dynamically loaded into Perl if and when you need them,
1002 but may also be linked in statically.  Supported extension modules
1003 include Socket, Fcntl, and POSIX.
1004
1005 Many popular C extension modules do not come bundled (at least, not
1006 completely) due to their sizes, volatility, or simply lack of time
1007 for adequate testing and configuration across the multitude of
1008 platforms on which Perl was beta-tested.  You are encouraged to
1009 look for them on CPAN (described below), or using web search engines
1010 like Alta Vista or Deja News.
1011
1012 =head1 CPAN
1013
1014 CPAN stands for Comprehensive Perl Archive Network; it's a globally
1015 replicated trove of Perl materials, including documentation, style
1016 guides, tricks and traps, alternate ports to non-Unix systems and
1017 occasional binary distributions for these.   Search engines for
1018 CPAN can be found at http://cpan.perl.com/ and at
1019 http://theory.uwinnipeg.ca/mod_perl/cpan-search.pl .
1020
1021 Most importantly, CPAN includes around a thousand unbundled modules,
1022 some of which require a C compiler to build.  Major categories of
1023 modules are:
1024
1025 =over
1026
1027 =item *
1028
1029 Language Extensions and Documentation Tools
1030
1031 =item *
1032
1033 Development Support
1034
1035 =item *
1036
1037 Operating System Interfaces
1038
1039 =item *
1040
1041 Networking, Device Control (modems) and InterProcess Communication
1042
1043 =item *
1044
1045 Data Types and Data Type Utilities
1046
1047 =item *
1048
1049 Database Interfaces
1050
1051 =item *
1052
1053 User Interfaces
1054
1055 =item *
1056
1057 Interfaces to / Emulations of Other Programming Languages
1058
1059 =item *
1060
1061 File Names, File Systems and File Locking (see also File Handles)
1062
1063 =item *
1064
1065 String Processing, Language Text Processing, Parsing, and Searching
1066
1067 =item *
1068
1069 Option, Argument, Parameter, and Configuration File Processing
1070
1071 =item *
1072
1073 Internationalization and Locale
1074
1075 =item *
1076
1077 Authentication, Security, and Encryption
1078
1079 =item *
1080
1081 World Wide Web, HTML, HTTP, CGI, MIME
1082
1083 =item *
1084
1085 Server and Daemon Utilities
1086
1087 =item *
1088
1089 Archiving and Compression
1090
1091 =item *
1092
1093 Images, Pixmap and Bitmap Manipulation, Drawing, and Graphing
1094
1095 =item *
1096
1097 Mail and Usenet News
1098
1099 =item *
1100
1101 Control Flow Utilities (callbacks and exceptions etc)
1102
1103 =item *
1104
1105 File Handle and Input/Output Stream Utilities
1106
1107 =item *
1108
1109 Miscellaneous Modules
1110
1111 =back
1112
1113 Registered CPAN sites as of this writing include the following.
1114 You should try to choose one close to you:
1115
1116 =head2 Africa
1117
1118 =over 4
1119
1120 =item *
1121
1122 South Africa
1123
1124     ftp://ftp.is.co.za/programming/perl/CPAN/
1125     ftp://ftp.mweb.co.za/pub/mirrors/cpan/
1126     ftp://ftp.saix.net/pub/CPAN/
1127     ftp://ftp.sun.ac.za/CPAN/
1128
1129 =back
1130
1131 =head2 Asia
1132
1133 =over 4
1134
1135 =item *
1136
1137 China
1138
1139     ftp://freesoft.cei.gov.cn/pub/languages/perl/CPAN/
1140     http://www2.linuxforum.net/mirror/CPAN/
1141     http://CPAN.pacific.net.hk/
1142     ftp://ftp.pacific.net.hk/pub/mirror/CPAN/
1143     http://cpan.shellhung.org/
1144     ftp://ftp.shellhung.org/pub/CPAN
1145
1146 =item *
1147
1148 India
1149
1150     http://cpan.in.freeos.com
1151     ftp://cpan.in.freeos.com/pub/CPAN/
1152
1153 =item *
1154
1155 Indonesia
1156
1157     http://cpan.itb.web.id/
1158     ftp://mirrors.piksi.itb.ac.id/CPAN/
1159     http://CPAN.mweb.co.id/
1160     ftp://ftp.mweb.co.id/pub/languages/perl/CPAN/
1161
1162 =item *
1163
1164 Israel
1165
1166     http://www.iglu.org.il:/pub/CPAN/
1167     ftp://ftp.iglu.org.il/pub/CPAN/
1168     http://cpan.lerner.co.il/
1169     http://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
1170     ftp://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
1171
1172 =item *
1173
1174 Japan
1175
1176     ftp://ftp.u-aizu.ac.jp/pub/CPAN
1177     ftp://ftp.kddlabs.co.jp/CPAN/
1178     http://mirror.nucba.ac.jp/mirror/Perl/
1179     ftp://mirror.nucba.ac.jp/mirror/Perl/
1180     ftp://ftp.meisei-u.ac.jp/pub/CPAN/
1181     ftp://ftp.jaist.ac.jp/pub/lang/perl/CPAN/
1182     ftp://ftp.dti.ad.jp/pub/lang/CPAN/
1183     ftp://ftp.ring.gr.jp/pub/lang/perl/CPAN/
1184
1185 =item *
1186
1187 Korea
1188
1189     http://mirror.Mazic.org/pub/CPAN
1190     ftp://mirror.Mazic.org/pub/CPAN
1191
1192 =item *
1193
1194 Philippines
1195
1196     http://www.adzu.edu.ph/CPAN
1197
1198 =item *
1199
1200 Russian Federation
1201
1202     http://cpan.tomsk.ru
1203     ftp://cpan.tomsk.ru/pub/CPAN
1204
1205 =item *
1206
1207 Saudi Arabia
1208
1209     ftp://ftp.isu.net.sa/pub/CPAN/
1210
1211 =item *
1212
1213 Singapore
1214
1215     http://cpan.hjc.edu.sg
1216
1217 =item *
1218
1219 South Korea
1220
1221     http://CPAN.bora.net/
1222     ftp://ftp.bora.net/pub/CPAN/
1223     http://ftp.kornet.net/pub/CPAN/
1224     ftp://ftp.kornet.net/pub/CPAN/
1225     ftp://ftp.nuri.net/pub/CPAN/
1226
1227 =item *
1228
1229 Taiwan
1230
1231     ftp://coda.nctu.edu.tw/UNIX/perl/CPAN
1232     ftp://ftp.ee.ncku.edu.tw/pub/perl/CPAN/
1233     ftp://ftp1.sinica.edu.tw/pub1/perl/CPAN/
1234     http://ftp.tku.edu.tw/pub/CPAN/
1235     ftp://ftp.tku.edu.tw/pub/CPAN/
1236
1237 =item *
1238
1239 Thailand
1240
1241     http://download.nectec.or.th/CPAN/
1242     ftp://ftp.nectec.or.th/pub/languages/CPAN/
1243     ftp://ftp.cs.riubon.ac.th/pub/mirrors/CPAN/
1244
1245 =back
1246
1247 =head2 Central America
1248
1249 =over 4
1250
1251 =item *
1252
1253 Costa Rica
1254
1255     ftp://ftp.linux.co.cr/mirrors/CPAN/
1256     http://ftp.ucr.ac.cr/Unix/CPAN/
1257     ftp://ftp.ucr.ac.cr/pub/Unix/CPAN/
1258
1259 =back
1260
1261 =head2 Europe
1262
1263 =over 4
1264
1265 =item *
1266
1267 Austria
1268
1269     ftp://ftp.tuwien.ac.at/pub/CPAN/
1270
1271 =item *
1272
1273 Belgium
1274
1275     http://ftp.easynet.be/pub/CPAN/
1276     ftp://ftp.easynet.be/pub/CPAN/
1277     http://cpan.skynet.be
1278     ftp://ftp.skynet.be/pub/CPAN
1279     ftp://ftp.kulnet.kuleuven.ac.be/pub/mirror/CPAN/
1280
1281 =item *
1282
1283 Bulgaria
1284
1285     ftp://ftp.ntrl.net/pub/mirrors/CPAN/
1286
1287 =item *
1288
1289 Croatia
1290
1291     ftp://ftp.linux.hr/pub/CPAN/
1292
1293 =item *
1294
1295 Czech Republic
1296
1297     http://ftp.fi.muni.cz/pub/CPAN/
1298     ftp://ftp.fi.muni.cz/pub/CPAN/
1299     ftp://sunsite.mff.cuni.cz/MIRRORS/ftp.funet.fi/pub/languages/perl/CPAN/
1300
1301 =item *
1302
1303 Denmark
1304
1305     http://mirrors.sunsite.dk/cpan/
1306     ftp://sunsite.dk/mirrors/cpan/
1307     http://www.cpan.dk/CPAN/
1308     ftp://www.cpan.dk/ftp.cpan.org/CPAN/
1309
1310 =item *
1311
1312 England
1313
1314     http://www.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN
1315     ftp://ftp.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN/
1316     http://cpan.crazygreek.co.uk
1317     ftp://ftp.demon.co.uk/pub/CPAN/
1318     ftp://ftp.flirble.org/pub/languages/perl/CPAN/
1319     ftp://ftp.plig.org/pub/CPAN/
1320     ftp://sunsite.doc.ic.ac.uk/packages/CPAN/
1321     http://mirror.uklinux.net/CPAN/
1322     ftp://mirror.uklinux.net/pub/CPAN/
1323     ftp://usit.shef.ac.uk/pub/packages/CPAN/
1324
1325 =item *
1326
1327 Estonia
1328
1329     ftp://ftp.ut.ee/pub/languages/perl/CPAN/
1330
1331 =item *
1332
1333 Finland
1334
1335     ftp://ftp.funet.fi/pub/languages/perl/CPAN/
1336     http://cpan.kpnqwest.fi/
1337
1338 =item *
1339
1340 France
1341
1342     ftp://cpan.ftp.worldonline.fr/pub/CPAN/
1343     http://cpan.mirrors.easynet.fr/
1344     ftp://cpan.mirrors.easynet.fr/pub/ftp.cpan.org/
1345     ftp://ftp.club-internet.fr/pub/perl/CPAN/
1346     http://fr.cpan.org/
1347     ftp://ftp.lip6.fr/pub/perl/CPAN/
1348     ftp://ftp.oleane.net/pub/mirrors/CPAN/
1349     ftp://ftp.pasteur.fr/pub/computing/CPAN/
1350     http://cpan.cict.fr/
1351     ftp://cpan.cict.fr/pub/CPAN/
1352     ftp://ftp.uvsq.fr/pub/perl/CPAN/
1353
1354 =item *
1355
1356 Germany
1357
1358     ftp://ftp.rz.ruhr-uni-bochum.de/pub/CPAN/
1359     ftp://ftp.freenet.de/pub/ftp.cpan.org/pub/CPAN/
1360     ftp://ftp.uni-erlangen.de/pub/source/CPAN/
1361     ftp://ftp-stud.fht-esslingen.de/pub/Mirrors/CPAN
1362     ftp://ftp.gigabell.net/pub/CPAN/
1363     http://ftp.gwdg.de/pub/languages/perl/CPAN/
1364     ftp://ftp.gwdg.de/pub/languages/perl/CPAN/
1365     ftp://ftp.uni-hamburg.de/pub/soft/lang/perl/CPAN/
1366     ftp://ftp.leo.org/pub/CPAN/
1367     http://cpan.noris.de/
1368     ftp://cpan.noris.de/pub/CPAN/
1369     ftp://ftp.mpi-sb.mpg.de/pub/perl/CPAN/
1370     ftp://ftp.gmd.de/mirrors/CPAN/
1371
1372 =item *
1373
1374 Greece
1375
1376     ftp://ftp.forthnet.gr/pub/languages/perl/CPAN
1377     ftp://ftp.ntua.gr/pub/lang/perl/
1378
1379 =item *
1380
1381 Hungary
1382
1383     http://cpan.artifact.hu/
1384     ftp://cpan.artifact.hu/CPAN/
1385     http://ftp.kfki.hu/pub/CPAN/
1386     ftp://ftp.kfki.hu/pub/CPAN/
1387
1388 =item *
1389
1390 Iceland
1391
1392     http://ftp.rhnet.is/pub/CPAN/
1393     ftp://ftp.rhnet.is/pub/CPAN/
1394
1395 =item *
1396
1397 Ireland
1398
1399     http://cpan.indigo.ie/
1400     ftp://cpan.indigo.ie/pub/CPAN/
1401     http://sunsite.compapp.dcu.ie/pub/perl/
1402     ftp://sunsite.compapp.dcu.ie/pub/perl/
1403
1404 =item *
1405
1406 Italy
1407
1408     http://cpan.nettuno.it/
1409     http://gusp.dyndns.org/CPAN/
1410     ftp://gusp.dyndns.org/pub/CPAN
1411     http://softcity.iol.it/cpan
1412     ftp://softcity.iol.it/pub/cpan
1413     ftp://ftp.unina.it/pub/Other/CPAN/
1414     ftp://ftp.unipi.it/pub/mirror/perl/CPAN/
1415     ftp://cis.uniRoma2.it/CPAN/
1416     ftp://ftp.edisontel.it/pub/CPAN_Mirror/
1417     ftp://ftp.flashnet.it/pub/CPAN/
1418
1419 =item *
1420
1421 Latvia
1422
1423     http://kvin.lv/pub/CPAN/
1424
1425 =item *
1426
1427 Lithuania
1428
1429     ftp://ftp.unix.lt/pub/CPAN/
1430
1431 =item *
1432
1433 Netherlands
1434
1435     ftp://download.xs4all.nl/pub/mirror/CPAN/
1436     ftp://ftp.nl.uu.net/pub/CPAN/
1437     ftp://ftp.nluug.nl/pub/languages/perl/CPAN/
1438     http://cpan.cybercomm.nl/
1439     ftp://mirror.cybercomm.nl/pub/cpan/
1440     ftp://ftp.cpan.nl/pub/CPAN/
1441     http://www.cs.uu.nl/mirror/CPAN/
1442     ftp://ftp.cs.uu.nl/mirror/CPAN/
1443
1444 =item *
1445
1446 Norway
1447
1448     ftp://ftp.uninett.no/pub/languages/perl/CPAN
1449     ftp://ftp.uit.no/pub/languages/perl/cpan/
1450
1451 =item *
1452
1453 Poland
1454
1455     ftp://ftp.pk.edu.pl/pub/lang/perl/CPAN/
1456     http://www.fic.uni.lodz.pl/pub/CPAN
1457     ftp://ftp.fic.uni.lodz.pl/pub/CPAN
1458     ftp://ftp.mega.net.pl/pub/mirrors/ftp.perl.com/
1459     ftp://ftp.man.torun.pl/pub/doc/CPAN/
1460     ftp://sunsite.icm.edu.pl/pub/CPAN/
1461
1462 =item *
1463
1464 Portugal
1465
1466     ftp://ftp.ua.pt/pub/CPAN/
1467     ftp://perl.di.uminho.pt/pub/CPAN/
1468     http://cpan.ip.pt/
1469     ftp://cpan.ip.pt/pub/perl/
1470     ftp://ftp.ist.utl.pt/pub/CPAN/
1471     http://cpan.ip.pt/
1472     ftp://cpan.ip.pt/pub/cpan/
1473     ftp://ftp.netc.pt/pub/CPAN/
1474     ftp://ftp.up.pt/pub/CPAN
1475
1476 =item *
1477
1478 Romania
1479
1480     ftp://archive.logicnet.ro/mirrors/ftp.cpan.org/CPAN/
1481     ftp://ftp.kappa.ro/pub/mirrors/ftp.perl.org/pub/CPAN/
1482     ftp://ftp.dntis.ro/pub/cpan/
1483     ftp://ftp.opsynet.com/cpan/
1484     ftp://ftp.dnttm.ro/pub/CPAN/
1485     ftp://ftp.lasting.ro/pub/CPAN
1486     ftp://ftp.timisoara.roedu.net/mirrors/CPAN/
1487
1488 =item *
1489
1490 Russia
1491
1492     ftp://ftp.chg.ru/pub/lang/perl/CPAN/
1493     http://cpan.rinet.ru/
1494     ftp://cpan.rinet.ru/pub/mirror/CPAN/
1495     ftp://ftp.aha.ru/pub/CPAN/
1496     http://cpan.sai.msu.ru/
1497     ftp://ftp.sai.msu.su/pub/lang/perl/CPAN/
1498
1499 =item *
1500
1501 Slovakia
1502
1503     ftp://ftp.entry.sk/pub/languages/perl/CPAN/
1504
1505 =item *
1506
1507 Slovenia
1508
1509     ftp://ftp.arnes.si/software/perl/CPAN/
1510
1511 =item *
1512
1513 Spain
1514
1515     ftp://ftp.rediris.es/mirror/CPAN/
1516     ftp://ftp.etse.urv.es/pub/perl/
1517
1518 =item *
1519
1520 Sweden
1521
1522     http://ftp.du.se/CPAN/
1523     ftp://ftp.du.se/pub/CPAN/
1524     ftp://mirror.dataphone.se/pub/CPAN
1525     ftp://ftp.sunet.se/pub/lang/perl/CPAN/
1526
1527 =item *
1528
1529 Switzerland
1530
1531     ftp://ftp.danyk.ch/CPAN/
1532     ftp://sunsite.cnlab-switch.ch/mirror/CPAN/
1533
1534 =item *
1535
1536 Turkey
1537
1538     ftp://sunsite.bilkent.edu.tr/pub/languages/CPAN/
1539
1540 =item *
1541
1542 Ukraine
1543
1544     http://cpan.org.ua/
1545     ftp://cpan.org.ua/
1546     ftp://ftp.perl.org.ua/pub/CPAN/
1547
1548 =back
1549
1550 =head2 North America
1551
1552 =over 4
1553
1554 =item *
1555
1556 Canada
1557
1558 =over 8
1559
1560 =item *
1561
1562 Alberta
1563
1564     http://sunsite.ualberta.ca/pub/Mirror/CPAN/
1565     ftp://sunsite.ualberta.ca/pub/Mirror/CPAN/
1566
1567 =item *
1568
1569 Manitoba
1570
1571     http://theoryx5.uwinnipeg.ca/pub/CPAN/
1572     ftp://theoryx5.uwinnipeg.ca/pub/CPAN/
1573
1574 =item *
1575
1576 Nova Scotia
1577
1578     ftp://cpan.chebucto.ns.ca/pub/CPAN/
1579
1580 =item *
1581
1582 Ontario
1583
1584     ftp://ftp.crc.ca/pub/CPAN/
1585
1586 =item *
1587
1588 Quebec
1589
1590     http://cpan.mirror.smartworker.org/
1591     ftp://cpan.mirror.smartworker.org/pub/CPAN
1592
1593 =back
1594
1595 =item *
1596
1597 Mexico
1598
1599     http://cpan.azc.uam.mx
1600     ftp://cpan.azc.uam.mx/mirrors/CPAN
1601     http://cpan.unam.mx/
1602     ftp://cpan.unam.mx/pub/CPAN
1603     http://www.msg.com.mx/CPAN/
1604     ftp://ftp.msg.com.mx/pub/CPAN/
1605
1606 =item *
1607
1608 United States
1609
1610 =over 8
1611
1612 =item *
1613
1614 Alabama
1615
1616     http://mirror.hiwaay.net/CPAN/
1617     ftp://mirror.hiwaay.net/CPAN/
1618
1619 =item *
1620
1621 California
1622
1623     http://www.cpan.org/
1624     ftp://cpan.valueclick.com/pub/CPAN/
1625     http://mirrors.gossamer-threads.com/CPAN
1626     ftp://cpan.nas.nasa.gov/pub/perl/CPAN/
1627     ftp://ftp.digital.com/pub/plan/perl/CPAN/
1628     http://mirrors.kernel.org/cpan/
1629     ftp://mirrors.kernel.org/pub/CPAN
1630     http://cpan.digisle.net/
1631     ftp://cpan.digisle.net/pub/CPAN
1632     http://www.linuxjar.com/CPAN
1633     ftp://linuxjar.com/pub/CPAN
1634     http://www.perl.com/CPAN/
1635     http://download.sourceforge.net/mirrors/CPAN/
1636
1637 =item *
1638
1639 Colorado
1640
1641     ftp://ftp.cs.colorado.edu/pub/perl/CPAN/
1642
1643 =item *
1644
1645 District of Columbia
1646
1647     ftp://ftp.dc.us.telia.net/pub/cpan/
1648
1649 =item *
1650
1651 Florida
1652
1653     ftp://ftp.cise.ufl.edu/pub/mirrors/CPAN/
1654     http://mirror.csit.fsu.edu/pub/CPAN/
1655     ftp://mirror.csit.fsu.edu/pub/CPAN/
1656
1657 =item *
1658
1659 Illinois
1660
1661     http://uiarchive.uiuc.edu/mirrors/ftp/cpan.cse.msu.edu/
1662     ftp://uiarchive.uiuc.edu/mirrors/ftp/cpan.cse.msu.edu/
1663
1664 =item *
1665
1666 Indiana
1667
1668     ftp://ftp.uwsg.indiana.edu/pub/perl/CPAN/
1669     http://cpan.nitco.com/
1670     ftp://cpan.nitco.com/pub/CPAN/
1671     http://archive.progeny.com/CPAN/
1672     ftp://archive.progeny.com/CPAN/
1673     ftp://cpan.in-span.net/
1674     http://csociety-ftp.ecn.purdue.edu/pub/CPAN
1675     ftp://csociety-ftp.ecn.purdue.edu/pub/CPAN
1676
1677 =item *
1678
1679 Kentucky
1680
1681     http://cpan.uky.edu/
1682     ftp://cpan.uky.edu/pub/CPAN/
1683
1684 =item *
1685
1686 Massachusetts
1687
1688     ftp://ftp.ccs.neu.edu/net/mirrors/ftp.funet.fi/pub/languages/perl/CPAN/
1689     http://cpan.mirrors.netnumina.com/
1690     ftp://mirrors.netnumina.com/cpan/
1691     ftp://ftp.iguide.com/pub/mirrors/packages/perl/CPAN/
1692
1693 =item *
1694
1695 Michigan
1696
1697     ftp://cpan.cse.msu.edu/
1698
1699 =item *
1700
1701 New Jersey
1702
1703     ftp://ftp.cpanel.net/pub/CPAN/
1704
1705 =item *
1706
1707 New York
1708
1709     ftp://ftp.freesoftware.com/pub/perl/CPAN/
1710     ftp://ftp.stealth.net/pub/CPAN/
1711     http://www.rge.com/pub/languages/perl/
1712     ftp://ftp.rge.com/pub/languages/perl/
1713     ftp://mirrors.cloud9.net/pub/mirrors/CPAN/
1714
1715 =item *
1716
1717 North Carolina
1718
1719     ftp://ftp.duke.edu/pub/perl/
1720
1721 =item *
1722
1723 Ohio
1724
1725     ftp://ftp.loaded.net/pub/CPAN/
1726
1727 =item *
1728
1729 Oklahoma
1730
1731     ftp://ftp.ou.edu/mirrors/CPAN/
1732
1733 =item *
1734
1735 Oregon
1736
1737     ftp://ftp.orst.edu/pub/CPAN
1738
1739 =item *
1740
1741 Pennsylvania
1742
1743     http://ftp.epix.net/CPAN/
1744     ftp://ftp.epix.net/pub/languages/perl/
1745     http://mirrors.phenominet.com/pub/CPAN/
1746     ftp://mirrors.phenominet.com/pub/CPAN/
1747     ftp://carroll.cac.psu.edu/pub/CPAN/
1748
1749 =item *
1750
1751 Tennessee
1752
1753     ftp://ftp.sunsite.utk.edu/pub/CPAN/
1754
1755 =item *
1756
1757 Texas
1758
1759     http://ftp.sedl.org/pub/mirrors/CPAN/
1760
1761 =item *
1762
1763 Utah
1764
1765     ftp://mirror.xmission.com/CPAN/
1766
1767 =item *
1768
1769 Virginia
1770
1771     http://mirrors.rcn.net/pub/lang/CPAN/
1772     ftp://mirrors.rcn.net/pub/lang/CPAN/
1773     ftp://ruff.cs.jmu.edu/pub/CPAN/
1774     http://perl.Liquidation.com/CPAN/
1775
1776 =item *
1777
1778 Washington
1779
1780     http://cpan.llarian.net/
1781     ftp://cpan.llarian.net/pub/CPAN/
1782     http://cpan.mirrorcentral.com/
1783     ftp://ftp.mirrorcentral.com/pub/CPAN/
1784     ftp://ftp-mirror.internap.com/pub/CPAN/
1785
1786 =back
1787
1788 =back
1789
1790 =head2 Oceania
1791
1792 =over 4
1793
1794 =item *
1795
1796 Australia
1797
1798     http://ftp.planetmirror.com/pub/CPAN/
1799     ftp://ftp.planetmirror.com/pub/CPAN/
1800     ftp://mirror.aarnet.edu.au/pub/perl/CPAN/
1801     ftp://cpan.topend.com.au/pub/CPAN/
1802
1803 =item *
1804
1805 New Zealand
1806     ftp://ftp.auckland.ac.nz/pub/perl/CPAN/
1807
1808 =back
1809
1810 =head2 South America
1811
1812 =over 4
1813
1814 =item *
1815
1816 Argentina
1817
1818     ftp://mirrors.bannerlandia.com.ar/mirrors/CPAN/
1819
1820 =item *
1821
1822 Brazil
1823
1824     ftp://cpan.pop-mg.com.br/pub/CPAN/
1825     ftp://ftp.matrix.com.br/pub/perl/CPAN/
1826
1827 =item *
1828
1829 Chile
1830
1831     ftp://ftp.psinet.cl/pub/programming/perl/CPAN/
1832     ftp://sunsite.dcc.uchile.cl/pub/lang/perl/
1833
1834 =back
1835
1836
1837 For an up-to-date listing of CPAN sites,
1838 see http://www.cpan.org/SITES or ftp://www.cpan.org/SITES .
1839
1840 =head1 Modules: Creation, Use, and Abuse
1841
1842 (The following section is borrowed directly from Tim Bunce's modules
1843 file, available at your nearest CPAN site.)
1844
1845 Perl implements a class using a package, but the presence of a
1846 package doesn't imply the presence of a class.  A package is just a
1847 namespace.  A class is a package that provides subroutines that can be
1848 used as methods.  A method is just a subroutine that expects, as its
1849 first argument, either the name of a package (for "static" methods),
1850 or a reference to something (for "virtual" methods).
1851
1852 A module is a file that (by convention) provides a class of the same
1853 name (sans the .pm), plus an import method in that class that can be
1854 called to fetch exported symbols.  This module may implement some of
1855 its methods by loading dynamic C or C++ objects, but that should be
1856 totally transparent to the user of the module.  Likewise, the module
1857 might set up an AUTOLOAD function to slurp in subroutine definitions on
1858 demand, but this is also transparent.  Only the F<.pm> file is required to
1859 exist.  See L<perlsub>, L<perltoot>, and L<AutoLoader> for details about
1860 the AUTOLOAD mechanism.
1861
1862 =head2 Guidelines for Module Creation
1863
1864 =over 4
1865
1866 =item  *
1867
1868 Do similar modules already exist in some form?
1869
1870 If so, please try to reuse the existing modules either in whole or
1871 by inheriting useful features into a new class.  If this is not
1872 practical try to get together with the module authors to work on
1873 extending or enhancing the functionality of the existing modules.
1874 A perfect example is the plethora of packages in perl4 for dealing
1875 with command line options.
1876
1877 If you are writing a module to expand an already existing set of
1878 modules, please coordinate with the author of the package.  It
1879 helps if you follow the same naming scheme and module interaction
1880 scheme as the original author.
1881
1882 =item  *
1883
1884 Try to design the new module to be easy to extend and reuse.
1885
1886 Try to C<use warnings;> (or C<use warnings qw(...);>).
1887 Remember that you can add C<no warnings qw(...);> to individual blocks
1888 of code that need less warnings.
1889
1890 Use blessed references.  Use the two argument form of bless to bless
1891 into the class name given as the first parameter of the constructor,
1892 e.g.,:
1893
1894  sub new {
1895      my $class = shift;
1896      return bless {}, $class;
1897  }
1898
1899 or even this if you'd like it to be used as either a static
1900 or a virtual method.
1901
1902  sub new {
1903      my $self  = shift;
1904      my $class = ref($self) || $self;
1905      return bless {}, $class;
1906  }
1907
1908 Pass arrays as references so more parameters can be added later
1909 (it's also faster).  Convert functions into methods where
1910 appropriate.  Split large methods into smaller more flexible ones.
1911 Inherit methods from other modules if appropriate.
1912
1913 Avoid class name tests like: C<die "Invalid" unless ref $ref eq 'FOO'>.
1914 Generally you can delete the C<eq 'FOO'> part with no harm at all.
1915 Let the objects look after themselves! Generally, avoid hard-wired
1916 class names as far as possible.
1917
1918 Avoid C<< $r->Class::func() >> where using C<@ISA=qw(... Class ...)> and
1919 C<< $r->func() >> would work (see L<perlbot> for more details).
1920
1921 Use autosplit so little used or newly added functions won't be a
1922 burden to programs that don't use them. Add test functions to
1923 the module after __END__ either using AutoSplit or by saying:
1924
1925  eval join('',<main::DATA>) || die $@ unless caller();
1926
1927 Does your module pass the 'empty subclass' test? If you say
1928 C<@SUBCLASS::ISA = qw(YOURCLASS);> your applications should be able
1929 to use SUBCLASS in exactly the same way as YOURCLASS.  For example,
1930 does your application still work if you change:  C<$obj = new YOURCLASS;>
1931 into: C<$obj = new SUBCLASS;> ?
1932
1933 Avoid keeping any state information in your packages. It makes it
1934 difficult for multiple other packages to use yours. Keep state
1935 information in objects.
1936
1937 Always use B<-w>.
1938
1939 Try to C<use strict;> (or C<use strict qw(...);>).
1940 Remember that you can add C<no strict qw(...);> to individual blocks
1941 of code that need less strictness.
1942
1943 Always use B<-w>.
1944
1945 Follow the guidelines in the perlstyle(1) manual.
1946
1947 Always use B<-w>.
1948
1949 =item  *
1950
1951 Some simple style guidelines
1952
1953 The perlstyle manual supplied with Perl has many helpful points.
1954
1955 Coding style is a matter of personal taste. Many people evolve their
1956 style over several years as they learn what helps them write and
1957 maintain good code.  Here's one set of assorted suggestions that
1958 seem to be widely used by experienced developers:
1959
1960 Use underscores to separate words.  It is generally easier to read
1961 $var_names_like_this than $VarNamesLikeThis, especially for
1962 non-native speakers of English. It's also a simple rule that works
1963 consistently with VAR_NAMES_LIKE_THIS.
1964
1965 Package/Module names are an exception to this rule. Perl informally
1966 reserves lowercase module names for 'pragma' modules like integer
1967 and strict. Other modules normally begin with a capital letter and
1968 use mixed case with no underscores (need to be short and portable).
1969
1970 You may find it helpful to use letter case to indicate the scope
1971 or nature of a variable. For example:
1972
1973  $ALL_CAPS_HERE   constants only (beware clashes with Perl vars)
1974  $Some_Caps_Here  package-wide global/static
1975  $no_caps_here    function scope my() or local() variables
1976
1977 Function and method names seem to work best as all lowercase.
1978 e.g., C<< $obj->as_string() >>.
1979
1980 You can use a leading underscore to indicate that a variable or
1981 function should not be used outside the package that defined it.
1982
1983 =item  *
1984
1985 Select what to export.
1986
1987 Do NOT export method names!
1988
1989 Do NOT export anything else by default without a good reason!
1990
1991 Exports pollute the namespace of the module user.  If you must
1992 export try to use @EXPORT_OK in preference to @EXPORT and avoid
1993 short or common names to reduce the risk of name clashes.
1994
1995 Generally anything not exported is still accessible from outside the
1996 module using the ModuleName::item_name (or C<< $blessed_ref->method >>)
1997 syntax.  By convention you can use a leading underscore on names to
1998 indicate informally that they are 'internal' and not for public use.
1999
2000 (It is actually possible to get private functions by saying:
2001 C<my $subref = sub { ... };  &$subref;>.  But there's no way to call that
2002 directly as a method, because a method must have a name in the symbol
2003 table.)
2004
2005 As a general rule, if the module is trying to be object oriented
2006 then export nothing. If it's just a collection of functions then
2007 @EXPORT_OK anything but use @EXPORT with caution.
2008
2009 =item  *
2010
2011 Select a name for the module.
2012
2013 This name should be as descriptive, accurate, and complete as
2014 possible.  Avoid any risk of ambiguity. Always try to use two or
2015 more whole words.  Generally the name should reflect what is special
2016 about what the module does rather than how it does it.  Please use
2017 nested module names to group informally or categorize a module.
2018 There should be a very good reason for a module not to have a nested name.
2019 Module names should begin with a capital letter.
2020
2021 Having 57 modules all called Sort will not make life easy for anyone
2022 (though having 23 called Sort::Quick is only marginally better :-).
2023 Imagine someone trying to install your module alongside many others.
2024 If in any doubt ask for suggestions in comp.lang.perl.misc.
2025
2026 If you are developing a suite of related modules/classes it's good
2027 practice to use nested classes with a common prefix as this will
2028 avoid namespace clashes. For example: Xyz::Control, Xyz::View,
2029 Xyz::Model etc. Use the modules in this list as a naming guide.
2030
2031 If adding a new module to a set, follow the original author's
2032 standards for naming modules and the interface to methods in
2033 those modules.
2034
2035 If developing modules for private internal or project specific use,
2036 that will never be released to the public, then you should ensure
2037 that their names will not clash with any future public module. You
2038 can do this either by using the reserved Local::* category or by
2039 using a category name that includes an underscore like Foo_Corp::*.
2040
2041 To be portable each component of a module name should be limited to
2042 11 characters. If it might be used on MS-DOS then try to ensure each is
2043 unique in the first 8 characters. Nested modules make this easier.
2044
2045 =item  *
2046
2047 Have you got it right?
2048
2049 How do you know that you've made the right decisions? Have you
2050 picked an interface design that will cause problems later? Have
2051 you picked the most appropriate name? Do you have any questions?
2052
2053 The best way to know for sure, and pick up many helpful suggestions,
2054 is to ask someone who knows. Comp.lang.perl.misc is read by just about
2055 all the people who develop modules and it's the best place to ask.
2056
2057 All you need to do is post a short summary of the module, its
2058 purpose and interfaces. A few lines on each of the main methods is
2059 probably enough. (If you post the whole module it might be ignored
2060 by busy people - generally the very people you want to read it!)
2061
2062 Don't worry about posting if you can't say when the module will be
2063 ready - just say so in the message. It might be worth inviting
2064 others to help you, they may be able to complete it for you!
2065
2066 =item  *
2067
2068 README and other Additional Files.
2069
2070 It's well known that software developers usually fully document the
2071 software they write. If, however, the world is in urgent need of
2072 your software and there is not enough time to write the full
2073 documentation please at least provide a README file containing:
2074
2075 =over 10
2076
2077 =item *
2078
2079 A description of the module/package/extension etc.
2080
2081 =item *
2082
2083 A copyright notice - see below.
2084
2085 =item *
2086
2087 Prerequisites - what else you may need to have.
2088
2089 =item *
2090
2091 How to build it - possible changes to Makefile.PL etc.
2092
2093 =item *
2094
2095 How to install it.
2096
2097 =item *
2098
2099 Recent changes in this release, especially incompatibilities
2100
2101 =item *
2102
2103 Changes / enhancements you plan to make in the future.
2104
2105 =back
2106
2107 If the README file seems to be getting too large you may wish to
2108 split out some of the sections into separate files: INSTALL,
2109 Copying, ToDo etc.
2110
2111 =over 4
2112
2113 =item *
2114
2115 Adding a Copyright Notice.
2116
2117 How you choose to license your work is a personal decision.
2118 The general mechanism is to assert your Copyright and then make
2119 a declaration of how others may copy/use/modify your work.
2120
2121 Perl, for example, is supplied with two types of licence: The GNU
2122 GPL and The Artistic Licence (see the files README, Copying, and
2123 Artistic).  Larry has good reasons for NOT just using the GNU GPL.
2124
2125 My personal recommendation, out of respect for Larry, Perl, and the
2126 Perl community at large is to state something simply like:
2127
2128  Copyright (c) 1995 Your Name. All rights reserved.
2129  This program is free software; you can redistribute it and/or
2130  modify it under the same terms as Perl itself.
2131
2132 This statement should at least appear in the README file. You may
2133 also wish to include it in a Copying file and your source files.
2134 Remember to include the other words in addition to the Copyright.
2135
2136 =item  *
2137
2138 Give the module a version/issue/release number.
2139
2140 To be fully compatible with the Exporter and MakeMaker modules you
2141 should store your module's version number in a non-my package
2142 variable called $VERSION.  This should be a floating point
2143 number with at least two digits after the decimal (i.e., hundredths,
2144 e.g, C<$VERSION = "0.01">).  Don't use a "1.3.2" style version.
2145 See L<Exporter> for details.
2146
2147 It may be handy to add a function or method to retrieve the number.
2148 Use the number in announcements and archive file names when
2149 releasing the module (ModuleName-1.02.tar.Z).
2150 See perldoc ExtUtils::MakeMaker.pm for details.
2151
2152 =item  *
2153
2154 How to release and distribute a module.
2155
2156 It's good idea to post an announcement of the availability of your
2157 module (or the module itself if small) to the comp.lang.perl.announce
2158 Usenet newsgroup.  This will at least ensure very wide once-off
2159 distribution.
2160
2161 If possible, register the module with CPAN.  You should
2162 include details of its location in your announcement.
2163
2164 Some notes about ftp archives: Please use a long descriptive file
2165 name that includes the version number. Most incoming directories
2166 will not be readable/listable, i.e., you won't be able to see your
2167 file after uploading it. Remember to send your email notification
2168 message as soon as possible after uploading else your file may get
2169 deleted automatically. Allow time for the file to be processed
2170 and/or check the file has been processed before announcing its
2171 location.
2172
2173 FTP Archives for Perl Modules:
2174
2175 Follow the instructions and links on:
2176
2177    http://www.cpan.org/modules/00modlist.long.html
2178    http://www.cpan.org/modules/04pause.html
2179
2180 or upload to one of these sites:
2181
2182    https://pause.kbx.de/pause/
2183    http://pause.perl.org/pause/
2184
2185 and notify <modules@perl.org>.
2186
2187 By using the WWW interface you can ask the Upload Server to mirror
2188 your modules from your ftp or WWW site into your own directory on
2189 CPAN!
2190
2191 Please remember to send me an updated entry for the Module list!
2192
2193 =item  *
2194
2195 Take care when changing a released module.
2196
2197 Always strive to remain compatible with previous released versions.
2198 Otherwise try to add a mechanism to revert to the
2199 old behavior if people rely on it.  Document incompatible changes.
2200
2201 =back
2202
2203 =back
2204
2205 =head2 Guidelines for Converting Perl 4 Library Scripts into Modules
2206
2207 =over 4
2208
2209 =item  *
2210
2211 There is no requirement to convert anything.
2212
2213 If it ain't broke, don't fix it! Perl 4 library scripts should
2214 continue to work with no problems. You may need to make some minor
2215 changes (like escaping non-array @'s in double quoted strings) but
2216 there is no need to convert a .pl file into a Module for just that.
2217
2218 =item  *
2219
2220 Consider the implications.
2221
2222 All Perl applications that make use of the script will need to
2223 be changed (slightly) if the script is converted into a module.  Is
2224 it worth it unless you plan to make other changes at the same time?
2225
2226 =item  *
2227
2228 Make the most of the opportunity.
2229
2230 If you are going to convert the script to a module you can use the
2231 opportunity to redesign the interface.  The guidelines for module
2232 creation above include many of the issues you should consider.
2233
2234 =item  *
2235
2236 The pl2pm utility will get you started.
2237
2238 This utility will read *.pl files (given as parameters) and write
2239 corresponding *.pm files. The pl2pm utilities does the following:
2240
2241 =over 10
2242
2243 =item *
2244
2245 Adds the standard Module prologue lines
2246
2247 =item *
2248
2249 Converts package specifiers from ' to ::
2250
2251 =item *
2252
2253 Converts die(...) to croak(...)
2254
2255 =item *
2256
2257 Several other minor changes
2258
2259 =back
2260
2261 Being a mechanical process pl2pm is not bullet proof. The converted
2262 code will need careful checking, especially any package statements.
2263 Don't delete the original .pl file till the new .pm one works!
2264
2265 =back
2266
2267 =head2 Guidelines for Reusing Application Code
2268
2269 =over 4
2270
2271 =item  *
2272
2273 Complete applications rarely belong in the Perl Module Library.
2274
2275 =item  *
2276
2277 Many applications contain some Perl code that could be reused.
2278
2279 Help save the world! Share your code in a form that makes it easy
2280 to reuse.
2281
2282 =item  *
2283
2284 Break-out the reusable code into one or more separate module files.
2285
2286 =item  *
2287
2288 Take the opportunity to reconsider and redesign the interfaces.
2289
2290 =item  *
2291
2292 In some cases the 'application' can then be reduced to a small
2293
2294 fragment of code built on top of the reusable modules. In these cases
2295 the application could invoked as:
2296
2297      % perl -e 'use Module::Name; method(@ARGV)' ...
2298 or
2299      % perl -mModule::Name ...    (in perl5.002 or higher)
2300
2301 =back
2302
2303 =head1 NOTE
2304
2305 Perl does not enforce private and public parts of its modules as you may
2306 have been used to in other languages like C++, Ada, or Modula-17.  Perl
2307 doesn't have an infatuation with enforced privacy.  It would prefer
2308 that you stayed out of its living room because you weren't invited, not
2309 because it has a shotgun.
2310
2311 The module and its user have a contract, part of which is common law,
2312 and part of which is "written".  Part of the common law contract is
2313 that a module doesn't pollute any namespace it wasn't asked to.  The
2314 written contract for the module (A.K.A. documentation) may make other
2315 provisions.  But then you know when you C<use RedefineTheWorld> that
2316 you're redefining the world and willing to take the consequences.