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
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           --minperl=ver    Minimum Perl version required (optional;
29                            default is 5.006)
30
31           --fatalize       Generate code that causes all warnings to be fatal with:
32                            use warnings FATAL => 'all'
33
34           --verbose        Print progress messages while working
35           --force          Delete pre-existing files if needed
36
37           --help           Show this message
38
39       Available Licenses:
40
41           perl, artistic, artistic2, mit, mozilla, mozilla2, bsd, freebsd, cc0,
42           gpl, lgpl, gpl3, lgpl3, agpl3, apache, qpl
43
44       Available Ignore Types:
45
46           cvs, git, hg, manifest, generic
47           (NOTE: If manifest is included, the MANIFEST file will be skipped
48           and only a MANIFEST.SKIP file will be included.)
49
50       Example:
51
52           module-starter --module=Foo::Bar,Foo::Bat \
53               --author="Andy Lester" --email=andy@petdance.com
54

DESCRIPTION

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

CONFIGURATION

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