summaryrefslogtreecommitdiffstats
path: root/contrib/perl5/pod/perlmodlib.pod
diff options
context:
space:
mode:
authormarkm <markm@FreeBSD.org>2002-03-16 20:14:30 +0000
committermarkm <markm@FreeBSD.org>2002-03-16 20:14:30 +0000
commit3eac21f49bc763a6c0044b4afbc0c7ece760144f (patch)
tree4cf1274fa3ca68f7ecf6a3051e0c2243e378afc5 /contrib/perl5/pod/perlmodlib.pod
parent259bd53c06712c4ffb0ab7e06898c19ebf221b21 (diff)
downloadFreeBSD-src-3eac21f49bc763a6c0044b4afbc0c7ece760144f.zip
FreeBSD-src-3eac21f49bc763a6c0044b4afbc0c7ece760144f.tar.gz
Vendor import Perl 5.6.1
Diffstat (limited to 'contrib/perl5/pod/perlmodlib.pod')
-rw-r--r--contrib/perl5/pod/perlmodlib.pod1233
1 files changed, 885 insertions, 348 deletions
diff --git a/contrib/perl5/pod/perlmodlib.pod b/contrib/perl5/pod/perlmodlib.pod
index b42a2d8..90bdb43 100644
--- a/contrib/perl5/pod/perlmodlib.pod
+++ b/contrib/perl5/pod/perlmodlib.pod
@@ -1,3 +1,5 @@
+# Generated by perlmodlib.PL DO NOT EDIT!
+
=head1 NAME
perlmodlib - constructing new Perl modules and finding existing ones
@@ -66,9 +68,9 @@ Establish IS-A relationship with base class at compile time
Use MakeMaker's uninstalled version of a package
-=item caller
+=item bytes
-Inherit pragmatic attributes from caller's context
+Force byte semantics rather than character semantics
=item charnames
@@ -80,23 +82,23 @@ Declare constants
=item diagnostics
-Force verbose warning diagnostics
+Perl compiler pragma to force verbose warning diagnostics
=item fields
-Declare a class's attribute fields at compile-time
+Compile-time class fields
=item filetest
-Control the filetest operators like C<-r>, C<-w> for AFS, etc.
+Control the filetest permission operators
=item integer
-Compute arithmetic in integer instead of double
+Use integer arithmetic instead of floating point
=item less
-Request less of something from the compiler (unimplemented)
+Request less of something from the compiler
=item lib
@@ -104,7 +106,11 @@ Manipulate @INC at compile time
=item locale
-Use or avoid POSIX locales for built-in operations
+Use and avoid POSIX locales for built-in operations
+
+=item open
+
+Set default disciplines for input and output
=item ops
@@ -112,11 +118,11 @@ Restrict unsafe operations when compiling
=item overload
-Overload Perl operations
+Package for overloading perl operations
=item re
-Alter regular expression behavior
+Alter regular expression behaviour
=item sigtrap
@@ -128,20 +134,24 @@ Restrict unsafe constructs
=item subs
-Predeclare subroutine names
+Predeclare sub names
=item utf8
-Turn on UTF-8 and Unicode support
+Enable/disable UTF-8 in source code
=item vars
-Predeclare global variable names (obsoleted by our())
+Predeclare global variable names (obsolete)
=item warnings
Control optional warnings
+=item warnings::register
+
+Warnings import function
+
=back
=head2 Standard Modules
@@ -154,7 +164,7 @@ Exporter module. See their own documentation for details.
=item AnyDBM_File
-Provide framework for multiple DBM libraries
+Provide framework for multiple DBMs
=item AutoLoader
@@ -166,7 +176,7 @@ Split a package for autoloading
=item B
-Guts of the Perl code generator (aka compiler)
+The Perl Compiler
=item B::Asmdata
@@ -192,13 +202,17 @@ Perl compiler's C backend
Perl compiler's optimized C translation backend
+=item B::Concise
+
+Walk Perl syntax tree, printing concise info about ops
+
=item B::Debug
Walk Perl syntax tree, printing debug info about ops
=item B::Deparse
-Perl compiler backend to produce Perl code
+Perl compiler backend to produce perl code
=item B::Disassembler
@@ -206,7 +220,7 @@ Disassemble Perl bytecode
=item B::Lint
-Module to catch dubious constructs
+Perl lint
=item B::Showlex
@@ -216,7 +230,9 @@ Show lexical variables used in functions or files
Helper module for CC backend
-B::Stash -- XXX NFI XXX
+=item B::Stash
+
+Show what stashes are loaded
=item B::Terse
@@ -228,19 +244,19 @@ Generates cross reference reports for Perl programs
=item Benchmark
-Benchmark running times of code
+Benchmark running times of Perl code
=item ByteLoader
-Load byte-compiled Perl code
+Load byte compiled perl code
=item CGI
-Simple Common Gateway Interface class
+Simple Common Gateway Interface Class
=item CGI::Apache
-Make things work with CGI.pm against Perl-Apache API
+Backward compatibility module for CGI.pm
=item CGI::Carp
@@ -264,15 +280,19 @@ Simple Interface to Server Push
=item CGI::Switch
-Try more than one constructors and return the first object available
+Backward compatibility module for defunct CGI::Switch
+
+=item CGI::Util
+
+Internal utilities used by CGI module
=item CPAN
-Query, download, and build Perl modules from CPAN sites
+Query, download and build perl modules from CPAN sites
=item CPAN::FirstTime
-Utility for CPAN::Config file initialization
+Utility for CPAN::Config file Initialization
=item CPAN::Nox
@@ -280,7 +300,7 @@ Wrapper around CPAN.pm without using any XS module
=item Carp
-Act like warn/die from perspective of caller
+Warn of errors (from perspective of caller)
=item Carp::Heavy
@@ -290,34 +310,18 @@ Carp guts
Declare struct-like datatypes as Perl classes
-=item Config
-
-Access Perl configuration information
-
=item Cwd
Get pathname of current working directory
=item DB
-Programmatic interface to the Perl debugging API (experimental)
+Programmatic interface to the Perl debugging API (draft, subject to
=item DB_File
Perl5 access to Berkeley DB version 1.x
-=item Data::Dumper
-
-Serialize Perl data structures
-
-=item Devel::DProf
-
-A Perl execution profiler
-
-=item Devel::Peek
-
-A data debugging tool for the XS programmer
-
=item Devel::SelfStubber
Generate stubs for a SelfLoading module
@@ -328,27 +332,19 @@ Supply object methods for directory handles
=item Dumpvalue
-Provide screen dump of Perl data
-
-=item DynaLoader
-
-Dynamically load C libraries into Perl code
+Provides screen dump of Perl data.
=item English
-Use English (or awk) names for ugly punctuation variables
+Use nice English (or awk) names for ugly punctuation variables
=item Env
-Access environment variables as regular ones
-
-=item Errno
-
-Load the libc errno.h defines
+Perl module that imports environment variables as scalars or arrays
=item Exporter
-Implement default import method for modules
+Implements default import method for modules
=item Exporter::Heavy
@@ -356,11 +352,11 @@ Exporter guts
=item ExtUtils::Command
-Utilities to replace common Unix commands in Makefiles etc.
+Utilities to replace common UNIX commands in Makefiles etc.
=item ExtUtils::Embed
-Utilities for embedding Perl in C/C++ programs
+Utilities for embedding Perl in C/C++ applications
=item ExtUtils::Install
@@ -376,11 +372,11 @@ Determine libraries to use and how to use them
=item ExtUtils::MM_Cygwin
-Methods to override Unix behavior in ExtUtils::MakeMaker
+Methods to override UN*X behaviour in ExtUtils::MakeMaker
=item ExtUtils::MM_OS2
-Methods to override Unix behavior in ExtUtils::MakeMaker
+Methods to override UN*X behaviour in ExtUtils::MakeMaker
=item ExtUtils::MM_Unix
@@ -388,11 +384,11 @@ Methods used by ExtUtils::MakeMaker
=item ExtUtils::MM_VMS
-Methods to override Unix behavior in ExtUtils::MakeMaker
+Methods to override UN*X behaviour in ExtUtils::MakeMaker
=item ExtUtils::MM_Win32
-Methods to override Unix behavior in ExtUtils::MakeMaker
+Methods to override UN*X behaviour in ExtUtils::MakeMaker
=item ExtUtils::MakeMaker
@@ -402,8 +398,6 @@ Create an extension Makefile
Utilities to write and check a MANIFEST file
-ExtUtils::Miniperl, writemain - Write the C code for perlmain.c
-
=item ExtUtils::Mkbootstrap
Make a bootstrap file for use by DynaLoader
@@ -426,7 +420,7 @@ Replace functions with equivalents which succeed or die
=item Fcntl
-Load the libc fcntl.h defines
+Load the C Fcntl.h defines
=item File::Basename
@@ -446,24 +440,24 @@ Copy files or filehandles
=item File::DosGlob
-DOS-like globbing and then some
+DOS like globbing and then some
=item File::Find
-Traverse a file tree
-
-=item File::Glob
-
-Perl extension for BSD filename globbing
+Traverse a file tree
=item File::Path
-Create or remove a series of directories
+Create or remove directory trees
=item File::Spec
Portably perform operations on file names
+=item File::Spec::Epoc
+
+Methods for Epoc file specs
+
=item File::Spec::Functions
Portably perform operations on file names
@@ -488,6 +482,10 @@ Methods for VMS file specs
Methods for Win32 file specs
+=item File::Temp
+
+Return name and handle of a temporary file safely
+
=item File::stat
By-name interface to Perl's built-in stat() functions
@@ -502,11 +500,11 @@ Supply object methods for filehandles
=item FindBin
-Locate installation directory of running Perl program
+Locate directory of original perl script
=item GDBM_File
-Access to the gdbm library
+Perl5 access to the gdbm library.
=item Getopt::Long
@@ -518,55 +516,11 @@ Process single-character switches with switch clustering
=item I18N::Collate
-Compare 8-bit scalar data according to current locale
+Compare 8-bit scalar data according to the current locale
=item IO
-Front-end to load various IO modules
-
-=item IO::Dir
-
-Supply object methods for directory handles
-
-=item IO::File
-
-Supply object methods for filehandles
-
-=item IO::Handle
-
-Supply object methods for I/O handles
-
-=item IO::Pipe
-
-Supply object methods for pipes
-
-=item IO::Poll
-
-Object interface to system poll call
-
-=item IO::Seekable
-
-Supply seek based methods for I/O objects
-
-=item IO::Select
-
-OO interface to the select system call
-
-=item IO::Socket
-
-Object interface to socket communications
-
-=item IO::Socket::INET
-
-Object interface for AF_INET domain sockets
-
-=item IO::Socket::UNIX
-
-Object interface for AF_UNIX domain sockets
-
-=item IPC::Msg
-
-SysV Msg IPC object class
+Load various IO modules
=item IPC::Open2
@@ -576,14 +530,6 @@ Open a process for both reading and writing
Open a process for reading, writing, and error handling
-=item IPC::Semaphore
-
-SysV Semaphore IPC object class
-
-=item IPC::SysV
-
-SysV IPC constants
-
=item Math::BigFloat
Arbitrary length float math package
@@ -626,7 +572,7 @@ Generic interface to Perl Compiler backends
=item Opcode
-Disable named opcodes when compiling Perl code
+Disable named opcodes when compiling perl code
=item POSIX
@@ -636,22 +582,38 @@ Perl interface to IEEE Std 1003.1
Check pod documents for syntax errors
+=item Pod::Find
+
+Find POD documents in directory trees
+
=item Pod::Html
Module to convert pod files to HTML
=item Pod::InputObjects
-Manage POD objects
+Objects representing POD input paragraphs, commands, etc.
+
+=item Pod::LaTeX
+
+Convert Pod data to formatted Latex
=item Pod::Man
Convert POD data to formatted *roff input
+=item Pod::ParseUtils
+
+Helpers for POD parsing and conversion
+
=item Pod::Parser
Base class for creating POD filters and translators
+=item Pod::Plainer
+
+Perl extension for converting Pod to old style Pod.
+
=item Pod::Select
Extract selected sections of POD from input
@@ -664,6 +626,14 @@ Convert POD data to formatted ASCII text
Convert POD data to formatted color ASCII text
+=item Pod::Text::Overstrike
+
+Convert POD data to formatted overstrike text
+
+=item Pod::Text::Termcap
+
+Convert POD data to ASCII text with format escapes
+
=item Pod::Usage
Print a usage message from embedded pod documentation
@@ -690,35 +660,31 @@ Load functions only on demand
=item Shell
-Run shell commands transparently within Perl
+Run shell commands transparently within perl
=item Socket
-Load the libc socket.h defines and structure manipulators
+Load the C socket.h defines and structure manipulators
=item Symbol
Manipulate Perl symbols and their names
-=item Sys::Hostname
-
-Try every conceivable way to get hostname
+=item Term::ANSIColor
-=item Sys::Syslog
-
-Interface to the libc syslog(3) calls
+Color screen output using ANSI escape sequences
=item Term::Cap
-Termcap interface
+Perl termcap interface
=item Term::Complete
-Word completion module
+Perl word completion module
=item Term::ReadLine
-Interface to various `readline' packages.
+Perl interface to various C<readline> packages. If
=item Test
@@ -726,7 +692,7 @@ Provides a simple framework for writing test scripts
=item Test::Harness
-Run Perl standard test scripts with statistics
+Run perl standard test scripts with statistics
=item Text::Abbrev
@@ -734,18 +700,40 @@ Create an abbreviation table from a list
=item Text::ParseWords
-Parse text into a list of tokens or array of arrays
+Parse text into an array of tokens or array of arrays
=item Text::Soundex
-Implementation of the Soundex Algorithm as described by Knuth
+Implementation of the Soundex Algorithm as Described by Knuth
+
+=item Text::Tabs
-Text::Tabs -- expand and unexpand tabs per expand(1) and unexpand(1)
+Expand and unexpand tabs per the unix expand(1) and unexpand(1)
=item Text::Wrap
Line wrapping to form simple paragraphs
+=item Thread
+
+Manipulate threads in Perl (EXPERIMENTAL, subject to change)
+
+=item Thread::Queue
+
+Thread-safe queues
+
+=item Thread::Semaphore
+
+Thread-safe semaphores
+
+=item Thread::Signal
+
+Start a thread which runs signal handlers reliably
+
+=item Thread::Specific
+
+Thread-specific keys
+
=item Tie::Array
Base class for tied arrays
@@ -798,26 +786,25 @@ By-name interface to Perl's built-in getgr*() functions
By-name interface to Perl's built-in getpw*() functions
+=item Win32
+
+Interfaces to some Win32 API Functions
+
=back
To find out I<all> modules installed on your system, including
-those without documentation or outside the standard release,
+those without documentation or outside the standard release,
just do this:
% find `perl -e 'print "@INC"'` -name '*.pm' -print
-To get a log of all module distributions which have been installed
-since perl was installed, just do:
-
- % perldoc perllocal
-
-Modules should all have their own documentation installed and accessible
-via your system man(1) command, or via the C<perldoc> program. If you do
-not have a B<find>
+They should all have their own documentation installed and accessible
+via your system man(1) command. If you do not have a B<find>
program, you can use the Perl B<find2perl> program instead, which
generates Perl code as output you can run through perl. If you
have a B<man> program but it doesn't find your modules, you'll have
-to fix your manpath. See L<perl> for details.
+to fix your manpath. See L<perl> for details. If you have no
+system B<man> command, you might try the B<perldoc> program.
=head2 Extension Modules
@@ -837,7 +824,7 @@ like Alta Vista or Deja News.
CPAN stands for Comprehensive Perl Archive Network; it's a globally
replicated trove of Perl materials, including documentation, style
-guides, tricks and trap, alternate ports to non-Unix systems and
+guides, tricks and traps, alternate ports to non-Unix systems and
occasional binary distributions for these. Search engines for
CPAN can be found at http://cpan.perl.com/ and at
http://theory.uwinnipeg.ca/mod_perl/cpan-search.pl .
@@ -849,66 +836,87 @@ modules are:
=over
=item *
+
Language Extensions and Documentation Tools
=item *
+
Development Support
=item *
+
Operating System Interfaces
=item *
+
Networking, Device Control (modems) and InterProcess Communication
=item *
+
Data Types and Data Type Utilities
=item *
+
Database Interfaces
=item *
+
User Interfaces
=item *
+
Interfaces to / Emulations of Other Programming Languages
=item *
+
File Names, File Systems and File Locking (see also File Handles)
=item *
+
String Processing, Language Text Processing, Parsing, and Searching
=item *
+
Option, Argument, Parameter, and Configuration File Processing
=item *
+
Internationalization and Locale
=item *
+
Authentication, Security, and Encryption
=item *
+
World Wide Web, HTML, HTTP, CGI, MIME
=item *
+
Server and Daemon Utilities
=item *
+
Archiving and Compression
=item *
+
Images, Pixmap and Bitmap Manipulation, Drawing, and Graphing
=item *
+
Mail and Usenet News
=item *
+
Control Flow Utilities (callbacks and exceptions etc)
=item *
+
File Handle and Input/Output Stream Utilities
=item *
+
Miscellaneous Modules
=back
@@ -916,172 +924,645 @@ Miscellaneous Modules
Registered CPAN sites as of this writing include the following.
You should try to choose one close to you:
-=over
+=head2 Africa
+
+=over 4
+
+=item *
-=item Africa
-
- South Africa ftp://ftp.is.co.za/programming/perl/CPAN/
- ftp://ftp.saix.net/pub/CPAN/
- ftp://ftp.sun.ac.za/CPAN/
- ftp://ftpza.co.za/pub/mirrors/cpan/
-
-
-=item Asia
-
- China ftp://freesoft.cei.gov.cn/pub/languages/perl/CPAN/
- Hong Kong ftp://ftp.pacific.net.hk/pub/mirror/CPAN/
- Indonesia ftp://malone.piksi.itb.ac.id/pub/CPAN/
- Israel ftp://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
- Japan ftp://ftp.dti.ad.jp/pub/lang/CPAN/
- ftp://ftp.jaist.ac.jp/pub/lang/perl/CPAN/
- ftp://ftp.lab.kdd.co.jp/lang/perl/CPAN/
- ftp://ftp.meisei-u.ac.jp/pub/CPAN/
- ftp://ftp.ring.gr.jp/pub/lang/perl/CPAN/
- ftp://mirror.nucba.ac.jp/mirror/Perl/
- Saudi-Arabia ftp://ftp.isu.net.sa/pub/CPAN/
- Singapore ftp://ftp.nus.edu.sg/pub/unix/perl/CPAN/
- South Korea ftp://ftp.bora.net/pub/CPAN/
- ftp://ftp.kornet.net/pub/CPAN/
- ftp://ftp.nuri.net/pub/CPAN/
- Taiwan ftp://coda.nctu.edu.tw/computer-languages/perl/CPAN/
- ftp://ftp.ee.ncku.edu.tw/pub3/perl/CPAN/
- ftp://ftp1.sinica.edu.tw/pub1/perl/CPAN/
- Thailand ftp://ftp.nectec.or.th/pub/mirrors/CPAN/
-
-
-=item Australasia
-
- Australia ftp://cpan.topend.com.au/pub/CPAN/
- ftp://ftp.labyrinth.net.au/pub/perl-CPAN/
- ftp://ftp.sage-au.org.au/pub/compilers/perl/CPAN/
- ftp://mirror.aarnet.edu.au/pub/perl/CPAN/
- New Zealand ftp://ftp.auckland.ac.nz/pub/perl/CPAN/
- ftp://sunsite.net.nz/pub/languages/perl/CPAN/
-
-
-=item Central America
-
- Costa Rica ftp://ftp.ucr.ac.cr/pub/Unix/CPAN/
-
-
-=item Europe
-
- Austria ftp://ftp.tuwien.ac.at/pub/languages/perl/CPAN/
- Belgium ftp://ftp.kulnet.kuleuven.ac.be/pub/mirror/CPAN/
- Bulgaria ftp://ftp.ntrl.net/pub/mirrors/CPAN/
- Croatia ftp://ftp.linux.hr/pub/CPAN/
- Czech Republic ftp://ftp.fi.muni.cz/pub/perl/
- ftp://sunsite.mff.cuni.cz/Languages/Perl/CPAN/
- Denmark ftp://sunsite.auc.dk/pub/languages/perl/CPAN/
- Estonia ftp://ftp.ut.ee/pub/languages/perl/CPAN/
- Finland ftp://ftp.funet.fi/pub/languages/perl/CPAN/
- France ftp://ftp.grolier.fr/pub/perl/CPAN/
- ftp://ftp.lip6.fr/pub/perl/CPAN/
- ftp://ftp.oleane.net/pub/mirrors/CPAN/
- ftp://ftp.pasteur.fr/pub/computing/CPAN/
- ftp://ftp.uvsq.fr/pub/perl/CPAN/
- German ftp://ftp.gigabell.net/pub/CPAN/
- Germany ftp://ftp.archive.de.uu.net/pub/CPAN/
- ftp://ftp.freenet.de/pub/ftp.cpan.org/pub/
- ftp://ftp.gmd.de/packages/CPAN/
- ftp://ftp.gwdg.de/pub/languages/perl/CPAN/
- ftp://ftp.leo.org/pub/comp/general/programming/languages/script/perl/CPAN/
- ftp://ftp.mpi-sb.mpg.de/pub/perl/CPAN/
- ftp://ftp.rz.ruhr-uni-bochum.de/pub/CPAN/
- ftp://ftp.uni-erlangen.de/pub/source/CPAN/
- ftp://ftp.uni-hamburg.de/pub/soft/lang/perl/CPAN/
- Germany ftp://ftp.archive.de.uu.net/pub/CPAN/
- ftp://ftp.freenet.de/pub/ftp.cpan.org/pub/
- ftp://ftp.gmd.de/packages/CPAN/
- ftp://ftp.gwdg.de/pub/languages/perl/CPAN/
- ftp://ftp.leo.org/pub/comp/general/programming/languages/script/perl/CPAN/
- ftp://ftp.mpi-sb.mpg.de/pub/perl/CPAN/
- ftp://ftp.rz.ruhr-uni-bochum.de/pub/CPAN/
- ftp://ftp.uni-erlangen.de/pub/source/CPAN/
- ftp://ftp.uni-hamburg.de/pub/soft/lang/perl/CPAN/
- Greece ftp://ftp.ntua.gr/pub/lang/perl/
- Hungary ftp://ftp.kfki.hu/pub/packages/perl/CPAN/
- Iceland ftp://ftp.gm.is/pub/CPAN/
- Ireland ftp://cpan.indigo.ie/pub/CPAN/
- ftp://sunsite.compapp.dcu.ie/pub/perl/
- Italy ftp://cis.uniRoma2.it/CPAN/
- ftp://ftp.flashnet.it/pub/CPAN/
- ftp://ftp.unina.it/pub/Other/CPAN/
- ftp://ftp.unipi.it/pub/mirror/perl/CPAN/
- Netherlands ftp://ftp.cs.uu.nl/mirror/CPAN/
- ftp://ftp.nluug.nl/pub/languages/perl/CPAN/
- Norway ftp://ftp.uit.no/pub/languages/perl/cpan/
- ftp://sunsite.uio.no/pub/languages/perl/CPAN/
- Poland ftp://ftp.man.torun.pl/pub/CPAN/
- ftp://ftp.pk.edu.pl/pub/lang/perl/CPAN/
- ftp://sunsite.icm.edu.pl/pub/CPAN/
- Portugal ftp://ftp.ci.uminho.pt/pub/mirrors/cpan/
- ftp://ftp.ist.utl.pt/pub/CPAN/
- ftp://ftp.ua.pt/pub/CPAN/
- Romania ftp://ftp.dnttm.ro/pub/CPAN/
- Russia ftp://ftp.chg.ru/pub/lang/perl/CPAN/
- ftp://ftp.sai.msu.su/pub/lang/perl/CPAN/
- Slovakia ftp://ftp.entry.sk/pub/languages/perl/CPAN/
- Slovenia ftp://ftp.arnes.si/software/perl/CPAN/
- Spain ftp://ftp.etse.urv.es/pub/perl/
- ftp://ftp.rediris.es/mirror/CPAN/
- Sweden ftp://ftp.sunet.se/pub/lang/perl/CPAN/
- Switzerland ftp://sunsite.cnlab-switch.ch/mirror/CPAN/
- Turkey ftp://sunsite.bilkent.edu.tr/pub/languages/CPAN/
- United Kingdom ftp://ftp.demon.co.uk/pub/mirrors/perl/CPAN/
- ftp://ftp.flirble.org/pub/languages/perl/CPAN/
- ftp://ftp.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN/
- ftp://ftp.plig.org/pub/CPAN/
- ftp://sunsite.doc.ic.ac.uk/packages/CPAN/
-
-
-=item North America
-
- Alberta ftp://sunsite.ualberta.ca/pub/Mirror/CPAN/
- California ftp://cpan.nas.nasa.gov/pub/perl/CPAN/
- ftp://cpan.valueclick.com/CPAN/
- ftp://ftp.cdrom.com/pub/perl/CPAN/
- http://download.sourceforge.net/mirrors/CPAN/
- Colorado ftp://ftp.cs.colorado.edu/pub/perl/CPAN/
- Florida ftp://ftp.cise.ufl.edu/pub/perl/CPAN/
- Georgia ftp://ftp.twoguys.org/CPAN/
- Illinois ftp://uiarchive.uiuc.edu/pub/lang/perl/CPAN/
- Indiana ftp://csociety-ftp.ecn.purdue.edu/pub/CPAN/
- ftp://ftp.uwsg.indiana.edu/pub/perl/CPAN/
- Kentucky ftp://ftp.uky.edu/CPAN/
- Manitoba ftp://theoryx5.uwinnipeg.ca/pub/CPAN/
- Massachusetts ftp://ftp.ccs.neu.edu/net/mirrors/ftp.funet.fi/pub/languages/perl/CPAN/
- ftp://ftp.iguide.com/pub/mirrors/packages/perl/CPAN/
- Mexico ftp://ftp.msg.com.mx/pub/CPAN/
- New York ftp://ftp.deao.net/pub/CPAN/
- ftp://ftp.rge.com/pub/languages/perl/
- North Carolina ftp://ftp.duke.edu/pub/perl/
- Nova Scotia ftp://cpan.chebucto.ns.ca/pub/CPAN/
- Oklahoma ftp://ftp.ou.edu/mirrors/CPAN/
- Ontario ftp://ftp.crc.ca/pub/packages/lang/perl/CPAN/
- Oregon ftp://ftp.orst.edu/pub/packages/CPAN/
- Pennsylvania ftp://ftp.epix.net/pub/languages/perl/
- Tennessee ftp://ftp.sunsite.utk.edu/pub/CPAN/
- Texas ftp://ftp.sedl.org/pub/mirrors/CPAN/
- ftp://jhcloos.com/pub/mirror/CPAN/
- Utah ftp://mirror.xmission.com/CPAN/
- Virginia ftp://ftp.perl.org/pub/perl/CPAN/
- ftp://ruff.cs.jmu.edu/pub/CPAN/
- Washington ftp://ftp-mirror.internap.com/pub/CPAN/
- ftp://ftp.llarian.net/pub/CPAN/
- ftp://ftp.spu.edu/pub/CPAN/
-
-
-=item South America
-
- Brazil ftp://cpan.if.usp.br/pub/mirror/CPAN/
- ftp://ftp.matrix.com.br/pub/perl/
- Chile ftp://sunsite.dcc.uchile.cl/pub/Lang/PERL/
+South Africa
+
+ ftp://ftp.is.co.za/programming/perl/CPAN/
+ ftp://ftp.saix.net/pub/CPAN/
+ ftp://ftpza.co.za/pub/mirrors/cpan/
+ ftp://ftp.sun.ac.za/CPAN/
+
+=back
+
+=head2 Asia
+
+=over 4
+
+=item *
+
+China
+
+ ftp://freesoft.cei.gov.cn/pub/languages/perl/CPAN/
+ http://www2.linuxforum.net/mirror/CPAN/
+ http://cpan.shellhung.org/
+ ftp://ftp.shellhung.org/pub/CPAN
+
+=item *
+
+Hong Kong
+
+ http://CPAN.pacific.net.hk/
+ ftp://ftp.pacific.net.hk/pub/mirror/CPAN/
+
+=item *
+
+Indonesia
+
+ http://piksi.itb.ac.id/CPAN/
+ ftp://mirrors.piksi.itb.ac.id/CPAN/
+ http://CPAN.mweb.co.id/
+ ftp://ftp.mweb.co.id/pub/languages/perl/CPAN/
+
+=item *
+
+Israel
+
+ http://www.iglu.org.il:/pub/CPAN/
+ ftp://ftp.iglu.org.il/pub/CPAN/
+ http://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
+ ftp://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
+
+=item *
+
+Japan
+
+ ftp://ftp.u-aizu.ac.jp/pub/lang/perl/CPAN/
+ ftp://ftp.kddlabs.co.jp/CPAN/
+ http://mirror.nucba.ac.jp/mirror/Perl/
+ ftp://mirror.nucba.ac.jp/mirror/Perl/
+ ftp://ftp.meisei-u.ac.jp/pub/CPAN/
+ ftp://ftp.jaist.ac.jp/pub/lang/perl/CPAN/
+ ftp://ftp.dti.ad.jp/pub/lang/CPAN/
+ ftp://ftp.ring.gr.jp/pub/lang/perl/CPAN/
+
+=item *
+
+Saudi Arabia
+
+ ftp://ftp.isu.net.sa/pub/CPAN/
+
+=item *
+
+Singapore
+
+ http://cpan.hjc.edu.sg
+ http://ftp.nus.edu.sg/unix/perl/CPAN/
+ ftp://ftp.nus.edu.sg/pub/unix/perl/CPAN/
+
+=item *
+
+South Korea
+
+ http://CPAN.bora.net/
+ ftp://ftp.bora.net/pub/CPAN/
+ http://ftp.kornet.net/CPAN/
+ ftp://ftp.kornet.net/pub/CPAN/
+ ftp://ftp.nuri.net/pub/CPAN/
+
+=item *
+
+Taiwan
+
+ ftp://coda.nctu.edu.tw/UNIX/perl/CPAN
+ ftp://ftp.ee.ncku.edu.tw/pub/perl/CPAN/
+ ftp://ftp1.sinica.edu.tw/pub1/perl/CPAN/
+
+=item *
+
+Thailand
+
+ http://download.nectec.or.th/CPAN/
+ ftp://ftp.nectec.or.th/pub/languages/CPAN/
+ ftp://ftp.cs.riubon.ac.th/pub/mirrors/CPAN/
+
+=back
+
+=head2 Central America
+
+=over 4
+
+=item *
+
+Costa Rica
+
+ ftp://ftp.linux.co.cr/mirrors/CPAN/
+ http://ftp.ucr.ac.cr/Unix/CPAN/
+ ftp://ftp.ucr.ac.cr/pub/Unix/CPAN/
+
+=back
+
+=head2 Europe
+
+=over 4
+
+=item *
+
+Austria
+
+ ftp://ftp.tuwien.ac.at/pub/languages/perl/CPAN/
+
+=item *
+
+Belgium
+
+ http://ftp.easynet.be/CPAN/
+ ftp://ftp.easynet.be/CPAN/
+ ftp://ftp.kulnet.kuleuven.ac.be/pub/mirror/CPAN/
+
+=item *
+
+Bulgaria
+
+ ftp://ftp.ntrl.net/pub/mirrors/CPAN/
+
+=item *
+
+Croatia
+
+ ftp://ftp.linux.hr/pub/CPAN/
+
+=item *
+
+Czech Republic
+
+ http://www.fi.muni.cz/pub/perl/
+ ftp://ftp.fi.muni.cz/pub/perl/
+ ftp://sunsite.mff.cuni.cz/MIRRORS/ftp.funet.fi/pub/languages/perl/CPAN/
+
+=item *
+
+Denmark
+
+ ftp://sunsite.auc.dk/pub/languages/perl/CPAN/
+ http://www.cpan.dk/CPAN/
+ ftp://www.cpan.dk/ftp.cpan.org/CPAN/
+
+=item *
+
+England
+
+ http://www.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN
+ ftp://ftp.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN/
+ ftp://ftp.demon.co.uk/pub/mirrors/perl/CPAN/
+ ftp://ftp.flirble.org/pub/languages/perl/CPAN/
+ ftp://ftp.plig.org/pub/CPAN/
+ ftp://sunsite.doc.ic.ac.uk/packages/CPAN/
+ http://mirror.uklinux.net/CPAN/
+ ftp://mirror.uklinux.net/pub/CPAN/
+ ftp://usit.shef.ac.uk/pub/packages/CPAN/
+
+=item *
+
+Estonia
+
+ ftp://ftp.ut.ee/pub/languages/perl/CPAN/
+
+=item *
+
+Finland
+
+ ftp://ftp.funet.fi/pub/languages/perl/CPAN/
+
+=item *
+
+France
+
+ ftp://cpan.ftp.worldonline.fr/pub/CPAN/
+ ftp://ftp.club-internet.fr/pub/perl/CPAN/
+ ftp://ftp.lip6.fr/pub/perl/CPAN/
+ ftp://ftp.oleane.net/pub/mirrors/CPAN/
+ ftp://ftp.pasteur.fr/pub/computing/CPAN/
+ ftp://cpan.cict.fr/pub/CPAN/
+ ftp://ftp.uvsq.fr/pub/perl/CPAN/
+
+=item *
+
+Germany
+
+ ftp://ftp.rz.ruhr-uni-bochum.de/pub/CPAN/
+ ftp://ftp.freenet.de/pub/ftp.cpan.org/pub/CPAN/
+ ftp://ftp.uni-erlangen.de/pub/source/CPAN/
+ ftp://ftp-stud.fht-esslingen.de/pub/Mirrors/CPAN
+ ftp://ftp.gigabell.net/pub/CPAN/
+ http://ftp.gwdg.de/pub/languages/perl/CPAN/
+ ftp://ftp.gwdg.de/pub/languages/perl/CPAN/
+ ftp://ftp.uni-hamburg.de/pub/soft/lang/perl/CPAN/
+ ftp://ftp.leo.org/pub/comp/general/programming/languages/script/perl/CPAN/
+ ftp://ftp.mpi-sb.mpg.de/pub/perl/CPAN/
+ ftp://ftp.gmd.de/mirrors/CPAN/
+
+=item *
+
+Greece
+
+ ftp://ftp.forthnet.gr/pub/languages/perl/CPAN
+ ftp://ftp.ntua.gr/pub/lang/perl/
+
+=item *
+
+Hungary
+
+ http://cpan.artifact.hu/
+ ftp://cpan.artifact.hu/CPAN/
+ ftp://ftp.kfki.hu/pub/packages/perl/CPAN/
+
+=item *
+
+Iceland
+
+ http://cpan.gm.is/
+ ftp://ftp.gm.is/pub/CPAN/
+
+=item *
+
+Ireland
+
+ http://cpan.indigo.ie/
+ ftp://cpan.indigo.ie/pub/CPAN/
+ http://sunsite.compapp.dcu.ie/pub/perl/
+ ftp://sunsite.compapp.dcu.ie/pub/perl/
+
+=item *
+
+Italy
+
+ http://cpan.nettuno.it/
+ http://gusp.dyndns.org/CPAN/
+ ftp://gusp.dyndns.org/pub/CPAN
+ http://softcity.iol.it/cpan
+ ftp://softcity.iol.it/pub/cpan
+ ftp://ftp.unina.it/pub/Other/CPAN/
+ ftp://ftp.unipi.it/pub/mirror/perl/CPAN/
+ ftp://cis.uniRoma2.it/CPAN/
+ ftp://ftp.edisontel.it/pub/CPAN_Mirror/
+ ftp://ftp.flashnet.it/pub/CPAN/
+
+=item *
+
+Latvia
+
+ http://kvin.lv/pub/CPAN/
+
+=item *
+
+Netherlands
+
+ ftp://download.xs4all.nl/pub/mirror/CPAN/
+ ftp://ftp.nl.uu.net/pub/CPAN/
+ ftp://ftp.nluug.nl/pub/languages/perl/CPAN/
+ ftp://ftp.cpan.nl/pub/CPAN/
+ http://www.cs.uu.nl/mirror/CPAN/
+ ftp://ftp.cs.uu.nl/mirror/CPAN/
+
+=item *
+
+Norway
+
+ ftp://sunsite.uio.no/pub/languages/perl/CPAN/
+ ftp://ftp.uit.no/pub/languages/perl/cpan/
+
+=item *
+
+Poland
+
+ ftp://ftp.pk.edu.pl/pub/lang/perl/CPAN/
+ ftp://ftp.mega.net.pl/pub/mirrors/ftp.perl.com/
+ ftp://ftp.man.torun.pl/pub/doc/CPAN/
+ ftp://sunsite.icm.edu.pl/pub/CPAN/
+
+=item *
+
+Portugal
+
+ ftp://ftp.ua.pt/pub/CPAN/
+ ftp://perl.di.uminho.pt/pub/CPAN/
+ ftp://ftp.ist.utl.pt/pub/CPAN/
+ ftp://ftp.netc.pt/pub/CPAN/
+
+=item *
+
+Romania
+
+ ftp://archive.logicnet.ro/mirrors/ftp.cpan.org/CPAN/
+ ftp://ftp.kappa.ro/pub/mirrors/ftp.perl.org/pub/CPAN/
+ ftp://ftp.dntis.ro/pub/cpan/
+ ftp://ftp.opsynet.com/cpan/
+ ftp://ftp.dnttm.ro/pub/CPAN/
+ ftp://ftp.timisoara.roedu.net/mirrors/CPAN/
+
+=item *
+
+Russia
+
+ ftp://ftp.chg.ru/pub/lang/perl/CPAN/
+ http://cpan.rinet.ru/
+ ftp://cpan.rinet.ru/pub/mirror/CPAN/
+ ftp://ftp.aha.ru/pub/CPAN/
+ ftp://ftp.sai.msu.su/pub/lang/perl/CPAN/
+
+=item *
+
+Slovakia
+
+ ftp://ftp.entry.sk/pub/languages/perl/CPAN/
+
+=item *
+
+Slovenia
+
+ ftp://ftp.arnes.si/software/perl/CPAN/
+
+=item *
+
+Spain
+
+ ftp://ftp.rediris.es/mirror/CPAN/
+ ftp://ftp.etse.urv.es/pub/perl/
+
+=item *
+
+Sweden
+
+ http://ftp.du.se/CPAN/
+ ftp://ftp.du.se/pub/CPAN/
+ ftp://ftp.sunet.se/pub/lang/perl/CPAN/
+
+=item *
+
+Switzerland
+
+ ftp://ftp.danyk.ch/CPAN/
+ ftp://sunsite.cnlab-switch.ch/mirror/CPAN/
+
+=item *
+
+Turkey
+
+ ftp://sunsite.bilkent.edu.tr/pub/languages/CPAN/
+
+=back
+
+=head2 North America
+
+=over 4
+
+=item *
+
+Canada
+
+=over 8
+
+=item *
+
+Alberta
+
+ http://sunsite.ualberta.ca/pub/Mirror/CPAN/
+ ftp://sunsite.ualberta.ca/pub/Mirror/CPAN/
+
+=item *
+
+Manitoba
+
+ http://theoryx5.uwinnipeg.ca/pub/CPAN/
+ ftp://theoryx5.uwinnipeg.ca/pub/CPAN/
+
+=item *
+
+Nova Scotia
+
+ ftp://cpan.chebucto.ns.ca/pub/CPAN/
+
+=item *
+
+Ontario
+
+ ftp://ftp.crc.ca/pub/packages/lang/perl/CPAN/
+
+=item *
+
+Mexico
+
+ http://www.msg.com.mx/CPAN/
+ ftp://ftp.msg.com.mx/pub/CPAN/
+
+=back
+
+=item *
+
+United States
+
+=over 8
+
+=item *
+
+Alabama
+
+ http://mirror.hiwaay.net/CPAN/
+ ftp://mirror.hiwaay.net/CPAN/
+
+=item *
+
+California
+
+ http://www.cpan.org/
+ ftp://ftp.cpan.org/CPAN/
+ ftp://cpan.nas.nasa.gov/pub/perl/CPAN/
+ ftp://ftp.digital.com/pub/plan/perl/CPAN/
+ http://www.kernel.org/pub/mirrors/cpan/
+ ftp://ftp.kernel.org/pub/mirrors/cpan/
+ http://www.perl.com/CPAN/
+ http://download.sourceforge.net/mirrors/CPAN/
+
+=item *
+
+Colorado
+
+ ftp://ftp.cs.colorado.edu/pub/perl/CPAN/
+
+=item *
+
+Florida
+
+ ftp://ftp.cise.ufl.edu/pub/perl/CPAN/
+
+=item *
+
+Georgia
+
+ ftp://ftp.twoguys.org/CPAN/
+
+=item *
+
+Illinois
+
+ http://www.neurogames.com/mirrors/CPAN
+ http://uiarchive.uiuc.edu/mirrors/ftp/ftp.cpan.org/pub/CPAN/
+ ftp://uiarchive.uiuc.edu/mirrors/ftp/ftp.cpan.org/pub/CPAN/
+
+=item *
+
+Indiana
+
+ ftp://ftp.uwsg.indiana.edu/pub/perl/CPAN/
+ http://cpan.nitco.com/
+ ftp://cpan.nitco.com/pub/CPAN/
+ ftp://cpan.in-span.net/
+ http://csociety-ftp.ecn.purdue.edu/pub/CPAN
+ ftp://csociety-ftp.ecn.purdue.edu/pub/CPAN
+
+=item *
+
+Kentucky
+
+ http://cpan.uky.edu/
+ ftp://cpan.uky.edu/pub/CPAN/
+
+=item *
+
+Massachusetts
+
+ ftp://ftp.ccs.neu.edu/net/mirrors/ftp.funet.fi/pub/languages/perl/CPAN/
+ ftp://ftp.iguide.com/pub/mirrors/packages/perl/CPAN/
+
+=item *
+
+New Jersey
+
+ ftp://ftp.cpanel.net/pub/CPAN/
+
+=item *
+
+New York
+
+ ftp://ftp.freesoftware.com/pub/perl/CPAN/
+ http://www.deao.net/mirrors/CPAN/
+ ftp://ftp.deao.net/pub/CPAN/
+ ftp://ftp.stealth.net/pub/mirrors/ftp.cpan.org/pub/CPAN/
+ http://mirror.nyc.anidea.com/CPAN/
+ ftp://mirror.nyc.anidea.com/pub/CPAN/
+ http://www.rge.com/pub/languages/perl/
+ ftp://ftp.rge.com/pub/languages/perl/
+ ftp://mirrors.cloud9.net/pub/mirrors/CPAN/
+
+=item *
+
+North Carolina
+
+ ftp://ftp.duke.edu/pub/perl/
+
+=item *
+
+Ohio
+
+ ftp://ftp.loaded.net/pub/CPAN/
+
+=item *
+
+Oklahoma
+
+ ftp://ftp.ou.edu/mirrors/CPAN/
+
+=item *
+
+Oregon
+
+ ftp://ftp.orst.edu/pub/packages/CPAN/
+
+=item *
+
+Pennsylvania
+
+ http://ftp.epix.net/CPAN/
+ ftp://ftp.epix.net/pub/languages/perl/
+ ftp://carroll.cac.psu.edu/pub/CPAN/
+
+=item *
+
+Tennessee
+
+ ftp://ftp.sunsite.utk.edu/pub/CPAN/
+
+=item *
+
+Texas
+
+ http://ftp.sedl.org/pub/mirrors/CPAN/
+ http://jhcloos.com/pub/mirror/CPAN/
+ ftp://jhcloos.com/pub/mirror/CPAN/
+
+=item *
+
+Utah
+
+ ftp://mirror.xmission.com/CPAN/
+
+=item *
+
+Virginia
+
+ http://mirrors.rcn.net/pub/lang/CPAN/
+ ftp://mirrors.rcn.net/pub/lang/CPAN/
+ ftp://ruff.cs.jmu.edu/pub/CPAN/
+ http://perl.Liquidation.com/CPAN/
+
+=item *
+
+Washington
+
+ http://cpan.llarian.net/
+ ftp://cpan.llarian.net/pub/CPAN/
+ ftp://ftp-mirror.internap.com/pub/CPAN/
+ ftp://ftp.spu.edu/pub/CPAN/
+
+=back
+
+=back
+
+=head2 Oceania
+
+=over 4
+
+=item *
+
+Australia
+
+ http://ftp.planetmirror.com/pub/CPAN/
+ ftp://ftp.planetmirror.com/pub/CPAN/
+ ftp://mirror.aarnet.edu.au/pub/perl/CPAN/
+ ftp://cpan.topend.com.au/pub/CPAN/
+
+=item *
+
+New Zealand
+
+ ftp://ftp.auckland.ac.nz/pub/perl/CPAN/
+
+=back
+
+=head2 South America
+
+=over 4
+
+=item *
+
+Argentina
+
+ ftp://mirrors.bannerlandia.com.ar/mirrors/CPAN/
+
+=item *
+
+Brazil
+
+ ftp://cpan.pop-mg.com.br/pub/CPAN/
+ ftp://ftp.matrix.com.br/pub/perl/
+ ftp://cpan.if.usp.br/pub/mirror/CPAN/
+
+=item *
+
+Chile
+
+ ftp://ftp.psinet.cl/pub/programming/perl/CPAN/
+ ftp://sunsite.dcc.uchile.cl/pub/lang/perl/
=back
For an up-to-date listing of CPAN sites,
-see http://www.perl.com/perl/CPAN/SITES or ftp://www.perl.com/CPAN/SITES .
+see http://www.cpan.org/SITES or ftp://www.cpan.org/SITES .
=head1 Modules: Creation, Use, and Abuse
@@ -1102,14 +1583,16 @@ its methods by loading dynamic C or C++ objects, but that should be
totally transparent to the user of the module. Likewise, the module
might set up an AUTOLOAD function to slurp in subroutine definitions on
demand, but this is also transparent. Only the F<.pm> file is required to
-exist. See L<perlsub>, L<perltoot>, and L<AutoLoader> for details about
+exist. See L<perlsub>, L<perltoot>, and L<AutoLoader> for details about
the AUTOLOAD mechanism.
=head2 Guidelines for Module Creation
=over 4
-=item Do similar modules already exist in some form?
+=item *
+
+Do similar modules already exist in some form?
If so, please try to reuse the existing modules either in whole or
by inheriting useful features into a new class. If this is not
@@ -1123,28 +1606,30 @@ modules, please coordinate with the author of the package. It
helps if you follow the same naming scheme and module interaction
scheme as the original author.
-=item Try to design the new module to be easy to extend and reuse.
+=item *
+
+Try to design the new module to be easy to extend and reuse.
Try to C<use warnings;> (or C<use warnings qw(...);>).
Remember that you can add C<no warnings qw(...);> to individual blocks
-of code that need less warnings.
+of code that need less warnings.
Use blessed references. Use the two argument form of bless to bless
into the class name given as the first parameter of the constructor,
e.g.,:
sub new {
- my $class = shift;
- return bless {}, $class;
+ my $class = shift;
+ return bless {}, $class;
}
or even this if you'd like it to be used as either a static
or a virtual method.
sub new {
- my $self = shift;
- my $class = ref($self) || $self;
- return bless {}, $class;
+ my $self = shift;
+ my $class = ref($self) || $self;
+ return bless {}, $class;
}
Pass arrays as references so more parameters can be added later
@@ -1176,19 +1661,21 @@ Avoid keeping any state information in your packages. It makes it
difficult for multiple other packages to use yours. Keep state
information in objects.
-Always use B<-w>.
+Always use B<-w>.
Try to C<use strict;> (or C<use strict qw(...);>).
Remember that you can add C<no strict qw(...);> to individual blocks
-of code that need less strictness.
+of code that need less strictness.
-Always use B<-w>.
+Always use B<-w>.
Follow the guidelines in the perlstyle(1) manual.
Always use B<-w>.
-=item Some simple style guidelines
+=item *
+
+Some simple style guidelines
The perlstyle manual supplied with Perl has many helpful points.
@@ -1220,7 +1707,9 @@ e.g., C<< $obj->as_string() >>.
You can use a leading underscore to indicate that a variable or
function should not be used outside the package that defined it.
-=item Select what to export.
+=item *
+
+Select what to export.
Do NOT export method names!
@@ -1244,7 +1733,9 @@ As a general rule, if the module is trying to be object oriented
then export nothing. If it's just a collection of functions then
@EXPORT_OK anything but use @EXPORT with caution.
-=item Select a name for the module.
+=item *
+
+Select a name for the module.
This name should be as descriptive, accurate, and complete as
possible. Avoid any risk of ambiguity. Always try to use two or
@@ -1268,11 +1759,19 @@ If adding a new module to a set, follow the original author's
standards for naming modules and the interface to methods in
those modules.
+If developing modules for private internal or project specific use,
+that will never be released to the public, then you should ensure
+that their names will not clash with any future public module. You
+can do this either by using the reserved Local::* category or by
+using a category name that includes an underscore like Foo_Corp::*.
+
To be portable each component of a module name should be limited to
11 characters. If it might be used on MS-DOS then try to ensure each is
unique in the first 8 characters. Nested modules make this easier.
-=item Have you got it right?
+=item *
+
+Have you got it right?
How do you know that you've made the right decisions? Have you
picked an interface design that will cause problems later? Have
@@ -1291,7 +1790,9 @@ Don't worry about posting if you can't say when the module will be
ready - just say so in the message. It might be worth inviting
others to help you, they may be able to complete it for you!
-=item README and other Additional Files.
+=item *
+
+README and other Additional Files.
It's well known that software developers usually fully document the
software they write. If, however, the world is in urgent need of
@@ -1301,24 +1802,31 @@ documentation please at least provide a README file containing:
=over 10
=item *
+
A description of the module/package/extension etc.
=item *
+
A copyright notice - see below.
=item *
+
Prerequisites - what else you may need to have.
=item *
+
How to build it - possible changes to Makefile.PL etc.
=item *
+
How to install it.
=item *
+
Recent changes in this release, especially incompatibilities
=item *
+
Changes / enhancements you plan to make in the future.
=back
@@ -1331,6 +1839,7 @@ Copying, ToDo etc.
=item Adding a Copyright Notice.
+
How you choose to license your work is a personal decision.
The general mechanism is to assert your Copyright and then make
a declaration of how others may copy/use/modify your work.
@@ -1350,7 +1859,9 @@ This statement should at least appear in the README file. You may
also wish to include it in a Copying file and your source files.
Remember to include the other words in addition to the Copyright.
-=item Give the module a version/issue/release number.
+=item *
+
+Give the module a version/issue/release number.
To be fully compatible with the Exporter and MakeMaker modules you
should store your module's version number in a non-my package
@@ -1364,14 +1875,16 @@ Use the number in announcements and archive file names when
releasing the module (ModuleName-1.02.tar.Z).
See perldoc ExtUtils::MakeMaker.pm for details.
-=item How to release and distribute a module.
+=item *
+
+How to release and distribute a module.
It's good idea to post an announcement of the availability of your
module (or the module itself if small) to the comp.lang.perl.announce
Usenet newsgroup. This will at least ensure very wide once-off
distribution.
-If possible, register the module with CPAN. You should
+If possible, register the module with CPAN. You should
include details of its location in your announcement.
Some notes about ftp archives: Please use a long descriptive file
@@ -1387,8 +1900,8 @@ FTP Archives for Perl Modules:
Follow the instructions and links on:
- http://www.perl.com/CPAN/modules/00modlist.long.html
- http://www.perl.com/CPAN/modules/04pause.html
+ http://www.cpan.org/modules/00modlist.long.html
+ http://www.cpan.org/modules/04pause.html
or upload to one of these sites:
@@ -1403,7 +1916,9 @@ CPAN!
Please remember to send me an updated entry for the Module list!
-=item Take care when changing a released module.
+=item *
+
+Take care when changing a released module.
Always strive to remain compatible with previous released versions.
Otherwise try to add a mechanism to revert to the
@@ -1417,26 +1932,34 @@ old behavior if people rely on it. Document incompatible changes.
=over 4
-=item There is no requirement to convert anything.
+=item *
+
+There is no requirement to convert anything.
If it ain't broke, don't fix it! Perl 4 library scripts should
continue to work with no problems. You may need to make some minor
changes (like escaping non-array @'s in double quoted strings) but
there is no need to convert a .pl file into a Module for just that.
-=item Consider the implications.
+=item *
+
+Consider the implications.
All Perl applications that make use of the script will need to
be changed (slightly) if the script is converted into a module. Is
it worth it unless you plan to make other changes at the same time?
-=item Make the most of the opportunity.
+=item *
+
+Make the most of the opportunity.
If you are going to convert the script to a module you can use the
opportunity to redesign the interface. The guidelines for module
creation above include many of the issues you should consider.
-=item The pl2pm utility will get you started.
+=item *
+
+The pl2pm utility will get you started.
This utility will read *.pl files (given as parameters) and write
corresponding *.pm files. The pl2pm utilities does the following:
@@ -1444,15 +1967,19 @@ corresponding *.pm files. The pl2pm utilities does the following:
=over 10
=item *
+
Adds the standard Module prologue lines
=item *
+
Converts package specifiers from ' to ::
=item *
+
Converts die(...) to croak(...)
=item *
+
Several other minor changes
=back
@@ -1467,18 +1994,28 @@ Don't delete the original .pl file till the new .pm one works!
=over 4
-=item Complete applications rarely belong in the Perl Module Library.
+=item *
+
+Complete applications rarely belong in the Perl Module Library.
+
+=item *
-=item Many applications contain some Perl code that could be reused.
+Many applications contain some Perl code that could be reused.
Help save the world! Share your code in a form that makes it easy
to reuse.
-=item Break-out the reusable code into one or more separate module files.
+=item *
+
+Break-out the reusable code into one or more separate module files.
+
+=item *
+
+Take the opportunity to reconsider and redesign the interfaces.
-=item Take the opportunity to reconsider and redesign the interfaces.
+=item *
-=item In some cases the 'application' can then be reduced to a small
+In some cases the 'application' can then be reduced to a small
fragment of code built on top of the reusable modules. In these cases
the application could invoked as:
OpenPOWER on IntegriCloud