.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "TITANIUM-STARTER 1p" .TH TITANIUM-STARTER 1p "2012-05-26" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" titanium\-starter \- creates a skeleton Titanium project .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& titanium\-starter \-\-module=MyApp \-\-author="Jaldhar H. Vyas" \-\-email=jaldhar@braincells.com .Ve .PP Result: .PP .Vb 10 \& MyApp \& MyApp/Changes \& MyApp/lib \& MyApp/lib/MyApp.pm \& MyApp/LICENSE \& MyApp/Makefile.PL \& MyApp/MANIFEST.SKIP \& MyApp/MANIFEST \& MyApp/README \& MyApp/server.pl \& MyApp/share/templates \& MyApp/share/templates/runmode1.html \& MyApp/t \& MyApp/t/00\-signature.t \& MyApp/t/01\-load.t \& MyApp/t/boilerplate.t \& MyApp/t/test\-app.t \& MyApp/t/www \& MyApp/t/www/PUT.STATIC.CONTENT.HERE \& MyApp/xt \& MyApp/xt/perlcriticrc \& MyApp/xt/perl\-critic.t \& MyApp/xt/pod\-coverage.t \& MyApp/xt/pod.t .Ve .PP Options: .PP .Vb 2 \& \-\-module=module Module name \& \-\-dir=dirname Directory name to create new module in (optional) \& \& \-\-builder=module Build with \*(AqExtUtils::MakeMaker\*(Aq or \*(AqModule::Build\*(Aq \& \-\-eumm Same as \-\-builder=ExtUtils::MakeMaker \& \-\-mb Same as \-\-builder=Module::Build \& \-\-mi Same as \-\-builder=Module::Install \& \& \-\-author=name Author\*(Aqs name (required) \& \-\-email=email Author\*(Aqs email (required) \& \-\-license=type License under which the module will be distributed \& (default is the same license as perl) \& \& \-\-verbose Print progress messages while working \& \-\-force Delete pre\-existing files if needed \& \& \-\-help Show this message .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Set up the skeleton of a Titanium\-based project, including a module, some templates and some automated tests. .PP By default the skeleton files will come within a shared directory where Module::Starter::Plugin::CGIApp is stored. See File::ShareDir for more information on how this works. .SH "CONFIGURATION" .IX Header "CONFIGURATION" titanium-starter will look for a configuration file before reading its command line parameters. The default location is \f(CW\*(C`$HOME/.module\-starter/config\*(C'\fR but if the \s-1MODULE_STARTER_DIR\s0 environment variable is set, titanium-starter will look for \f(CW\*(C`config\*(C'\fR in that directory. .PP The configuration file is just a list of names and values, separated by colons. Values that take lists are just space separated. A sample configuration file might read: .PP .Vb 4 \& author: Jaldhar H. Vyas \& email: jaldhar@braincells.com \& template_dir: ~/.module\-starter/cgiapp/templates \& colors: red green blue .Ve .PP This format may become more elaborate in the future, but a file of this type should remain valid.