CPAN

CPAN is an worldwide.

=Modules=

Like many programming languages, Perl has mechanisms to use external libraries of code, allowing a single file to contain common routines used by several programs. Perl calls these modules. Perl modules are typically installed in one of several directory whose path (computing) are placed in the Perl interpreter when it is first compiled; on Unix-like operating systems, common paths include /usr/lib/perl5 , /usr/local/lib/perl5 , and several of their subdirectories.

Perl comes with a small set of core modules. Some of these perform esoteric tasks, such as , are merely commonly-used. The authors of Perl don t expect this limited group to meet every need, however.

=The CPAN s role=

The CPAN s main purpose is to help programmers easily locate modules and scripts not included in the Perl standard distribution. It is also used to distribute new versions of Perl, as well as related projects, such as Parrot virtual machine.

The CPAN is an important resource for the professional Perl programmer. The nearly 9,000 modules (as of this writing) on it can save a programmer weeks of effort. Some of them, such as the module, are simply handy resources containing a few common functions.

=CPAN structure=

Files on the CPAN are referred to as distributions. A distribution may consist of one or more modules, documentation files, or scripts packaged in a common archiving format, such as a Gzipped tar file format archive or a PKWARE ZIP file format file. Distributions will often contain installation scripts (usually called Makefile.PL or Build.PL ) and test scripts which can be run to verify the contents of the distribution are functioning properly.

In 2003 distributions started to include metadata files, called META.yml , indicating the distribution s name, version, dependencies, and other useful information; however, not all distributions contain metadata. When metadata is not present in a distribution, the PAUSE s software will usually try to analyze the code in the distribution to look for the same information; this is not necessarily very reliable. (See the #Uploading Distributions with PAUSE section for more.)

With thousands of distributions, CPAN needs to be structured to be useful. Distributions on the CPAN are divided into 24 broad chapters based on their purpose, such as ) can sometimes be used to browse modules in the CPAN.

CPAN module distributions usually have names in the form of CGI-Application-3.1 (where the :: used in the module s name has been replaced with a dash, and the version number has been appended to the name), but this is only a convention; many prominent distributions break the convention, especially those that contain multiple modules. Security restrictions prevent a distribution from ever being replaced, so virtually all distribution names do include a version number.

=Components of CPAN=

==The CPAN mirrors==

The heart of the CPAN is its worldwide network of mirrors. The CPAN master site, ftp.funet.fi, has over 250 public mirrors in 60 countries. Each site has a copy of the over 2.5 gigabytes of data in the CPAN.

Most mirrors update themselves daily from the CPAN master site. Some update two times a day or even hourly, and a few update from other mirrors. Some sites are major FTP servers which mirror lots of other software, but others are simply servers owned by companies that use Perl heavily. There are at least five mirrors on every continent except Antarctica.

For more information on CPAN mirrors, see [http://mirrors.cpan.org/ mirrors.cpan.org].

==Search engines==

Several search engines have been written to help Perl programmers sort through the CPAN. The most popular is probably [http://search.cpan.org/ search.cpan.org], which includes textual search, a browsable index of modules, and extracted copies of all distributions currently on the CPAN. Another popular search engine is [http://cpan.uwinnipeg.ca/htdocs/faqs/cpan-search.html cpan.uwinnipeg.ca].

==Other supporting websites==

There s a whole family of loosely integrated CPAN support websites: [http://cpanratings.perl.org CPANRatings] allows users to write short reviews and rate modules on a 5-star scale; [http://cpanforum.com CPAN::Forum] is a discussion forum where threads are classified by CPAN distribution; [http://annocpan.org AnnoCPAN] displays the documentation for all the modules on CPAN, along with user-contributed annotations; [http://rt.cpan.org rt.cpan.org] is a resource tracker for bugs and features; and [http://testers.cpan.org/ CPAN Testers] collects testing results for all CPAN uploads on various platforms.

==CPAN.pm and CPANPLUS==

There is also a Perl core module named CPAN; it s usually differentiated from the repository itself by calling it CPAN.pm. CPAN.pm is mainly an interactive shell which can be used to search for, download, and install distributions. perl -MCPAN -e shell is the usual way of running CPAN.pm. After a short configuration process and mirror selection, it uses tools available on the user s computer to automatically download, unpack, compile, test, and install modules. It is even capable of updating itself.

Recently an effort to replace CPAN.pm with something cleaner and more modern has resulted in the CPANPLUS or CPAN++ set of modules. CPANPLUS more cleanly separates the back-end work of downloading, compiling, and installing modules from the interactive shell used to issue commands. It also supports several advanced features, such as cryptographic signature checking and test result reporting. Finally, CPANPLUS can uninstall a distribution. CPANPLUS is expected to replace CPAN.pm in the core distribution in Perl 5.10.

Both modules can check a distribution s dependencies and are capable of automatically (or with the user s approval) installing any prerequisites. Both support FTP and HTTP and can work through firewalls and proxies.

==Uploading distributions with PAUSE==

Authors can upload new distributions to the CPAN through the Perl Authors Upload Server (PAUSE). To do so, they must register for a PAUSE account. PAUSE accounts have a 3-9 character username consisting of uppercase letters only--no numbers, no lowercase, no punctuation. They also give their full name in their native language, an e-mail address, an optional web address, and a short description of what [they] re planning to contribute to the CPAN.

Registration is not immediate, and typically takes a week.

Once registered, the new PAUSE account has a directory in the CPAN under authors/id/(first letter)/(first two letters)/(author ID) . They may use a Web interface to upload files to their directory and delete them. The PAUSE will warn an administrator if a user uploads a module that already exists, unless they are listed as a co-maintainer. This can be specified through PAUSE s web interface.

=The CPAN s significance to Perl=

Experienced Perl programmers often comment that half of Perl s power is in the CPAN. Though the TeX typesetting language has an equivalent, the CTAN (and in fact the CPAN s name is based on the CTAN), few languages have an exhaustive central repository for libraries. The PHP language has PECL (PHP Extension Community Library) and PHP Extension and Application Repository (PHP Extension and Application Repository), and Python programming language has a PyPI (Python Package Index) repository, but neither is as large or active as the CPAN. Other major languages, such as Java programming language and C plus plus, do not have anything even resembling the CPAN.

The CPAN s influence on Perl s eclectic culture should not be underestimated either. As a hive of activity in the Perl world, the CPAN both shapes and is shaped by Perl culture. Its self-appointed master librarian , , a site infamous in the Perl community for having badly-written code.

Beyond April Fools , however, some of the distributions on the CPAN are jokes in themselves. The , which can be used to write Perl programs in a subset of Latin.

=See also=

*CRAN *CTAN