pod/perlmodlib.pod

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