1Module::Starter(3)    User Contributed Perl Documentation   Module::Starter(3)
2
3
4

NAME

6       Module::Starter - a simple starter kit for any module
7

VERSION

9       version 1.54
10

SYNOPSIS

12       Nothing in here is meant for public consumption.  Use module-starter
13       from the command line.
14
15           module-starter --module=Foo::Bar,Foo::Bat \
16               --author="Andy Lester" --email=andy@petdance.com
17

DESCRIPTION

19       This is the core module for Module::Starter.  If you're not looking to
20       extend or alter the behavior of this module, you probably want to look
21       at module-starter instead.
22
23       Module::Starter is used to create a skeletal CPAN distribution,
24       including basic builder scripts, tests, documentation, and module code.
25       This is done through just one method, "create_distro".
26

METHODS

28   Module::Starter->create_distro(%args)
29       "create_distro" is the only method you should need to use from outside
30       this module; all the other methods are called internally by this one.
31
32       This method creates orchestrates all the work; it creates distribution
33       and populates it with the all the requires files.
34
35       It takes a hash of params, as follows:
36
37           distro       => $distroname,      # distribution name (defaults to first module)
38           modules      => [ module names ], # modules to create in distro
39           dir          => $dirname,         # directory in which to build distro
40           builder      => 'Module::Build',  # defaults to ExtUtils::MakeMaker
41                                             # or specify more than one builder in an
42                                             # arrayref
43
44           license      => $license,  # type of license; defaults to 'perl'
45           author       => $author,   # author's full name (required)
46           email        => $email,    # author's email address (required)
47           ignores_type => $type,     # ignores file type ('generic', 'cvs', 'git', 'manifest' )
48
49           verbose      => $verbose,  # bool: print progress messages; defaults to 0
50           force        => $force     # bool: overwrite existing files; defaults to 0
51
52       The ignores_type is a new feature that allows to create SCM-specific
53       ignore files.  These are the mappings:
54
55           ignores_type => 'generic'  # default, creates 'ignore.txt'
56           ignores_type => 'cvs'      # creates .cvsignore
57           ignores_type => 'git'      # creates .gitignore
58           ignores_type => 'manifest' # creates MANIFEST.SKIP
59
60       It is also possible to provide an array ref with multiple types wanted:
61
62           ignores_type => [ 'git', 'manifest' ]
63

PLUGINS

65       Module::Starter itself doesn't actually do anything.  It must load
66       plugins that implement "create_distro" and other methods.  This is done
67       by the class's "import" routine, which accepts a list of plugins to be
68       loaded, in order.
69
70       For more information, refer to Module::Starter::Plugin.
71

AUTHORS

73       Andy Lester, "<petdance at cpan.org>"
74
75       Ricardo Signes, "<rjbs at cpan.org>"
76
77       C.J. Adams-Collier, "<cjac at colliertech.org>"
78

SUPPORT

80       You can find documentation for this module with the perldoc command.
81
82           perldoc Module::Starter
83
84       You can also look for information at:
85
86       ·   Source code at Google Code
87
88           http://code.google.com/p/module-starter/
89           <http://code.google.com/p/module-starter/>
90
91       ·   AnnoCPAN: Annotated CPAN documentation
92
93           http://annocpan.org/dist/Module-Starter
94           <http://annocpan.org/dist/Module-Starter>
95
96       ·   CPAN Ratings
97
98           http://cpanratings.perl.org/d/Module-Starter
99           <http://cpanratings.perl.org/d/Module-Starter>
100
101       ·   RT: CPAN's request tracker
102
103           http://rt.cpan.org/NoAuth/Bugs.html?Dist=Module-Starter
104           <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Module-Starter>
105
106       ·   Search CPAN
107
108           http://search.cpan.org/dist/Module-Starter
109           <http://search.cpan.org/dist/Module-Starter>
110

BUGS

112       Please report any bugs or feature requests to "bug-module-starter at
113       rt.cpan.org", or through the web interface at <http://rt.cpan.org>.  I
114       will be notified, and then you'll automatically be notified of progress
115       on your bug as I make changes.
116

118       Copyright 2005-2009 Andy Lester, Ricardo Signes and C.J. Adams-Collier,
119       All Rights Reserved.
120
121       This program is free software; you can redistribute it and/or modify it
122       under the same terms as Perl itself.
123
124
125
126perl v5.12.0                      2009-12-08                Module::Starter(3)
Impressum