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

DESCRIPTION

59       Set up the skeleton of a Titanium-based project, including a module,
60       some templates and some automated tests.
61
62       By default the skeleton files will come within a shared directory where
63       Module::Starter::Plugin::CGIApp is stored.  See File::ShareDir for more
64       information on how this works.
65

CONFIGURATION

67       titanium-starter will look for a configuration file before reading its
68       command line parameters.  The default location is
69       "$HOME/.module-starter/config" but if the MODULE_STARTER_DIR
70       environment variable is set, titanium-starter will look for "config" in
71       that directory.
72
73       The configuration file is just a list of names and values, separated by
74       colons.  Values that take lists are just space separated.  A sample
75       configuration file might read:
76
77        author: Jaldhar H. Vyas
78        email: jaldhar@braincells.com
79        template_dir: ~/.module-starter/cgiapp/templates
80        colors: red green blue
81
82       This format may become more elaborate in the future, but a file of this
83       type should remain valid.
84
85
86
87perl v5.38.0                      2023-07-20               TITANIUM-STARTER(1)