NAME

minicpan_pdwix - a minicpan script for Perl::Dist::WiX and subclasses.

VERSION

This document describes minicpan_pdwix version 1.000.

DESCRIPTION

This creates a minicpan for Perl::Dist::WiX and subclasses to use that contains the minimum files required to make a perl distribution.

SYNOPSIS

  minicpan_pdwix [ --dist <distribution> ] [ --module <module> ]
                 [ --file <file> ] [ --cpan <URL> ] [ --[no]force ]
                 [ --minicpan <dir> ] [ --[no]verbose ]
                 [ --help ] [ --usage ] [ --man ] [ --version ] [ -?]
				 
  Options:
    --dist <dist>     Loads a list to download from the named distribution.
    --module <module> Loads a list to download from the named module.
    --file <file>     Loads a list to download from the named file.	
    --cpan <URL>      Specifies the CPAN mirror to download to.
                      Defaults to http://cpan.hexten.net/.
    --minicpan <dir>  Specifies the directory to download to.
                      Defaults to C:\minicpan\.

    --verbose         Lists the files as they are downloaded. (default)
    --noverbose       Does not list the files as they are downloaded.
	
    --force           Forces rescanning even if index files are not updated.
    --noforce         Does not force rescanning of minicpan. (default)

    --usage           Gives a minimum amount of aid and comfort.
    --help            Gives aid and comfort.
    -?                Gives aid and comfort.
    --man             Gives maximum aid and comfort.	
	
    --version         Gives the name, version and copyright of the script.
	

OPTIONS

--dist

Loads a list of regular expressions that specify which files to download from the file minicpan_filters.txt in the directory File::ShareDir uses for the named distribution.

--module

Loads a list of regular expressions that specify which files to download from the file minicpan_filters.txt in the directory File::ShareDir uses for the named module.

--file

Loads a list of regular expressions that specify which files to download from the named file.

--cpan

Specifies the CPAN mirror to use.

Defaults to http://cpan.hexten.net/.

--minicpan

Specifies the location to download the minicpan.

Defaults to C:\minicpan\.

--verbose/--noverbose

Specifies whether the list of files downloaded should be printed or not.

Defaults to --verbose.

--force/--noforce

Specifies whether the index files should be rescanned even if they were not updated. This is useful when the list of files to download has been changed.

Defaults to --noforce.

--usage

Print a brief usage message and exits.

--help or -?

Print a short help message and exits.

--man

Prints the POD documentation contained in the script and exits.

--version

Prints the script name, version, and copyright and exits.

CONFIGURATION

No environment variables are used during the execution of this script that the modules used do not already use.

The --dist and --module options use File::ShareDir to get a file named minicpan_filters.txt from the root directory of the named options.

The --file option names a file to load.

The files loaded by the options mentioned above contain a list of regular expressions that define files to download, as shown in the example file below:

# Downloads 4 files.

/MBARBON/Wx-\d
/MDOOTSON/Wx-Perl-ProcessStream-
/(?:GARU|SZABGAB)/Padre-\d
/AZAWAWI/Padre-Plugin-Perl6-

There are no options given by default, and lines containing only whitespace, or that are empty, or whose first non-whitespace character is a # are disregarded.

DEPENDENCIES

Perl 5.10.0 is the mimimum version of perl that this script will run on.

Other modules that this script depends on are IO::Handle, List::Util, List::MoreUtils, File::ShareDir 1.00, File::Slurp, Getopt::Long, Pod::Usage, English, CPAN::Mini 0.576, and CPAN::Mini::Devel 0.03.

SUPPORT

No support is provided for this script.

AUTHOR

Curtis Jewell, <csjewell@cpan.org>

COPYRIGHT & LICENSE

Copyright 2009 Curtis Jewell.

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

The full text of the license can be found in the LICENSE file included with this distribution.