Skip to content

Commit

Permalink
Autogenerated README with make README
Browse files Browse the repository at this point in the history
  • Loading branch information
@xdg
xdg committed Feb 14, 2011
1 parent 0ad4ac0 commit 22c82ba
Showing 1 changed file with 27 additions and 26 deletions.
53 changes: 27 additions & 26 deletions README
View file
Expand Up @@ -335,14 +335,14 @@ DESCRIPTION
recompile
recompile() is a special command that takes no argument and runs the
make/test/install cycle with brute force over all installed dynamically
loadable extensions (aka XS modules) with 'force' in effect. The primary
purpose of this command is to finish a network installation. Imagine you
have a common source tree for two different architectures. You decide to
do a completely independent fresh installation. You start on one
architecture with the help of a Bundle file produced earlier. CPAN
installs the whole Bundle for you, but when you try to repeat the job on
the second architecture, CPAN responds with a "Foo up to date" message
for all modules. So you invoke CPAN's recompile on the second
loadable extensions (a.k.a. XS modules) with 'force' in effect. The
primary purpose of this command is to finish a network installation.
Imagine you have a common source tree for two different architectures.
You decide to do a completely independent fresh installation. You start
on one architecture with the help of a Bundle file produced earlier.
CPAN installs the whole Bundle for you, but when you try to repeat the
job on the second architecture, CPAN responds with a "Foo up to date"
message for all modules. So you invoke CPAN's recompile on the second
architecture and you're done.

Another popular use for "recompile" is to act as a rescue in case your
Expand Down Expand Up @@ -559,7 +559,8 @@ CONFIGURATION
dontload_list arrayref: modules in the list will not be
loaded by the CPAN::has_inst() routine
ftp path to external prg
ftp_passive if set, the envariable FTP_PASSIVE is set for downloads
ftp_passive if set, the environment variable FTP_PASSIVE is set
for downloads
ftp_proxy proxy host for ftp requests
ftpstats_period max number of days to keep download statistics
ftpstats_size max number of items to keep in the download statistics
Expand Down Expand Up @@ -984,7 +985,7 @@ CONFIGURATION
The path to each patch is either an absolute path on the local
filesystem or relative to a patch directory specified in the
"patches_dir" configuration variable or in the format of a canonical
distroname. For examples please consult the distroprefs/ directory
distro name. For examples please consult the distroprefs/ directory
in the CPAN.pm distribution (these examples are not installed by
default).

Expand Down Expand Up @@ -1216,7 +1217,7 @@ PROGRAMMER'S INTERFACE
Like CPAN::Bundle::inst_file, but returns the $VERSION

CPAN::Bundle::uptodate()
Returns 1 if the bundle itself and all its members are uptodate.
Returns 1 if the bundle itself and all its members are up-to-date.

CPAN::Bundle::install()
Recursively runs the "install" method on all items contained in the
Expand Down Expand Up @@ -1303,7 +1304,7 @@ PROGRAMMER'S INTERFACE
uptodate().

CPAN::Distribution::install_tested()
Install all distributions that have tested sucessfully but not yet
Install all distributions that have tested successfully but not yet
installed. See also "is_tested".

CPAN::Distribution::isa_perl()
Expand Down Expand Up @@ -1334,7 +1335,7 @@ PROGRAMMER'S INTERFACE
Returns the hash reference from the first matching YAML file that
the user has deposited in the "prefs_dir/" directory. The first
succeeding match wins. The files in the "prefs_dir/" are processed
alphabetically, and the canonical distroname (e.g.
alphabetically, and the canonical distro name (e.g.
AUTHOR/Foo-Bar-3.14.tar.gz) is matched against the regular
expressions stored in the $root->{match}{distribution} attribute
value. Additionally all module names contained in a distribution are
Expand Down Expand Up @@ -1373,7 +1374,7 @@ PROGRAMMER'S INTERFACE

CPAN::Distribution::uptodate()
Returns 1 if all the modules contained in the distribution are
uptodate. Relies on containsmods.
up-to-date. Relies on containsmods.

CPAN::Index::force_reload()
Forces a reload of all indices.
Expand All @@ -1392,7 +1393,7 @@ PROGRAMMER'S INTERFACE
Returns a one-line description of the module in four columns: The
first column contains the word "Module", the second column consists
of one character: an equals sign if this module is already installed
and uptodate, a less-than sign if this module is installed but can
and up-to-date, a less-than sign if this module is installed but can
be upgraded, and a space if the module is not installed. The third
column is the name of the module and the fourth column gives
maintainer or distribution information.
Expand Down Expand Up @@ -1446,7 +1447,7 @@ PROGRAMMER'S INTERFACE
d - Developer
u - Usenet newsgroup comp.lang.perl.modules
n - None known, try comp.lang.perl.modules
a - abandoned; volunteers welcome to take over maintainance
a - abandoned; volunteers welcome to take over maintenance

L - Language Used:
p - Perl-only, no compiler needed, should be platform independent
Expand All @@ -1470,9 +1471,9 @@ PROGRAMMER'S INTERFACE
b - BSD: The BSD License
a - Artistic license alone
2 - Artistic license 2.0 or later
o - open source: appoved by www.opensource.org
o - open source: approved by www.opensource.org
d - allows distribution without restrictions
r - restricted distribtion
r - restricted distribution
n - no license at all

CPAN::Module::force($method,@args)
Expand Down Expand Up @@ -1574,7 +1575,7 @@ PROGRAMMER'S INTERFACE
Module_Name [Version_String] [- optional text]

The only required part is the first field, the name of a module (e.g.
Foo::Bar, ie. *not* the name of the distribution file). The rest of the
Foo::Bar, i.e. *not* the name of the distribution file). The rest of the
line is optional. The comment part is delimited by a dash just as in the
man page header.

Expand All @@ -1591,7 +1592,7 @@ PROGRAMMER'S INTERFACE

PREREQUISITES
The CPAN program is trying to depend on as little as possible so the
user can use it in hostile enviroment. It works better the more goodies
user can use it in hostile environment. It works better the more goodies
the environment provides. For example if you try in the CPAN shell

install Bundle::CPAN
Expand Down Expand Up @@ -1720,7 +1721,7 @@ SECURITY
command-line gpg tool installed.

You will also need to be able to connect over the Internet to the public
keyservers, like pgp.mit.edu, and their port 11731 (the HKP protocol).
key servers, like pgp.mit.edu, and their port 11731 (the HKP protocol).

The configuration parameter check_sigs is there to turn signature
checking on or off.
Expand Down Expand Up @@ -1775,7 +1776,7 @@ POPULATE AN INSTALLATION WITH LOTS OF MODULES
distributions need some interactive configuring. So what you can try to
accomplish in your private bundle file is to have the packages that need
to be configured early in the file and the gentle ones later, so you can
go out for cofeee after a few minutes and leave CPAN.pm to churn away
go out for coffee after a few minutes and leave CPAN.pm to churn away
untended.

WORKING WITH CPAN.pm BEHIND FIREWALLS
Expand Down Expand Up @@ -1958,7 +1959,7 @@ FAQ

cpan> o conf term_is_latin 1

If other charset support is needed, please file a bugreport against
If other charset support is needed, please file a bug report against
CPAN.pm at rt.cpan.org and describe your needs. Maybe we can extend
the support or maybe UTF-8 terminals become widely available.

Expand Down Expand Up @@ -2018,10 +2019,10 @@ FAQ

Beyond that help, the urllist config parameter is yours. You can add
and remove sites at will. You should find out which sites have the
best uptodateness, bandwidth, reliability, etc. and are
best up-to-dateness, bandwidth, reliability, etc. and are
topologically close to you. Some people prefer fast downloads,
others uptodateness, others reliability. You decide which to try in
which order.
others up-to-dateness, others reliability. You decide which to try
in which order.

Henk P. Penning maintains a site that collects data about CPAN
sites:
Expand Down

0 comments on commit 22c82ba

Please sign in to comment.