1MODULE-STARTER(1) User Contributed Perl Documentation MODULE-STARTER(1)
2
3
4
6 module-starter - creates a skeleton module distribution
7
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 --builder=ExtUtils::MakeMaker
19 --mb Same as --builder=Module::Build
20 --mi Same as --builder=Module::Install
21
22 --author=name Author's name (required)
23 --email=email Author's email (required)
24 --license=type License under which the module will be distributed
25 (default is the same license as perl)
26
27 --verbose Print progress messages while working
28 --force Delete pre-existing files if needed
29
30 --help Show this message
31
32 Available Licenses:
33 perl, bsd, gpl, lgpl, mit
34
35 Example:
36
37 module-starter --module=Foo::Bar,Foo::Bat \
38 --author="Andy Lester" --email=andy@petdance.com
39
41 "module-starter" is a command-line interface to Module::Starter, which
42 it uses to perform all the work of creating distributions. An
43 alternate backend for "module-starter" can be specified with the
44 "--class" option. Plugins to the standard Module::Starter module can
45 be specified with one or more "--plugin" options.
46
47 If no directory name is supplied, the distribution name will be used
48 for the directory. If no distribution name is supplied, the first
49 listed module name will be used as the distribution name.
50
51 Multiple --builder options may be supplied to produce the files for
52 multiple builders.
53
55 module-starter will look for a configuration file before reading its
56 command line parameters. The default location is
57 "$HOME/.module-starter/config" but if the MODULE_STARTER_DIR
58 environment variable is set, module-starter will look for "config" in
59 that directory.
60
61 The configuration file is just a list of names and values, separated by
62 colons. Values that take lists are just space separated. A sample
63 configuration file might read:
64
65 author: Ricardo SIGNES
66 email: rjbs@cpan.org
67 plugins: Module::Starter::Simple Module::Starter::Plugin::XYZ
68 xyz_option: red green blue
69
70 This format may become more elaborate in the future, but a file of this
71 type should remain valid.
72
73
74
75perl v5.12.0 2009-08-13 MODULE-STARTER(1)