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.42
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, includ‐
24       ing basic builder scripts, tests, documentation, and module code.  This
25       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 out‐
30           side this module; all the other methods are called internally by
31           this one.
32
33           This method creates orchestrates all the work; it creates distribu‐
34           tion and populates it with the all the requires files.
35
36           It takes a hash of params, as follows:
37
38               distro  => $distroname,      # distribution name (defaults to first module)
39               modules => [ module names ], # modules to create in distro
40               dir     => $dirname,         # directory in which to build distro
41               builder => 'Module::Build',  # defaults to ExtUtils::MakeMaker
42                                            # or specify more than one builder in an
43                                            # arrayref
44
45               license => $license,  # type of license; defaults to 'perl'
46               author  => $author,   # author's full name (required)
47               email   => $email,    # author's email address (required)
48
49               verbose => $verbose,  # bool: print progress messages; defaults to 0
50               force   => $force     # bool: overwrite existing files; defaults to 0
51

PLUGINS

53       Module::Starter itself doesn't actually do anything.  It must load
54       plugins that implement "create_distro" and other methods.  This is done
55       by the class's "import" routine, which accepts a list of plugins to be
56       loaded, in order.
57
58       For more information, refer to Module::Starter::Plugin.
59

AUTHORS

61       Andy Lester, "<petdance at cpan.org>"
62
63       Ricardo Signes, "<rjbs at cpan.org>"
64

SUPPORT

66       You can find documentation for this module with the perldoc command.
67
68           perldoc Module::Starter
69
70           You can also look for information at:
71
72       * AnnoCPAN: Annotated CPAN documentation
73           <http://annocpan.org/dist/Module-Starter>
74
75       * CPAN Ratings
76           <http://cpanratings.perl.org/d/Module-Starter>
77
78       * RT: CPAN's request tracker
79           <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Module-Starter>
80
81       * Search CPAN
82           <http://search.cpan.org/dist/Module-Starter>
83

BUGS

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

91       Copyright 2005 Andy Lester and Ricardo Signes, All Rights Reserved.
92
93       This program is free software; you can redistribute it and/or modify it
94       under the same terms as Perl itself.
95
96
97
98perl v5.8.8                       2005-11-09                Module::Starter(3)
Impressum