/ 
CPAN-Mini-0.20
River stage three • 32 direct dependents • 114 total dependents
/ CPAN::Mini

NAME

CPAN::Mini - create a minimal mirror of CPAN

VERSION

version 0.20

$Id: Mini.pm,v 1.12 2004/09/28 10:41:48 rjbs Exp $

SYNOPSIS

(If you're not going to do something weird, you probably want to look at the minicpan command, instead.)

use CPAN::Mini;

CPAN::Mini->update_mirror(
 remote => "http://cpan.mirrors.comintern.su",
 local  => "/usr/share/mirrors/cpan",
 trace  => 1
);

DESCRIPTION

CPAN::Mini provides a simple mechanism to build and update a minimal mirror of the CPAN on your local disk. It contains only those files needed to install the newest version of every distribution. Those files are:

  • 01mailrc.txt.gz

  • 02packages.details.txt.gz

  • 03modlist.data.gz

  • the last non-developer release of every dist for every author

METHODS

update_mirror( %args )

CPAN::Mini->update_mirror(
 remote => "http://cpan.mirrors.comintern.su",
 local  => "/usr/share/mirrors/cpan",
 force  => 0,
 trace  => 1
);

This is the only method that need be called from outside this module. It will update the local mirror with the files from the remote mirror. If the trace option is true, CPAN::Mini will print status messages as it runs.

update_mirror creates an ephemeral CPAN::Mini object on which other methods are called. That object is used to store mirror location and state.

The dirmode option (generally an octal number) sets the permissions of created directories. It defaults to 0711.

This method returns the number of files updated.

mirror_indices

This method updates the index files from the CPAN.

mirror_file($path, $skip_if_present)

This method will mirror the given file from the remote to the local mirror, overwriting any existing file unless $skip_if_present is true.

file_allowed($file)

This method returns true if the given file is allowed to exist in the local mirror, even if it isn't one of the required mirror files.

By default, only dot-files are allowed.

clean_unmirrored

This method finds any files in the local mirror which are no longer needed and removes them.

trace( $message, $force )

If the object is mirroring verbosely, this method will print messages sent to it. If CPAN::Mini is not operating in verbose mode, but $force is true, it will print the message anyway.

SEE ALSO

Randal Schwartz's original article on minicpan, here:

http://www.stonehenge.com/merlyn/LinuxMag/col42.html

CPANPLUS::Backend, which provides the local_mirror method, which performs the same task as this module.

THANKS

Thanks to David Dyck for letting me know about my stupid documentation errors.

Thanks to Roy Fulbright for finding an obnoxious bug on Win32.

AUTHORS

Randal Schwartz <merlyn@stonehenge.com> did all the work.

Ricardo SIGNES <rjbs@cpan.org> made a module and distribution.

This code was copyrighted in 2004, and is released under the same terms as Perl itself.