1MODULE-STARTER(1)     User Contributed Perl Documentation    MODULE-STARTER(1)
2
3
4

NAME

6       module-starter - creates a skeleton module distribution
7

SYNOPSIS

9       module-starter [options]
10
11       Options:
12
13           --module=module  Module name (required, repeatable)
14           --distro=name    Distribution name (optional)
15           --dir=dirname    Directory name to create new module in (optional)
16
17           --builder=module Build with 'ExtUtils::MakeMaker' or 'Module::Build'
18           --eumm           Same as --build=ExtUtils::MakeMaker
19           --mb             Same as --build=Module::Build
20
21           --author=name    Author's name (required)
22           --email=email    Author's email (required)
23           --license=type   License under which the module will be distributed
24                            (default is the same license as perl)
25
26           --verbose        Print progress messages while working
27           --force          Delete pre-existing files if needed
28
29           --help           Show this message
30
31       Example:
32
33           module-starter --module=Foo::Bar,Foo::Bat \
34               --author="Andy Lester" --email=andy@petdance.com
35

DESCRIPTION

37       "module-starter" is a command-line interface to Module::Starter, which
38       it uses to perform all the work of creating distributions.  An alter‐
39       nate backend for "module-starter" can be specified with the "--class"
40       option.  Plugins to the standard Module::Starter module can be speci‐
41       fied with one or more "--plugin" options.
42
43       If no directory name is supplied, the distribution name will be used
44       for the directory.  If no distribution name is supplied, the first
45       listed module name will be used as the distribution name.
46
47       Multiple --builder options may be supplied to produce the files for
48       multiple builders.
49

CONFIGURATION

51       module-starter will look for a configuration file before reading its
52       command line parameters.  The default location is "$HOME/.mod‐
53       ule-starter/config" but if the MODULE_STARTER_DIR environment variable
54       is set, module-starter will look for "config" in that directory.
55
56       The configuration file is just a list of names and values, separated by
57       colons.  Values that take lists are just space separated.  A sample
58       configuration file might read:
59
60        author: Ricardo SIGNES
61        email:  rjbs@cpan.org
62        plugins: Module::Starter::Simple Module::Starter::Plugin::XYZ
63        xyz_option: red green blue
64
65       This format may become more elaborate in the future, but a file of this
66       type should remain valid.
67
68
69
70perl v5.8.8                       2005-08-19                 MODULE-STARTER(1)
Impressum