1Module::Starter::SimpleU(s3e)r Contributed Perl DocumentaMtoidounle::Starter::Simple(3)
2
3
4

NAME

6       Module::Starter::Simple - a simple, comprehensive Module::Starter plug‐
7       in
8

VERSION

10       Version 1.42
11

SYNOPSIS

13        use Module::Starter qw(Module::Starter::Simple);
14
15        Module::Starter->create_distro(%args);
16

DESCRIPTION

18       Module::Starter::Simple is a plugin for Module::Starter that will per‐
19       form all the work needed to create a distribution.  Given the parame‐
20       ters detailed in Module::Starter, it will create content, create direc‐
21       tories, and populate the directories with the required files.
22

CLASS METHODS

24       "create_distro(%args)"
25
26       This method works as advertised in Module::Starter.
27
28       "new(%args)"
29
30       This method is called to construct and initialize a new Module::Starter
31       object.  It is never called by the end user, only internally by "cre‐
32       ate_distro", which creates ephemeral Module::Starter objects.  It's
33       documented only to call it to the attention of subclass authors.
34

OBJECT METHODS

36       All the methods documented below are object methods, meant to be called
37       internally by the ephemperal objects created during the execution of
38       the class method "create_distro" above.
39
40       create_basedir
41
42       Creates the base directory for the distribution.  If the directory
43       already exists, and $force is true, then the existing directory will
44       get erased.
45
46       If the directory can't be created, or re-created, it dies.
47
48       create_modules( @modules )
49
50       This method will create a starter module file for each module named in
51       @modules.
52
53       module_guts( $module, $rtname )
54
55       This method returns the text which should serve as the contents for the
56       named module.  $rtname is the email suffix which rt.cpan.org will use
57       for bug reports.  (This should, and will, be moved out of the parame‐
58       ters for this method eventually.)
59
60       create_Makefile_PL( $main_module )
61
62       This will create the Makefile.PL for the distribution, and will use the
63       module named in $main_module as the main module of the distribution.
64
65       Makefile_PL_guts( $main_module, $main_pm_file )
66
67       This method is called by create_Makefile_PL and returns text used to
68       populate Makefile.PL; $main_pm_file is the filename of the distribu‐
69       tion's main module, $main_module.
70
71       create_Build_PL( $main_module )
72
73       This will create the Build.PL for the distribution, and will use the
74       module named in $main_module as the main module of the distribution.
75
76       Build_PL_guts( $main_module, $main_pm_file )
77
78       This method is called by create_Build_PL and returns text used to popu‐
79       late Build.PL; $main_pm_file is the filename of the distribution's main
80       module, $main_module.
81
82       create_Changes( )
83
84       This method creates a skeletal Changes file.
85
86       Changes_guts
87
88       Called by create_Changes, this method returns content for the Changes
89       file.
90
91       create_README( $build_instructions )
92
93       This method creates the distribution's README file.
94
95       README_guts
96
97       Called by create_README, this method returns content for the README
98       file.
99
100       create_t( @modules )
101
102       This method creates a bunch of *.t files.  @modules is a list of all
103       modules in the distribution.
104
105       t_guts( @modules )
106
107       This method is called by create_t, and returns a description of the *.t
108       files to be created.
109
110       The return value is a hash of test files to create.  Each key is a
111       filename and each value is the contents of that file.
112
113       create_MANIFEST( @files )
114
115       This method creates the distribution's MANIFEST file.  It must be run
116       last, because all the other create_* functions have been returning the
117       functions they create.
118
119       MANIFEST_guts( @files )
120
121       This method is called by "create_MANIFEST", and returns content for the
122       MANIFEST file.
123
124       create_cvsignore( )
125
126       This creates a .cvsignore file in the distribution's directory so that
127       your CVS knows to ignore certain files.
128
129       cvsignore_guts
130
131       Called by "create_cvsignore", this method returns the contents of the
132       cvsignore file.
133

HELPER METHODS

135       verbose
136
137       "verbose" tells us whether we're in verbose mode.
138
139       progress( @list )
140
141       "progress" prints the given progress message if we're in verbose mode.
142

BUGS

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

AUTHOR

150       Andy Lester, "<andy@petdance.com>"
151

153       Copyright 2005 Andy Lester, All Rights Reserved.
154
155       This program is free software; you can redistribute it and/or modify it
156       under the same terms as Perl itself.
157
158       Please note that these modules are not products of or supported by the
159       employers of the various contributors to the code.
160
161
162
163perl v5.8.8                       2005-11-09        Module::Starter::Simple(3)
Impressum