1TITANIUM-STARTER(1)   User Contributed Perl Documentation  TITANIUM-STARTER(1)
2
3
4

NAME

6       titanium-starter - creates a skeleton Titanium project
7

SYNOPSIS

9        titanium-starter --module=MyApp --author="Andy Lester" --email=andy@petdance.com
10
11       Result:
12
13           MyApp
14           MyApp/lib
15           MyApp/lib/MyApp.pm
16           MyApp/lib/MyApp/templates/runmode1.html
17           MyApp/t
18           MyApp/t/00-signature.t
19           MyApp/t/01-load.t
20           MyApp/t/boilerplate.t
21           MyApp/t/perlcriticrc
22           MyApp/t/perl-critic.t
23           MyApp/t/pod-coverage.t
24           MyApp/t/pod.t
25           MyApp/t/test-app.t
26           MyApp/t/www
27           MyApp/t/PUT.STATIC.CONTENT.HERE
28           MyApp/Makefile.PL
29           MyApp/Changes
30           MyApp/README
31           MyApp/MANIFEST.SKIP
32           MyApp/MANIFEST
33           MyApp/server.pl
34
35       Options:
36
37           --module=module  Module name
38           --dir=dirname    Directory name to create new module in (optional)
39
40           --builder=module Build with 'ExtUtils::MakeMaker' or 'Module::Build'
41           --eumm           Same as --builder=ExtUtils::MakeMaker
42           --mb             Same as --builder=Module::Build
43           --mi             Same as --builder=Module::Install
44
45           --author=name    Author's name (required)
46           --email=email    Author's email (required)
47           --license=type   License under which the module will be distributed
48                            (default is the same license as perl)
49
50           --verbose        Print progress messages while working
51           --force          Delete pre-existing files if needed
52
53           --help           Show this message
54

DESCRIPTION

56       Set up the skeleton of a Titanium-based project, including a module,
57       some templates and some automated tests.
58
59       By default the skeleton files will come within the
60       "templates/titanium/" directory where Module::Starter::Plugin::CGIApp
61       is stored.
62
63       Multiple --builder options may be supplied to produce the files for
64       multiple builders.
65

CONFIGURATION

67       You may set new defaults in a config file:
68
69        author: Mark Stosberg
70        email: mark@summersault.com
71        template_dir: ~/.module-starter/titanium/templates
72
73       titanium-starter will look for a configuration file before reading its
74       command line parameters.  The default location is
75       "$HOME/.module-starter/config" but if the MODULE_STARTER_DIR
76       environment variable is set, titanium-starter will look for "config" in
77       that directory.
78
79       The configuration file is just a list of names and values, separated by
80       colons.  Values that take lists are just space separated.  A sample
81       configuration file might read:
82
83        author: Ricardo SIGNES
84        email:  rjbs@cpan.org
85        plugins: Module::Starter::Simple Module::Starter::Plugin::XYZ
86        xyz_option: red green blue
87
88       This format may become more elaborate in the future, but a file of this
89       type should remain valid.
90
91
92
93perl v5.12.1                      2010-07-26               TITANIUM-STARTER(1)