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

NAME

6       module-starter - creates a skeleton module distribution
7

VERSION

9       version 1.77
10

SYNOPSIS

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

DESCRIPTION

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

CONFIGURATION

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