NAME

minicpan - uses CPAN::Mini to create or update a local mirror

VERSION

version 1.111001

SYNOPSIS

 minicpan [options]

 Options
   -l LOCAL   - where is the local minicpan?     (required)
   -r REMOTE  - where is the remote cpan mirror? (required)
   -d 0###    - permissions (numeric) to use when creating directories
   -f         - check all directories, even if indices are unchanged
   -p         - mirror perl, ponie, and parrot distributions
   -q         - run in quiet mode (don't print status)
   -qq        - run in silent mode (don't even print warnings)
   -c CLASS   - what class to use to mirror (default: CPAN::Mini)
   -C FILE    - what config file to use (default: ~/.minicpanrc)
   -h         - print help and exit
   -v         - print version and exit
   -x         - build an exact mirror, getting even normally disallowed files
   -t SEC     - timeout in sec. Defaults to 180 sec
   --offline  - operate in offline mode (generally: do nothing)

DESCRIPTION

This simple shell script just updates (or creates) a miniature CPAN mirror as described in CPAN::Mini.

CONFIGURATION FILE

By default, minicpan will read a configuration file to get configuration information. The file is a simple set of names and values, as in the following example:

 local:  /home/rjbs/mirrors/minicpan/
 remote: http://your.favorite.cpan/cpan/
 exact_mirror: 1

minicpan tries to find a configuration file through the following process. It takes the first defined it finds:

• Use the value specified by -C on the command line

• Use the value in the CPAN_MINI_CONFIG environment variable

• Use ~/.minicpanrc

• Use CPAN/Mini/minicpan.conf

If the selected file does not exist, minicpan does not keep looking.

You can override this process with a config_file method in your subclass.

See CPAN::Mini for a full listing of available options.

TO DO

Improve command-line options.

SEE ALSO

Randal Schwartz's original article, which can be found here:

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

AUTHORS

• Ricardo SIGNES <rjbs@cpan.org>

• Randal Schwartz <merlyn@stonehenge.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2004 by Ricardo SIGNES.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.