18 pod2usage(1) if ( $help || !$ARGV[0] );
21 Catalyst::Helper->new( { '.newfiles' => !$nonew, 'short' => $short } );
22 pod2usage(1) unless $helper->mk_app( $ARGV[0] );
29 catalyst - Bootstrap a Catalyst application
33 catalyst.pl [options] application-name
36 -help display this help and exits
37 -nonew don't create a .new file where a file to be created exists
38 -short use short types, like C instead of Controller...
40 application-name must be a valid Perl module name and can include "::"
49 The C<catalyst.pl> script bootstraps a Catalyst application, creating a
50 directory structure populated with skeleton files.
52 The application name must be a valid Perl module name. The name of the
53 directory created is formed from the application name supplied, with double
54 colons replaced with hyphens (so, for example, the directory for C<My::App> is
57 Using the example application name C<My::App>, the application directory will
58 contain the following items:
64 a skeleton README file, which you are encouraged to expand on
68 a C<Module::Build> build script
72 a changes file with an initial entry for the creation of the application
76 an old-style MakeMaker script. Catalyst uses the C<Module::Build> system so
77 this script actually generates a Makeifle that invokes the Build script.
81 contains the application module (C<My/App.pm>) and
82 subdirectories for model, view, and controller components (C<My/App/M>,
83 C<My/App/V>, and C<My/App/C>).
87 root directory for your web document content. This is left empty.
91 a directory containing helper scripts:
95 =item C<my_app_create.pl>
97 helper script to generate new component modules
99 =item C<my_app_server.pl>
101 runs the generated application within a Catalyst test server, which can be
102 used for testing without resorting to a full-blown web server configuration.
104 =item C<my_app_cgi.pl>
106 runs the generated application as a CGI script
108 =item C<my_app_fastcgi.pl>
110 runs the generated application as a FastCGI script
113 =item C<my_app_test.pl>
115 runs an action of the generated application from the comand line.
126 The application module generated by the C<catalyst.pl> script is functional,
127 although it reacts to all requests by outputting a friendly welcome screen.
132 Neither C<catalyst.pl> nor the generated helper script will overwrite existing
133 files. In fact the scripts will generate new versions of any existing files,
134 adding the extension C<.new> to the filename. The C<.new> file is not created
135 if would be identical to the existing file.
137 This means you can re-run the scripts for example to see if newer versions of
138 Catalyst or its plugins generate different code, or to see how you may have
139 changed the generated code (although you do of course have all your code in a
140 version control system anyway, don't you ...).
146 L<Catalyst::Manual>, L<Catalyst::Manual::Intro>
150 Sebastian Riedel, C<sri@oook.de>,
151 Andrew Ford, C<A.Ford@ford-mason.co.uk>
156 Copyright 2004-2005 Sebastian Riedel. All rights reserved.
158 This library is free software, you can redistribute it and/or modify it under
159 the same terms as Perl itself.