7 eval " use Catalyst::Devel 1.0; ";
11 To use the Catalyst development tools including catalyst.pl and the
12 generated script/myapp_create.pl you need Catalyst::Helper, which is
13 part of the Catalyst-Devel distribution. Please install this via a
14 vendor package or by running one of -
16 perl -MCPAN -e 'install Catalyst::Devel'
17 perl -MCPANPLUS -e 'install Catalyst::Devel'
33 'force|nonew' => \$force,
34 'makefile' => \$makefile,
35 'scripts' => \$scripts,
39 pod2usage(1) if ( $help || !$ARGV[0] );
41 my $helper = Catalyst::Helper->new(
43 '.newfiles' => !$force,
44 'makefile' => $makefile,
45 'scripts' => $scripts,
49 pod2usage(1) unless $helper->mk_app( $ARGV[0] );
56 catalyst - Bootstrap a Catalyst application
60 catalyst.pl [options] application-name
62 'catalyst.pl' creates a skeleton for a new application, and allows you to
63 upgrade the skeleton of your old application.
66 -force don't create a .new file where a file to be created exists
67 -help display this help and exit
68 -makefile only update Makefile.PL
69 -scripts only update helper scripts
70 -short use short names, M/V/C instead of Model/View/Controller.
72 application-name must be a valid Perl module name and can include "::",
73 which will be converted to '-' in the project name.
80 To upgrade your app to a new version of Catalyst:
81 catalyst.pl -force -scripts MyApp
86 The C<catalyst.pl> script bootstraps a Catalyst application, creating a
87 directory structure populated with skeleton files.
89 The application name must be a valid Perl module name. The name of the
90 directory created is formed from the application name supplied, with double
91 colons replaced with hyphens (so, for example, the directory for C<My::App> is
94 Using the example application name C<My::App>, the application directory will
95 contain the following items:
101 a skeleton README file, which you are encouraged to expand on
105 a changes file with an initial entry for the creation of the application
109 Makefile.PL uses the C<Module::Install> system for packaging and distribution
114 contains the application module (C<My/App.pm>) and
115 subdirectories for model, view, and controller components (C<My/App/M>,
116 C<My/App/V>, and C<My/App/C>).
120 root directory for your web document content. This is left empty.
124 a directory containing helper scripts:
128 =item C<myapp_create.pl>
130 helper script to generate new component modules
132 =item C<myapp_server.pl>
134 runs the generated application within a Catalyst test server, which can be
135 used for testing without resorting to a full-blown web server configuration.
137 =item C<myapp_cgi.pl>
139 runs the generated application as a CGI script
141 =item C<myapp_fastcgi.pl>
143 runs the generated application as a FastCGI script
145 =item C<myapp_test.pl>
147 runs an action of the generated application from the comand line.
157 The application module generated by the C<catalyst.pl> script is functional,
158 although it reacts to all requests by outputting a friendly welcome screen.
162 Neither C<catalyst.pl> nor the generated helper script will overwrite existing
163 files. In fact the scripts will generate new versions of any existing files,
164 adding the extension C<.new> to the filename. The C<.new> file is not created
165 if would be identical to the existing file.
167 This means you can re-run the scripts for example to see if newer versions of
168 Catalyst or its plugins generate different code, or to see how you may have
169 changed the generated code (although you do of course have all your code in a
170 version control system anyway, don't you ...).
174 L<Catalyst::Manual>, L<Catalyst::Manual::Intro>
178 Catalyst Contributors, see Catalyst.pm
182 This library is free software, you can redistribute it and/or modify it under
183 the same terms as Perl itself.