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