1CATALYST(1)           User Contributed Perl Documentation          CATALYST(1)
2
3
4

NAME

6       catalyst - Bootstrap a Catalyst application
7

SYNOPSIS

9       catalyst.pl [options] application-name
10
11       'catalyst.pl' creates a skeleton for a new application, and allows you
12       to upgrade the skeleton of your old application.
13
14        Options:
15          -force      don't create a .new file where a file to be created exists
16          -help       display this help and exit
17          -makefile   only update Makefile.PL
18          -scripts    only update helper scripts
19
20        application-name must be a valid Perl module name and can include "::",
21        which will be converted to '-' in the project name.
22
23
24        Examples:
25           catalyst.pl My::App
26           catalyst.pl MyApp
27
28        To upgrade your app to a new version of Catalyst:
29           catalyst.pl -force -scripts MyApp
30

DESCRIPTION

32       The "catalyst.pl" script bootstraps a Catalyst application, creating a
33       directory structure populated with skeleton files.
34
35       The application name must be a valid Perl module name.  The name of the
36       directory created is formed from the application name supplied, with
37       double colons replaced with hyphens (so, for example, the directory for
38       "My::App" is "My-App").
39
40       Using the example application name "My::App", the application directory
41       will contain the following items:
42
43       README
44           a skeleton README file, which you are encouraged to expand on
45
46       Changes
47           a changes file with an initial entry for the creation of the
48           application
49
50       Makefile.PL
51           Makefile.PL uses the "Module::Install" system for packaging and
52           distribution of the application.
53
54       lib contains the application module ("My/App.pm") and subdirectories
55           for model, view, and controller components ("My/App/M", "My/App/V",
56           and "My/App/C").
57
58       root
59           root directory for your web document content.  This is left empty.
60
61       script
62           a directory containing helper scripts:
63
64           "myapp_create.pl"
65               helper script to generate new component modules
66
67           "myapp_server.pl"
68               runs the generated application within a Catalyst test server,
69               which can be used for testing without resorting to a full-blown
70               web server configuration.
71
72           "myapp_cgi.pl"
73               runs the generated application as a CGI script
74
75           "myapp_fastcgi.pl"
76               runs the generated application as a FastCGI script
77
78           "myapp_test.pl"
79               runs an action of the generated application from the command
80               line.
81
82       t   test directory
83
84       The application module generated by the "catalyst.pl" script is
85       functional, although it reacts to all requests by outputting a friendly
86       welcome screen.
87

NOTE

89       Neither "catalyst.pl" nor the generated helper script will overwrite
90       existing files.  In fact the scripts will generate new versions of any
91       existing files, adding the extension ".new" to the filename.  The
92       ".new" file is not created if would be identical to the existing file.
93
94       This means you can re-run the scripts for example to see if newer
95       versions of Catalyst or its plugins generate different code, or to see
96       how you may have changed the generated code (although you do of course
97       have all your code in a version control system anyway, don't you ...).
98

SEE ALSO

100       Catalyst::Manual, Catalyst::Manual::Intro
101

AUTHORS

103       Catalyst Contributors, see Catalyst.pm
104

106       This library is free software, you can redistribute it and/or modify it
107       under the same terms as Perl itself.
108
109
110
111perl v5.36.0                      2022-07-31                       CATALYST(1)
Impressum