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