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 --builder=ExtUtils::MakeMaker
19           --mb             Same as --builder=Module::Build
20           --mi             Same as --builder=Module::Install (discouraged)
21
22           --author=name    Author's name (taken from getpwuid if not provided)
23           --email=email    Author's email (taken from EMAIL if not provided)
24
25           --ignores=type   Ignore type files to include (repeatable)
26           --license=type   License under which the module will be distributed
27                            (default is artistic2)
28           --genlicense     Generate LICENSE file according to specified license
29           --minperl=ver    Minimum Perl version required (optional;
30                            default is 5.006)
31
32           --fatalize       Generate code that causes all warnings to be fatal with:
33                            use warnings FATAL => 'all'
34
35           --verbose        Print progress messages while working
36           --force          Delete pre-existing files if needed
37
38           --help           Show this message
39
40       Available Licenses:
41
42           perl, artistic, artistic2, mit, mozilla, mozilla2, bsd, freebsd, cc0,
43           gpl, lgpl, gpl3, lgpl3, agpl3, apache, qpl
44
45       You may also specify any Software::License subclass or CPAN::Meta::Spec
46       license string.
47
48       Available Ignore Types:
49
50           cvs, git, hg, manifest, generic
51           (NOTE: If manifest is included, the MANIFEST file will be skipped
52           and only a MANIFEST.SKIP file will be included.)
53
54       Example:
55
56           module-starter --module=Foo::Bar,Foo::Bat \
57               --author="Andy Lester" --email=andy@petdance.com
58

DESCRIPTION

60       "module-starter" is a command-line interface to Module::Starter, which
61       it uses to perform all the work of creating distributions.  An
62       alternate backend for "module-starter" can be specified with the
63       "--class" option.  Plugins to the standard Module::Starter module can
64       be specified with one or more "--plugin" options.
65
66       If no directory name is supplied, the distribution name will be used
67       for the directory.  If no distribution name is supplied, the first
68       listed module name will be used as the distribution name.
69
70       Multiple --builder options may be supplied to produce the files for
71       multiple builders.
72

CONFIGURATION

74       module-starter will look for a configuration file before reading its
75       command line parameters.  The default location is
76       "$HOME/.module-starter/config" but if the MODULE_STARTER_DIR
77       environment variable is set, module-starter will look for "config" in
78       that directory.
79
80       The configuration file is just a list of names and values, separated by
81       colons.  Values that take lists are just space separated. Note that the
82       "--ignores" command line parameter corresponds to the "ignores_type"
83       configuration file entry. A sample configuration file might read:
84
85        author: Ricardo SIGNES
86        email:  rjbs@cpan.org
87        ignores_type: git
88        plugins: Module::Starter::Simple Module::Starter::Plugin::XYZ
89        xyz_option: red green blue
90
91       This format may become more elaborate in the future, but a file of this
92       type should remain valid.
93
94
95
96perl v5.30.1                      2020-01-30                 MODULE-STARTER(1)
Impressum