16 'scripts' => \$scripts,
20 pod2usage(1) if ( $help || !$ARGV[0] );
23 Catalyst::Helper->new(
24 { '.newfiles' => !$nonew, 'scripts' => $scripts, 'short' => $short } );
25 pod2usage(1) unless $helper->mk_app( $ARGV[0] );
32 catalyst - Bootstrap a Catalyst application
36 catalyst.pl [options] application-name
39 -help display this help and exits
40 -nonew don't create a .new file where a file to be created exists
41 -scripts update helper scripts only
42 -short use short types, like C instead of Controller...
44 application-name must be a valid Perl module name and can include "::"
50 To upgrade your app to a new version of Catalyst:
51 catalyst.pl -nonew -scripts MyApp
56 The C<catalyst.pl> script bootstraps a Catalyst application, creating a
57 directory structure populated with skeleton files.
59 The application name must be a valid Perl module name. The name of the
60 directory created is formed from the application name supplied, with double
61 colons replaced with hyphens (so, for example, the directory for C<My::App> is
64 Using the example application name C<My::App>, the application directory will
65 contain the following items:
71 a skeleton README file, which you are encouraged to expand on
75 a C<Module::Build> build script
79 a changes file with an initial entry for the creation of the application
83 an old-style MakeMaker script. Catalyst uses the C<Module::Build> system so
84 this script actually generates a Makeifle that invokes the Build script.
88 contains the application module (C<My/App.pm>) and
89 subdirectories for model, view, and controller components (C<My/App/M>,
90 C<My/App/V>, and C<My/App/C>).
94 root directory for your web document content. This is left empty.
98 a directory containing helper scripts:
102 =item C<my_app_create.pl>
104 helper script to generate new component modules
106 =item C<my_app_server.pl>
108 runs the generated application within a Catalyst test server, which can be
109 used for testing without resorting to a full-blown web server configuration.
111 =item C<my_app_cgi.pl>
113 runs the generated application as a CGI script
115 =item C<my_app_fastcgi.pl>
117 runs the generated application as a FastCGI script
120 =item C<my_app_test.pl>
122 runs an action of the generated application from the comand line.
133 The application module generated by the C<catalyst.pl> script is functional,
134 although it reacts to all requests by outputting a friendly welcome screen.
139 Neither C<catalyst.pl> nor the generated helper script will overwrite existing
140 files. In fact the scripts will generate new versions of any existing files,
141 adding the extension C<.new> to the filename. The C<.new> file is not created
142 if would be identical to the existing file.
144 This means you can re-run the scripts for example to see if newer versions of
145 Catalyst or its plugins generate different code, or to see how you may have
146 changed the generated code (although you do of course have all your code in a
147 version control system anyway, don't you ...).
153 L<Catalyst::Manual>, L<Catalyst::Manual::Intro>
157 Sebastian Riedel, C<sri@oook.de>,
158 Andrew Ford, C<A.Ford@ford-mason.co.uk>
163 Copyright 2004-2005 Sebastian Riedel. All rights reserved.
165 This library is free software, you can redistribute it and/or modify it under
166 the same terms as Perl itself.