pod/perlmodlib.pod

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