prepared for release

[catagits/Catalyst-Runtime.git] / script / catalyst.pl

diff --git a/script/catalyst.pl b/script/catalyst.pl
index 567e7cd..85d30c9 100755 (executable)
--- a/script/catalyst.pl
+++ b/script/catalyst.pl
@@ -5,17 +5,28 @@ use Getopt::Long;
 use Pod::Usage;
 use Catalyst::Helper;
 
-my $help  = 0;
-my $nonew = 0;
+my $force    = 0;
+my $help     = 0;
+my $makefile = 0;
+my $scripts  = 0;
+my $short    = 0;
 
 GetOptions(
-    'help|?' => \$help,
-    'nonew'  => \$nonew
+    'help|?'      => \$help,
+    'force|nonew' => \$force,
+    'makefile'    => \$makefile,
+    'scripts'     => \$scripts,
+    'short'       => \$short
 );
 
 pod2usage(1) if ( $help || !$ARGV[0] );
 
-my $helper = Catalyst::Helper->new( { '.newfiles' => !$nonew } );
+my $helper = Catalyst::Helper->new( {
+    '.newfiles' => !$force, 
+    'makefile'  => $makefile, 
+    'scripts'   => $scripts,
+    'short'     => $short,
+} );
 pod2usage(1) unless $helper->mk_app( $ARGV[0] );
 
 1;
@@ -29,16 +40,27 @@ catalyst - Bootstrap a Catalyst application
 
 catalyst.pl [options] application-name
 
+'catalyst.pl' creates a skeleton for a new application, and allows you to
+upgrade the skeleton of your old application.
+
  Options:
-   -help        display this help and exits
-   -nonew       don't create a .new file where a file to be created exists
+   -force      don't create a .new file where a file to be created exists
+   -help       display this help and exit
+   -makefile   only update Makefile.PL
+   -scripts    only update helper scripts
+   -short      use short names, M/V/C instead of Model/View/Controller.
+
+ application-name must be a valid Perl module name and can include "::", 
+ which will be converted to '-' in the project name.
 
- application-name must be a valid Perl module name and can include "::"
 
  Examples:
     catalyst.pl My::App
     catalyst.pl MyApp
 
+ To upgrade your app to a new version of Catalyst:
+    catalyst.pl -force -scripts MyApp
+
 
 =head1 DESCRIPTION
 
@@ -59,18 +81,14 @@ contain the following items:
 
 a skeleton README file, which you are encouraged to expand on
 
-=item Build.PL
-
-a C<Module::Build> build script
-
 =item Changes
 
 a changes file with an initial entry for the creation of the application
 
 =item Makefile.PL
 
-an old-style MakeMaker script.  Catalyst uses the C<Module::Build> system so
-this script actually generates a Makeifle that invokes the Build script.
+Makefile.PL uses the C<Module::Install> system for packaging and distribution
+of the application.
 
 =item lib
 
@@ -88,25 +106,24 @@ a directory containing helper scripts:
 
 =over 4
 
-=item C<my_app_create.pl>
+=item C<myapp_create.pl>
 
 helper script to generate new component modules
 
-=item C<my_app_server.pl>
+=item C<myapp_server.pl>
 
 runs the generated application within a Catalyst test server, which can be
 used for testing without resorting to a full-blown web server configuration.
 
-=item C<my_app_cgi.pl>
+=item C<myapp_cgi.pl>
 
 runs the generated application as a CGI script
 
-=item C<my_app_fastcgi.pl>
+=item C<myapp_fastcgi.pl>
 
 runs the generated application as a FastCGI script
 
-
-=item C<my_app_test.pl>
+=item C<myapp_test.pl>
 
 runs an action of the generated application from the comand line.