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