5 open (OUT, ">perlmodlib.tmp") or die $!;
6 my (@pragma, @mod, @MANIFEST);
8 open (MANIFEST, "../MANIFEST") or die $!;
9 @MANIFEST = grep !m</(?:t|demo)/>, <MANIFEST>;
10 push @MANIFEST, 'lib/Config.pod', 'lib/Errno.pm', 'lib/lib.pm',
11 'lib/DynaLoader.pm', 'lib/XSLoader.pm';
15 next unless s|^lib/|| or m|^ext/|;
16 my ($origfilename) = ($filename) = m|^(\S+)|;
17 $filename =~ s|^[^/]+/|| if $filename =~ s|^ext/||;
18 next unless $filename =~ m!\.p(m|od)$!;
19 unless (open (MOD, "../lib/$filename")) {
20 unless (open (MOD, "../$origfilename")) {
21 warn "Couldn't open ../$origfilename: $!";
24 $filename = $origfilename;
33 next unless /^=head1 NAME/;
39 warn "$filename missing =head1 NAME (okay if there is respective .pod)\n";
46 my $perlname = $filename;
47 $perlname =~ s!^.*\b(ext|lib)/!!;
48 $perlname =~ s!\.p(m|od)$!!;
49 $perlname =~ s!\b(\w+)/\1\b!$1!;
50 $perlname =~ s!/!::!g;
52 ($name, $thing) = split / --? /, $title, 2;
54 unless ($name and $thing) {
55 warn "$filename missing name\n" unless $name;
56 warn "$filename missing thing\n" unless $thing;
61 $thing =~ s/^perl pragma to //i;
62 $thing = ucfirst($thing);
63 $title = "=item $perlname\n\n$thing\n\n";
65 if ($filename =~ /[A-Z]/) {
74 Generated by perlmodlib.PL -- DO NOT EDIT!
78 perlmodlib - constructing new Perl modules and finding existing ones
80 =head1 THE PERL MODULE LIBRARY
82 Many modules are included in the Perl distribution. These are described
83 below, and all end in F<.pm>. You may discover compiled library
84 files (usually ending in F<.so>) or small pieces of modules to be
85 autoloaded (ending in F<.al>); these were automatically generated
86 by the installation process. You may also discover files in the
87 library directory that end in either F<.pl> or F<.ph>. These are
88 old libraries supplied so that old programs that use them still
89 run. The F<.pl> files will all eventually be converted into standard
90 modules, and the F<.ph> files made by B<h2ph> will probably end up
91 as extension modules made by B<h2xs>. (Some F<.ph> values may
92 already be available through the POSIX, Errno, or Fcntl modules.)
93 The B<pl2pm> file in the distribution may help in your conversion,
94 but it's just a mechanical process and therefore far from bulletproof.
96 =head2 Pragmatic Modules
98 They work somewhat like compiler directives (pragmata) in that they
99 tend to affect the compilation of your program, and thus will usually
100 work well only when used within a C<use>, or C<no>. Most of these
101 are lexically scoped, so an inner BLOCK may countermand them
108 which lasts until the end of that BLOCK.
110 Some pragmas are lexically scoped--typically those that affect the
111 C<$^H> hints variable. Others affect the current package instead,
112 like C<use vars> and C<use subs>, which allow you to predeclare a
113 variables or subroutines within a particular I<file> rather than
114 just a block. Such declarations are effective for the entire file
115 for which they were declared. You cannot rescind them with C<no
118 The following pragmas are defined (and have their own documentation).
124 print OUT $_ for (sort @pragma);
129 =head2 Standard Modules
131 Standard, bundled modules are all expected to behave in a well-defined
132 manner with respect to namespace pollution because they use the
133 Exporter module. See their own documentation for details.
135 It's possible that not all modules listed below are installed on your
136 system. For example, the GDBM_File module will not be installed if you
137 don't have the gdbm library.
143 print OUT $_ for (sort @mod);
148 To find out I<all> modules installed on your system, including
149 those without documentation or outside the standard release,
150 just use the following command (under the default win32 shell,
151 double quotes should be used instead of single quotes).
153 % perl -MFile::Find=find -MFile::Spec::Functions -Tlwe \
154 'find { wanted => sub { print canonpath $_ if /\.pm\z/ },
155 no_chdir => 1 }, @INC'
157 (The -T is here to prevent '.' from being listed in @INC.)
158 They should all have their own documentation installed and accessible
159 via your system man(1) command. If you do not have a B<find>
160 program, you can use the Perl B<find2perl> program instead, which
161 generates Perl code as output you can run through perl. If you
162 have a B<man> program but it doesn't find your modules, you'll have
163 to fix your manpath. See L<perl> for details. If you have no
164 system B<man> command, you might try the B<perldoc> program.
166 Note also that the command C<perldoc perllocal> gives you a (possibly
167 incomplete) list of the modules that have been further installed on
168 your system. (The perllocal.pod file is updated by the standard MakeMaker
171 =head2 Extension Modules
173 Extension modules are written in C (or a mix of Perl and C). They
174 are usually dynamically loaded into Perl if and when you need them,
175 but may also be linked in statically. Supported extension modules
176 include Socket, Fcntl, and POSIX.
178 Many popular C extension modules do not come bundled (at least, not
179 completely) due to their sizes, volatility, or simply lack of time
180 for adequate testing and configuration across the multitude of
181 platforms on which Perl was beta-tested. You are encouraged to
182 look for them on CPAN (described below), or using web search engines
183 like Alta Vista or Google.
187 CPAN stands for Comprehensive Perl Archive Network; it's a globally
188 replicated trove of Perl materials, including documentation, style
189 guides, tricks and traps, alternate ports to non-Unix systems and
190 occasional binary distributions for these. Search engines for
191 CPAN can be found at http://www.cpan.org/
193 Most importantly, CPAN includes around a thousand unbundled modules,
194 some of which require a C compiler to build. Major categories of
201 Language Extensions and Documentation Tools
209 Operating System Interfaces
213 Networking, Device Control (modems) and InterProcess Communication
217 Data Types and Data Type Utilities
229 Interfaces to / Emulations of Other Programming Languages
233 File Names, File Systems and File Locking (see also File Handles)
237 String Processing, Language Text Processing, Parsing, and Searching
241 Option, Argument, Parameter, and Configuration File Processing
245 Internationalization and Locale
249 Authentication, Security, and Encryption
253 World Wide Web, HTML, HTTP, CGI, MIME
257 Server and Daemon Utilities
261 Archiving and Compression
265 Images, Pixmap and Bitmap Manipulation, Drawing, and Graphing
273 Control Flow Utilities (callbacks and exceptions etc)
277 File Handle and Input/Output Stream Utilities
281 Miscellaneous Modules
285 The list of the registered CPAN sites as of this writing follows.
286 Please note that the sorting order is alphabetical on fields:
298 and thus the North American servers happen to be listed between the
299 European and the South American sites.
301 You should try to choose one close to you.
309 ftp://ftp.is.co.za/programming/perl/CPAN/
310 ftp://ftp.mweb.co.za/pub/mirrors/cpan/
311 ftp://ftp.saix.net/pub/CPAN/
312 ftp://ftp.sun.ac.za/CPAN/CPAN/
322 ftp://freesoft.cei.gov.cn/pub/languages/perl/CPAN/
323 http://www2.linuxforum.net/mirror/CPAN/
324 http://cpan.shellhung.org/
325 ftp://ftp.shellhung.org/pub/CPAN
329 http://cpan.in.freeos.com
330 ftp://cpan.in.freeos.com/pub/CPAN/
334 http://cpan.itb.web.id/
335 ftp://mirrors.piksi.itb.ac.id/CPAN/
336 http://cpan.cbn.net.id/
337 ftp://ftp.cbn.net.id/mirror/CPAN
338 http://CPAN.mweb.co.id/
339 ftp://ftp.mweb.co.id/pub/languages/perl/CPAN/
343 http://www.iglu.org.il:/pub/CPAN/
344 ftp://ftp.iglu.org.il/pub/CPAN/
345 http://cpan.lerner.co.il/
346 http://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
347 ftp://bioinfo.weizmann.ac.il/pub/software/perl/CPAN/
351 ftp://ftp.u-aizu.ac.jp/pub/CPAN
352 ftp://ftp.kddlabs.co.jp/CPAN/
353 http://mirror.nucba.ac.jp/mirror/Perl/
354 ftp://mirror.nucba.ac.jp/mirror/Perl/
355 ftp://ftp.meisei-u.ac.jp/pub/CPAN/
356 ftp://ftp.ayamura.org/pub/CPAN/
357 ftp://ftp.jaist.ac.jp/pub/lang/perl/CPAN/
358 ftp://ftp.dti.ad.jp/pub/lang/CPAN/
359 ftp://ftp.ring.gr.jp/pub/lang/perl/CPAN/
363 http://mirror.Mazic.org/pub/CPAN
364 ftp://mirror.Mazic.org/pub/CPAN
368 http://www.adzu.edu.ph/CPAN
370 =item Russian Federation
373 ftp://cpan.tomsk.ru/pub/CPAN
377 ftp://ftp.isu.net.sa/pub/CPAN/
381 http://cpan.hjc.edu.sg
382 http://mirror.averse.net/pub/CPAN
383 ftp://mirror.averse.net/pub/CPAN
387 http://CPAN.bora.net/
388 ftp://ftp.bora.net/pub/CPAN/
389 http://ftp.kornet.net/pub/CPAN/
390 ftp://ftp.kornet.net/pub/CPAN/
391 ftp://ftp.nuri.net/pub/CPAN/
392 http://ftp.xgate.co.kr/cpan/
393 ftp://ftp.xgate.co.kr/pub/mirror/CPAN
397 ftp://ftp.nctu.edu.tw/UNIX/perl/CPAN
398 ftp://ftp.ee.ncku.edu.tw/pub/perl/CPAN/
399 ftp://ftp1.sinica.edu.tw/pub1/perl/CPAN/
400 http://ftp.tku.edu.tw/pub/CPAN/
401 ftp://ftp.tku.edu.tw/pub/CPAN/
405 ftp://ftp.loxinfo.co.th/pub/cpan/
406 ftp://ftp.cs.riubon.ac.th/pub/mirrors/CPAN/
410 =head2 Central America
416 ftp://ftp.linux.co.cr/mirrors/CPAN/
417 http://ftp.ucr.ac.cr/Unix/CPAN/
418 ftp://ftp.ucr.ac.cr/pub/Unix/CPAN/
428 ftp://ftp.tuwien.ac.at/pub/CPAN/
432 http://ftp.easynet.be/pub/CPAN/
433 ftp://ftp.easynet.be/pub/CPAN/
434 http://cpan.skynet.be
435 ftp://ftp.skynet.be/pub/CPAN
436 ftp://ftp.kulnet.kuleuven.ac.be/pub/mirror/CPAN/
440 http://cpan.lirex.net/
441 ftp://ftp.lirex.net/pub/mirrors/CPAN
445 http://ftp.linux.hr/pub/CPAN/
446 ftp://ftp.linux.hr/pub/CPAN/
450 http://ftp.fi.muni.cz/pub/CPAN/
451 ftp://ftp.fi.muni.cz/pub/CPAN/
452 ftp://sunsite.mff.cuni.cz/MIRRORS/ftp.funet.fi/pub/languages/perl/CPAN/
456 http://mirrors.sunsite.dk/cpan/
457 ftp://sunsite.dk/mirrors/cpan/
458 http://cpan.cybercity.dk
459 http://www.cpan.dk/CPAN/
460 ftp://www.cpan.dk/ftp.cpan.org/CPAN/
464 ftp://ftp.ut.ee/pub/languages/perl/CPAN/
468 ftp://ftp.funet.fi/pub/languages/perl/CPAN/
469 http://cpan.kpnqwest.fi/
473 http://ftp.u-paris10.fr/perl/CPAN
474 ftp://ftp.u-paris10.fr/perl/CPAN
475 http://cpan.mirrors.easynet.fr/
476 ftp://cpan.mirrors.easynet.fr/pub/ftp.cpan.org/
477 ftp://ftp.club-internet.fr/pub/perl/CPAN/
479 ftp://ftp.lip6.fr/pub/perl/CPAN/
480 ftp://ftp.oleane.net/pub/mirrors/CPAN/
481 ftp://ftp.pasteur.fr/pub/computing/CPAN/
482 http://mir2.ovh.net/ftp.cpan.org
483 ftp://mir1.ovh.net/ftp.cpan.org
484 http://ftp.u-strasbg.fr/CPAN
485 ftp://ftp.u-strasbg.fr/CPAN
487 ftp://cpan.cict.fr/pub/CPAN/
488 ftp://ftp.uvsq.fr/pub/perl/CPAN/
492 ftp://ftp.rz.ruhr-uni-bochum.de/pub/CPAN/
493 ftp://ftp.freenet.de/pub/ftp.cpan.org/pub/CPAN/
494 ftp://ftp.uni-erlangen.de/pub/source/CPAN/
495 ftp://ftp-stud.fht-esslingen.de/pub/Mirrors/CPAN
496 http://pandemonium.tiscali.de/pub/CPAN/
497 ftp://pandemonium.tiscali.de/pub/CPAN/
498 http://ftp.gwdg.de/pub/languages/perl/CPAN/
499 ftp://ftp.gwdg.de/pub/languages/perl/CPAN/
500 ftp://ftp.uni-hamburg.de/pub/soft/lang/perl/CPAN/
501 ftp://ftp.leo.org/pub/CPAN/
502 http://cpan.noris.de/
503 ftp://cpan.noris.de/pub/CPAN/
504 ftp://ftp.mpi-sb.mpg.de/pub/perl/CPAN/
505 ftp://ftp.gmd.de/mirrors/CPAN/
509 ftp://ftp.acn.gr/pub/lang/perl/CPAN
510 ftp://ftp.forthnet.gr/pub/languages/perl/CPAN
511 ftp://ftp.ntua.gr/pub/lang/perl/
515 http://cpan.artifact.hu/
516 ftp://cpan.artifact.hu/CPAN/
517 http://ftp.kfki.hu/packages/perl/CPAN/
518 ftp://ftp.kfki.hu/pub/packages/perl/CPAN/
522 http://ftp.rhnet.is/pub/CPAN/
523 ftp://ftp.rhnet.is/pub/CPAN/
527 http://cpan.indigo.ie/
528 ftp://cpan.indigo.ie/pub/CPAN/
529 http://sunsite.compapp.dcu.ie/pub/perl/
530 ftp://sunsite.compapp.dcu.ie/pub/perl/
534 http://cpan.nettuno.it/
535 http://gusp.dyndns.org/CPAN/
536 ftp://gusp.dyndns.org/pub/CPAN
537 http://softcity.iol.it/cpan
538 ftp://softcity.iol.it/pub/cpan
539 ftp://ftp.unina.it/pub/Other/CPAN/CPAN/
540 ftp://ftp.unipi.it/pub/mirror/perl/CPAN/
541 ftp://cis.uniRoma2.it/CPAN/
542 ftp://ftp.edisontel.it/pub/CPAN_Mirror/
543 ftp://ftp.flashnet.it/pub/CPAN/
547 http://kvin.lv/pub/CPAN/
551 ftp://ftp.unix.lt/pub/CPAN/
555 ftp://download.xs4all.nl/pub/mirror/CPAN/
556 ftp://ftp.nl.uu.net/pub/CPAN/
557 ftp://ftp.nluug.nl/pub/languages/perl/CPAN/
558 http://cpan.cybercomm.nl/
559 ftp://mirror.cybercomm.nl/pub/CPAN
560 ftp://ftp.cpan.nl/pub/CPAN/
561 http://ftp.easynet.nl/mirror/CPAN
562 ftp://ftp.easynet.nl/mirror/CPAN
563 http://archive.cs.uu.nl/mirror/CPAN/
564 ftp://ftp.cs.uu.nl/mirror/CPAN/
568 ftp://ftp.uninett.no/pub/languages/perl/CPAN
569 ftp://ftp.uit.no/pub/languages/perl/cpan/
573 ftp://ftp.pk.edu.pl/pub/lang/perl/CPAN/
574 ftp://ftp.mega.net.pl/pub/mirrors/ftp.perl.com/
575 ftp://ftp.man.torun.pl/pub/doc/CPAN/
576 ftp://sunsite.icm.edu.pl/pub/CPAN/
580 ftp://ftp.ua.pt/pub/CPAN/
581 ftp://perl.di.uminho.pt/pub/CPAN/
582 http://cpan.dei.uc.pt/
583 ftp://ftp.dei.uc.pt/pub/CPAN
584 ftp://ftp.ist.utl.pt/pub/CPAN/
586 ftp://cpan.ip.pt/pub/cpan/
587 ftp://ftp.netc.pt/pub/CPAN/
588 ftp://ftp.up.pt/pub/CPAN
592 ftp://ftp.kappa.ro/pub/mirrors/ftp.perl.org/pub/CPAN/
593 ftp://ftp.dntis.ro/pub/cpan/
594 ftp://ftp.dnttm.ro/pub/CPAN/
595 ftp://ftp.lasting.ro/pub/CPAN
596 ftp://ftp.timisoara.roedu.net/mirrors/CPAN/
600 ftp://ftp.chg.ru/pub/lang/perl/CPAN/
601 http://cpan.rinet.ru/
602 ftp://cpan.rinet.ru/pub/mirror/CPAN/
603 ftp://ftp.aha.ru/pub/CPAN/
604 http://cpan.sai.msu.ru/
605 ftp://ftp.sai.msu.su/pub/lang/perl/CPAN/
609 http://ftp.cvt.stuba.sk/pub/CPAN/
610 ftp://ftp.cvt.stuba.sk/pub/CPAN/
614 ftp://ftp.arnes.si/software/perl/CPAN/
618 http://cpan.imasd.elmundo.es/
619 ftp://ftp.rediris.es/mirror/CPAN/
620 ftp://ftp.etse.urv.es/pub/perl/
624 http://ftp.du.se/CPAN/
625 ftp://ftp.du.se/pub/CPAN/
626 ftp://mirror.dataphone.se/pub/CPAN
627 ftp://ftp.sunet.se/pub/lang/perl/CPAN/
631 ftp://ftp.danyk.ch/CPAN/
632 ftp://sunsite.cnlab-switch.ch/mirror/CPAN/
636 http://ftp.ulak.net.tr/perl/CPAN/
637 ftp://ftp.ulak.net.tr/perl/CPAN
638 ftp://sunsite.bilkent.edu.tr/pub/languages/CPAN/
644 ftp://ftp.perl.org.ua/pub/CPAN/
648 http://www.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN
649 ftp://ftp.mirror.ac.uk/sites/ftp.funet.fi/pub/languages/perl/CPAN/
650 http://cpan.teleglobe.net/
651 ftp://cpan.teleglobe.net/pub/CPAN
652 http://cpan.crazygreek.co.uk
653 ftp://ftp.demon.co.uk/pub/CPAN/
654 http://cpan.m.flirble.org/
655 ftp://ftp.flirble.org/pub/languages/perl/CPAN/
656 ftp://ftp.plig.org/pub/CPAN/
657 http://mirror.uklinux.net/CPAN/
658 ftp://mirror.uklinux.net/pub/CPAN/
659 http://cpan.mirrors.clockerz.net/
660 ftp://ftp.clockerz.net/pub/CPAN/
661 ftp://usit.shef.ac.uk/pub/packages/CPAN/
671 http://sunsite.ualberta.ca/pub/Mirror/CPAN/
672 ftp://sunsite.ualberta.ca/pub/Mirror/CPAN/
676 http://theoryx5.uwinnipeg.ca/pub/CPAN/
677 ftp://theoryx5.uwinnipeg.ca/pub/CPAN/
681 ftp://cpan.chebucto.ns.ca/pub/CPAN/
685 ftp://ftp.crc.ca/pub/CPAN/
689 http://cpan.mirror.smartworker.org/
693 http://cpan.azc.uam.mx
694 ftp://cpan.azc.uam.mx/mirrors/CPAN
696 ftp://cpan.unam.mx/pub/CPAN
697 http://www.msg.com.mx/CPAN/
698 ftp://ftp.msg.com.mx/pub/CPAN/
708 http://mirror.hiwaay.net/CPAN/
709 ftp://mirror.hiwaay.net/CPAN/
713 http://cpan.develooper.com/
715 ftp://cpan.valueclick.com/pub/CPAN/
716 http://mirrors.gossamer-threads.com/CPAN
717 ftp://cpan.nas.nasa.gov/pub/perl/CPAN/
718 http://mirrors.kernel.org/cpan/
719 ftp://mirrors.kernel.org/pub/CPAN
720 http://cpan.digisle.net/
721 ftp://cpan.digisle.net/pub/CPAN
722 http://www.perl.com/CPAN/
723 http://download.sourceforge.net/mirrors/CPAN/
727 ftp://ftp.cs.colorado.edu/pub/perl/CPAN/
731 http://ftp.lug.udel.edu/pub/CPAN
732 ftp://ftp.lug.udel.edu/pub/CPAN
734 =item District of Columbia
736 ftp://ftp.dc.aleron.net/pub/CPAN/
740 ftp://ftp.cise.ufl.edu/pub/mirrors/CPAN/
741 http://mirror.csit.fsu.edu/pub/CPAN/
742 ftp://mirror.csit.fsu.edu/pub/CPAN/
743 http://cpan.mirrors.nks.net/
747 http://uiarchive.uiuc.edu/mirrors/ftp/cpan.cse.msu.edu/
748 ftp://uiarchive.uiuc.edu/mirrors/ftp/cpan.cse.msu.edu/
752 ftp://ftp.uwsg.iu.edu/pub/perl/CPAN/
753 http://cpan.netnitco.net/
754 ftp://cpan.netnitco.net/pub/mirrors/CPAN/
755 http://archive.progeny.com/CPAN/
756 ftp://archive.progeny.com/CPAN/
757 ftp://cpan.in-span.net/
758 http://csociety-ftp.ecn.purdue.edu/pub/CPAN
759 ftp://csociety-ftp.ecn.purdue.edu/pub/CPAN
764 ftp://cpan.uky.edu/pub/CPAN/
768 ftp://ftp.ccs.neu.edu/net/mirrors/ftp.funet.fi/pub/languages/perl/CPAN/
769 http://cpan.mirrors.netnumina.com/
770 ftp://mirrors.netnumina.com/cpan/
774 ftp://cpan.cse.msu.edu/
778 ftp://ftp.cpanel.net/pub/CPAN/
779 http://cpan.teleglobe.net/
780 ftp://cpan.teleglobe.net/pub/CPAN
784 ftp://ftp.exobit.org/pub/perl/CPAN
785 http://cpan.belfry.net/
786 http://cpan.thepirtgroup.com/
787 ftp://cpan.thepirtgroup.com/
788 ftp://ftp.stealth.net/pub/CPAN/
789 http://www.rge.com/pub/languages/perl/
790 ftp://ftp.rge.com/pub/languages/perl/
791 ftp://mirrors.cloud9.net/pub/mirrors/CPAN/
795 ftp://ftp.duke.edu/pub/perl/
799 ftp://ftp.loaded.net/pub/CPAN/
803 ftp://ftp.ou.edu/mirrors/CPAN/
807 ftp://ftp.orst.edu/pub/CPAN
811 http://ftp.epix.net/CPAN/
812 ftp://ftp.epix.net/pub/languages/perl/
813 http://mirrors.phenominet.com/pub/CPAN/
814 ftp://mirrors.phenominet.com/pub/CPAN/
815 http://cpan.pair.com/
816 ftp://cpan.pair.com/pub/CPAN/
817 ftp://carroll.cac.psu.edu/pub/CPAN/
821 ftp://ftp.sunsite.utk.edu/pub/CPAN/
825 http://ftp.sedl.org/pub/mirrors/CPAN/
826 ftp://mirror.telentente.com/pub/CPAN
830 ftp://mirror.xmission.com/CPAN/
834 http://mirrors.rcn.net/pub/lang/CPAN/
835 ftp://mirrors.rcn.net/pub/lang/CPAN/
836 http://perl.secsup.org/
837 ftp://perl.secsup.org/pub/perl/
838 http://mirrors.phihost.com/CPAN/
839 ftp://mirrors.phihost.com/CPAN/
840 ftp://ruff.cs.jmu.edu/pub/CPAN/
841 http://perl.Liquidation.com/CPAN/
845 http://cpan.llarian.net/
846 ftp://cpan.llarian.net/pub/CPAN/
847 http://cpan.mirrorcentral.com/
848 ftp://ftp.mirrorcentral.com/pub/CPAN/
849 ftp://ftp-mirror.internap.com/pub/CPAN/
853 http://mirror.sit.wisc.edu/pub/CPAN/
854 ftp://mirror.sit.wisc.edu/pub/CPAN/
864 http://ftp.planetmirror.com/pub/CPAN/
865 ftp://ftp.planetmirror.com/pub/CPAN/
866 ftp://mirror.aarnet.edu.au/pub/perl/CPAN/
867 ftp://cpan.topend.com.au/pub/CPAN/
871 ftp://ftp.auckland.ac.nz/pub/perl/CPAN/
872 http://cpan.soa.co.nz/CPAN/
882 ftp://mirrors.bannerlandia.com.ar/mirrors/CPAN/
883 http://ftp.fcaglp.unlp.edu.ar/pub/CPAN/
884 ftp://ftp.fcaglp.unlp.edu.ar/pub/CPAN/
888 ftp://cpan.pop-mg.com.br/pub/CPAN/
889 ftp://ftp.matrix.com.br/pub/perl/CPAN/
893 http://cpan.netglobalis.net/
894 ftp://cpan.netglobalis.net/pub/CPAN/
900 ftp.fcaglp.unlp.edu.ar::CPAN
901 cpan.mirror.smartworker.org::CPAN
902 theoryx5.uwinnipeg.ca::CPAN
903 ftp.shellhung.org::CPAN
905 ftp.u-paris10.fr::CPAN
907 ftp.gwdg.de::FTP/languages/perl/CPAN/
909 CPAN.piksi.itb.ac.id::CPAN
911 ftp.iglu.org.il::CPAN
912 gusp.dyndns.org::cpan
913 ftp.kddlabs.co.jp::cpan
914 ftp.ayamura.org::pub/CPAN/
915 mirror.averse.net::cpan
916 cpan.teleglobe.net::CPAN
918 archive.progeny.com::CPAN
919 cpan.teleglobe.net::CPAN
920 ftp.lug.udel.edu::cpan
921 mirrors.kernel.org::mirrors/CPAN
922 mirrors.phenominet.com::CPAN
923 mirror.csit.fsu.edu::CPAN
924 csociety-ftp.ecn.purdue.edu::CPAN
926 For an up-to-date listing of CPAN sites,
927 see http://www.cpan.org/SITES or ftp://www.cpan.org/SITES .
929 =head1 Modules: Creation, Use, and Abuse
931 (The following section is borrowed directly from Tim Bunce's modules
932 file, available at your nearest CPAN site.)
934 Perl implements a class using a package, but the presence of a
935 package doesn't imply the presence of a class. A package is just a
936 namespace. A class is a package that provides subroutines that can be
937 used as methods. A method is just a subroutine that expects, as its
938 first argument, either the name of a package (for "static" methods),
939 or a reference to something (for "virtual" methods).
941 A module is a file that (by convention) provides a class of the same
942 name (sans the .pm), plus an import method in that class that can be
943 called to fetch exported symbols. This module may implement some of
944 its methods by loading dynamic C or C++ objects, but that should be
945 totally transparent to the user of the module. Likewise, the module
946 might set up an AUTOLOAD function to slurp in subroutine definitions on
947 demand, but this is also transparent. Only the F<.pm> file is required to
948 exist. See L<perlsub>, L<perltoot>, and L<AutoLoader> for details about
949 the AUTOLOAD mechanism.
951 =head2 Guidelines for Module Creation
957 Do similar modules already exist in some form?
959 If so, please try to reuse the existing modules either in whole or
960 by inheriting useful features into a new class. If this is not
961 practical try to get together with the module authors to work on
962 extending or enhancing the functionality of the existing modules.
963 A perfect example is the plethora of packages in perl4 for dealing
964 with command line options.
966 If you are writing a module to expand an already existing set of
967 modules, please coordinate with the author of the package. It
968 helps if you follow the same naming scheme and module interaction
969 scheme as the original author.
973 Try to design the new module to be easy to extend and reuse.
975 Try to C<use warnings;> (or C<use warnings qw(...);>).
976 Remember that you can add C<no warnings qw(...);> to individual blocks
977 of code that need less warnings.
979 Use blessed references. Use the two argument form of bless to bless
980 into the class name given as the first parameter of the constructor,
985 return bless {}, $class;
988 or even this if you'd like it to be used as either a static
993 my $class = ref($self) || $self;
994 return bless {}, $class;
997 Pass arrays as references so more parameters can be added later
998 (it's also faster). Convert functions into methods where
999 appropriate. Split large methods into smaller more flexible ones.
1000 Inherit methods from other modules if appropriate.
1002 Avoid class name tests like: C<die "Invalid" unless ref $ref eq 'FOO'>.
1003 Generally you can delete the C<eq 'FOO'> part with no harm at all.
1004 Let the objects look after themselves! Generally, avoid hard-wired
1005 class names as far as possible.
1007 Avoid C<< $r->Class::func() >> where using C<@ISA=qw(... Class ...)> and
1008 C<< $r->func() >> would work (see L<perlbot> for more details).
1010 Use autosplit so little used or newly added functions won't be a
1011 burden to programs that don't use them. Add test functions to
1012 the module after __END__ either using AutoSplit or by saying:
1014 eval join('',<main::DATA>) || die $@ unless caller();
1016 Does your module pass the 'empty subclass' test? If you say
1017 C<@SUBCLASS::ISA = qw(YOURCLASS);> your applications should be able
1018 to use SUBCLASS in exactly the same way as YOURCLASS. For example,
1019 does your application still work if you change: C<$obj = new YOURCLASS;>
1020 into: C<$obj = new SUBCLASS;> ?
1022 Avoid keeping any state information in your packages. It makes it
1023 difficult for multiple other packages to use yours. Keep state
1024 information in objects.
1028 Try to C<use strict;> (or C<use strict qw(...);>).
1029 Remember that you can add C<no strict qw(...);> to individual blocks
1030 of code that need less strictness.
1034 Follow the guidelines in the perlstyle(1) manual.
1040 Some simple style guidelines
1042 The perlstyle manual supplied with Perl has many helpful points.
1044 Coding style is a matter of personal taste. Many people evolve their
1045 style over several years as they learn what helps them write and
1046 maintain good code. Here's one set of assorted suggestions that
1047 seem to be widely used by experienced developers:
1049 Use underscores to separate words. It is generally easier to read
1050 $var_names_like_this than $VarNamesLikeThis, especially for
1051 non-native speakers of English. It's also a simple rule that works
1052 consistently with VAR_NAMES_LIKE_THIS.
1054 Package/Module names are an exception to this rule. Perl informally
1055 reserves lowercase module names for 'pragma' modules like integer
1056 and strict. Other modules normally begin with a capital letter and
1057 use mixed case with no underscores (need to be short and portable).
1059 You may find it helpful to use letter case to indicate the scope
1060 or nature of a variable. For example:
1062 $ALL_CAPS_HERE constants only (beware clashes with Perl vars)
1063 $Some_Caps_Here package-wide global/static
1064 $no_caps_here function scope my() or local() variables
1066 Function and method names seem to work best as all lowercase.
1067 e.g., C<< $obj->as_string() >>.
1069 You can use a leading underscore to indicate that a variable or
1070 function should not be used outside the package that defined it.
1074 Select what to export.
1076 Do NOT export method names!
1078 Do NOT export anything else by default without a good reason!
1080 Exports pollute the namespace of the module user. If you must
1081 export try to use @EXPORT_OK in preference to @EXPORT and avoid
1082 short or common names to reduce the risk of name clashes.
1084 Generally anything not exported is still accessible from outside the
1085 module using the ModuleName::item_name (or C<< $blessed_ref->method >>)
1086 syntax. By convention you can use a leading underscore on names to
1087 indicate informally that they are 'internal' and not for public use.
1089 (It is actually possible to get private functions by saying:
1090 C<my $subref = sub { ... }; &$subref;>. But there's no way to call that
1091 directly as a method, because a method must have a name in the symbol
1094 As a general rule, if the module is trying to be object oriented
1095 then export nothing. If it's just a collection of functions then
1096 @EXPORT_OK anything but use @EXPORT with caution.
1100 Select a name for the module.
1102 This name should be as descriptive, accurate, and complete as
1103 possible. Avoid any risk of ambiguity. Always try to use two or
1104 more whole words. Generally the name should reflect what is special
1105 about what the module does rather than how it does it. Please use
1106 nested module names to group informally or categorize a module.
1107 There should be a very good reason for a module not to have a nested name.
1108 Module names should begin with a capital letter.
1110 Having 57 modules all called Sort will not make life easy for anyone
1111 (though having 23 called Sort::Quick is only marginally better :-).
1112 Imagine someone trying to install your module alongside many others.
1113 If in any doubt ask for suggestions in comp.lang.perl.misc.
1115 If you are developing a suite of related modules/classes it's good
1116 practice to use nested classes with a common prefix as this will
1117 avoid namespace clashes. For example: Xyz::Control, Xyz::View,
1118 Xyz::Model etc. Use the modules in this list as a naming guide.
1120 If adding a new module to a set, follow the original author's
1121 standards for naming modules and the interface to methods in
1124 If developing modules for private internal or project specific use,
1125 that will never be released to the public, then you should ensure
1126 that their names will not clash with any future public module. You
1127 can do this either by using the reserved Local::* category or by
1128 using a category name that includes an underscore like Foo_Corp::*.
1130 To be portable each component of a module name should be limited to
1131 11 characters. If it might be used on MS-DOS then try to ensure each is
1132 unique in the first 8 characters. Nested modules make this easier.
1136 Have you got it right?
1138 How do you know that you've made the right decisions? Have you
1139 picked an interface design that will cause problems later? Have
1140 you picked the most appropriate name? Do you have any questions?
1142 The best way to know for sure, and pick up many helpful suggestions,
1143 is to ask someone who knows. Comp.lang.perl.misc is read by just about
1144 all the people who develop modules and it's the best place to ask.
1146 All you need to do is post a short summary of the module, its
1147 purpose and interfaces. A few lines on each of the main methods is
1148 probably enough. (If you post the whole module it might be ignored
1149 by busy people - generally the very people you want to read it!)
1151 Don't worry about posting if you can't say when the module will be
1152 ready - just say so in the message. It might be worth inviting
1153 others to help you, they may be able to complete it for you!
1157 README and other Additional Files.
1159 It's well known that software developers usually fully document the
1160 software they write. If, however, the world is in urgent need of
1161 your software and there is not enough time to write the full
1162 documentation please at least provide a README file containing:
1168 A description of the module/package/extension etc.
1172 A copyright notice - see below.
1176 Prerequisites - what else you may need to have.
1180 How to build it - possible changes to Makefile.PL etc.
1188 Recent changes in this release, especially incompatibilities
1192 Changes / enhancements you plan to make in the future.
1196 If the README file seems to be getting too large you may wish to
1197 split out some of the sections into separate files: INSTALL,
1204 Adding a Copyright Notice.
1206 How you choose to license your work is a personal decision.
1207 The general mechanism is to assert your Copyright and then make
1208 a declaration of how others may copy/use/modify your work.
1210 Perl, for example, is supplied with two types of licence: The GNU GPL
1211 and The Artistic Licence (see the files README, Copying, and Artistic,
1212 or L<perlgpl> and L<perlartistic>). Larry has good reasons for NOT
1213 just using the GNU GPL.
1215 My personal recommendation, out of respect for Larry, Perl, and the
1216 Perl community at large is to state something simply like:
1218 Copyright (c) 1995 Your Name. All rights reserved.
1219 This program is free software; you can redistribute it and/or
1220 modify it under the same terms as Perl itself.
1222 This statement should at least appear in the README file. You may
1223 also wish to include it in a Copying file and your source files.
1224 Remember to include the other words in addition to the Copyright.
1228 Give the module a version/issue/release number.
1230 To be fully compatible with the Exporter and MakeMaker modules you
1231 should store your module's version number in a non-my package
1232 variable called $VERSION. This should be a floating point
1233 number with at least two digits after the decimal (i.e., hundredths,
1234 e.g, C<$VERSION = "0.01">). Don't use a "1.3.2" style version.
1235 See L<Exporter> for details.
1237 It may be handy to add a function or method to retrieve the number.
1238 Use the number in announcements and archive file names when
1239 releasing the module (ModuleName-1.02.tar.Z).
1240 See perldoc ExtUtils::MakeMaker.pm for details.
1244 How to release and distribute a module.
1246 It's good idea to post an announcement of the availability of your
1247 module (or the module itself if small) to the comp.lang.perl.announce
1248 Usenet newsgroup. This will at least ensure very wide once-off
1251 If possible, register the module with CPAN. You should
1252 include details of its location in your announcement.
1254 Some notes about ftp archives: Please use a long descriptive file
1255 name that includes the version number. Most incoming directories
1256 will not be readable/listable, i.e., you won't be able to see your
1257 file after uploading it. Remember to send your email notification
1258 message as soon as possible after uploading else your file may get
1259 deleted automatically. Allow time for the file to be processed
1260 and/or check the file has been processed before announcing its
1263 FTP Archives for Perl Modules:
1265 Follow the instructions and links on:
1267 http://www.cpan.org/modules/00modlist.long.html
1268 http://www.cpan.org/modules/04pause.html
1270 or upload to one of these sites:
1272 https://pause.kbx.de/pause/
1273 http://pause.perl.org/pause/
1275 and notify <modules@perl.org>.
1277 By using the WWW interface you can ask the Upload Server to mirror
1278 your modules from your ftp or WWW site into your own directory on
1281 Please remember to send me an updated entry for the Module list!
1285 Take care when changing a released module.
1287 Always strive to remain compatible with previous released versions.
1288 Otherwise try to add a mechanism to revert to the
1289 old behavior if people rely on it. Document incompatible changes.
1295 =head2 Guidelines for Converting Perl 4 Library Scripts into Modules
1301 There is no requirement to convert anything.
1303 If it ain't broke, don't fix it! Perl 4 library scripts should
1304 continue to work with no problems. You may need to make some minor
1305 changes (like escaping non-array @'s in double quoted strings) but
1306 there is no need to convert a .pl file into a Module for just that.
1310 Consider the implications.
1312 All Perl applications that make use of the script will need to
1313 be changed (slightly) if the script is converted into a module. Is
1314 it worth it unless you plan to make other changes at the same time?
1318 Make the most of the opportunity.
1320 If you are going to convert the script to a module you can use the
1321 opportunity to redesign the interface. The guidelines for module
1322 creation above include many of the issues you should consider.
1326 The pl2pm utility will get you started.
1328 This utility will read *.pl files (given as parameters) and write
1329 corresponding *.pm files. The pl2pm utilities does the following:
1335 Adds the standard Module prologue lines
1339 Converts package specifiers from ' to ::
1343 Converts die(...) to croak(...)
1347 Several other minor changes
1351 Being a mechanical process pl2pm is not bullet proof. The converted
1352 code will need careful checking, especially any package statements.
1353 Don't delete the original .pl file till the new .pm one works!
1357 =head2 Guidelines for Reusing Application Code
1363 Complete applications rarely belong in the Perl Module Library.
1367 Many applications contain some Perl code that could be reused.
1369 Help save the world! Share your code in a form that makes it easy
1374 Break-out the reusable code into one or more separate module files.
1378 Take the opportunity to reconsider and redesign the interfaces.
1382 In some cases the 'application' can then be reduced to a small
1384 fragment of code built on top of the reusable modules. In these cases
1385 the application could invoked as:
1387 % perl -e 'use Module::Name; method(@ARGV)' ...
1389 % perl -mModule::Name ... (in perl5.002 or higher)
1395 Perl does not enforce private and public parts of its modules as you may
1396 have been used to in other languages like C++, Ada, or Modula-17. Perl
1397 doesn't have an infatuation with enforced privacy. It would prefer
1398 that you stayed out of its living room because you weren't invited, not
1399 because it has a shotgun.
1401 The module and its user have a contract, part of which is common law,
1402 and part of which is "written". Part of the common law contract is
1403 that a module doesn't pollute any namespace it wasn't asked to. The
1404 written contract for the module (A.K.A. documentation) may make other
1405 provisions. But then you know when you C<use RedefineTheWorld> that
1406 you're redefining the world and willing to take the consequences.
1409 close MANIFEST or warn "$0: failed to close MANIFEST (../MANIFEST): $!";
1410 close OUT or warn "$0: failed to close OUT (perlmodlib.tmp): $!";