.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "Bigtop::Docs::AutoBackends 3"
.TH Bigtop::Docs::AutoBackends 3 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Bigtop::Docs::AutoBackends \- lists all backends and their config statements
.SH "Intro"
.IX Header "Intro"
Bigtop is a facade for a set of backends which do the actual generation.
Each generating backend lives in the Bigtop::Backend:: namespace.  Further,
each backend has a type or family.  For example, there are three generators
in the \s-1SQL\s0 family.  All of them live in the Bigtop::Backend::SQL:: namespace.
Finally, each backend is in a module, whose name completes the package name.
For example the PostgreSQL backend is Bigtop::Backend::SQL::Postgres.
.PP
Below are listes all the current Bigtop backends (at least the ones
that ship with Bigtop, your local system could have others).  In addition
to briefly describing what the backend is responsible for building, there
is also a description of all the keywords you can put in the backend's
config block to control its behavior.
.PP
All backends are listed in the Bigtop config block, which begins each
bigtop file.  That list controls what the user is allowed to build.
The order of appearance controls the order of generation when the user
chooses to build all, as in
.PP
.Vb 1
\&    bigtop docs/app.bigtop all
.Ve
.PP
A typical backend block looks like this:
.PP
.Vb 1
\&    CGI Gantry { with_server 1; }
.Ve
.PP
Here there is a backend type \f(CW\*(C`CGI\*(C'\fR, a specific backend
\&\f(CW\*(C`Bigtop::Backend::CGI::Gantry\*(C'\fR and a block with one statement:
\&\f(CW\*(C`with_server\*(C'\fR.
.PP
That block goes in the config block at the top of the file:
.PP
.Vb 5
\&    config {
\&        # config statements like 'engine' statements
\&        CGI Gantry { with_server 1; }
\&        # ... other backends
\&    }
.Ve
.PP
Now that you know what backend blocks look like, and where to put them,
it's time for the \*(L"Litany of Backends\*(R".
.SH "Litany of Backends"
.IX Header "Litany of Backends"
Below is a subsection for each backend type.  Within the subsection is
a list of backends in that type family.
.PP
Note that the list below is in alphabetical order by type family,
but you almost always need to list an Init:: backend first.  They are
responsible for making the build directory among other things.
.Sh "\s-1CGI\s0"
.IX Subsection "CGI"
.IP "Gantry" 4
.IX Item "Gantry"
This \s-1CGI\s0 Gantry makes the following:
.RS 4
.IP "app.cgi" 4
.IX Item "app.cgi"
\&\s-1CGI\s0 or FastCGI dispatching script
.IP "app.server" 4
.IX Item "app.server"
Stand alone Gantry::Server [optional]
.RE
.RS 4
.Sp
This backend understands these config block keywords:
.IP "no_gen" 4
.IX Item "no_gen"
This statement takes a boolean value use 0 or 1.
.Sp
Skip everything for this backend
.IP "fast_cgi" 4
.IX Item "fast_cgi"
This statement takes a boolean value use 0 or 1.
.Sp
Make the script for use with FastCGI
.IP "gantry_conf" 4
.IX Item "gantry_conf"
This statement takes a boolean value use 0 or 1.
.Sp
check here if you use the Conf Gantry backend
.IP "with_server" 4
.IX Item "with_server"
This statement takes a boolean value use 0 or 1.
.Sp
Turns on stand alone Gantry::Server generation
.IP "server_port" 4
.IX Item "server_port"
Specifies the port for stand alone server [ignored unless Build Server is checked]
.IP "gen_root" 4
.IX Item "gen_root"
used to make a default root on request, now you get defaults by defaul
.IP "flex_db" 4
.IX Item "flex_db"
This statement takes a boolean value use 0 or 1.
.Sp
Adds command line args to stand alone server to allow easy \s-1DBD\s0 switching
.IP "template" 4
.IX Item "template"
A custom \s-1TT\s0 template.
.RE
.RS 4
.RE
.Sh "Conf"
.IX Subsection "Conf"
.IP "Gantry" 4
.IX Item "Gantry"
This Conf Gantry makes the following:
.RS 4
.IP "docs/AppName.gantry.conf" 4
.IX Item "docs/AppName.gantry.conf"
Your config info for immediate use with Gantry::Conf
.RE
.RS 4
.Sp
This backend understands these config block keywords:
.IP "no_gen" 4
.IX Item "no_gen"
This statement takes a boolean value use 0 or 1.
.Sp
Skip everything for this backend
.IP "instance" 4
.IX Item "instance"
Your Gantry::Conf instance
.IP "conffile" 4
.IX Item "conffile"
Your master conf file [use a full path]
.IP "gen_root" 4
.IX Item "gen_root"
used to make a default root on request, now you get defaults by defaul
.IP "template" 4
.IX Item "template"
A custom \s-1TT\s0 template.
.RE
.RS 4
.RE
.IP "General" 4
.IX Item "General"
This Conf General makes the following:
.RS 4
.IP "docs/AppName.conf" 4
.IX Item "docs/AppName.conf"
Your config info in Config::General format
.RE
.RS 4
.Sp
This backend understands these config block keywords:
.IP "no_gen" 4
.IX Item "no_gen"
This statement takes a boolean value use 0 or 1.
.Sp
Skip everything for this backend
.IP "gen_root" 4
.IX Item "gen_root"
used to make a default root on request, now you get defaults by defaul
.IP "template" 4
.IX Item "template"
A custom \s-1TT\s0 template.
.RE
.RS 4
.RE
.Sh "Control"
.IX Subsection "Control"
.IP "Gantry" 4
.IX Item "Gantry"
This Control Gantry makes the following:
.RS 4
.IP "lib/AppName.pm" 4
.IX Item "lib/AppName.pm"
Base module stub [safe to change]
.IP "lib/AppName/*.pm" 4
.IX Item "lib/AppName/*.pm"
Controller stubs [safe to change]
.IP "lib/AppName/GEN/*.pm" 4
.IX Item "lib/AppName/GEN/*.pm"
Generated code [please, do not edit]
.RE
.RS 4
.Sp
This backend understands these config block keywords:
.IP "no_gen" 4
.IX Item "no_gen"
This statement takes a boolean value use 0 or 1.
.Sp
Skip everything for this backend
.IP "run_test" 4
.IX Item "run_test"
This statement takes a boolean value use 0 or 1.
.Sp
Makes tests which hit pages via a simple server
.IP "full_use" 4
.IX Item "full_use"
This statement takes a boolean value use 0 or 1.
.Sp
use Gantry qw( \-Engine=... ); [defaults to false]
.IP "dbix" 4
.IX Item "dbix"
This statement takes a boolean value use 0 or 1.
.Sp
Makes controllers usable with DBIx::Class
.IP "template" 4
.IX Item "template"
A custom \s-1TT\s0 template.
.RE
.RS 4
.RE
.Sh "HttpdConf"
.IX Subsection "HttpdConf"
.IP "Gantry" 4
.IX Item "Gantry"
This HttpdConf Gantry makes the following:
.RS 4
.IP "docs/httpd.conf" 4
.IX Item "docs/httpd.conf"
Include file for mod_perl apache conf
.RE
.RS 4
.Sp
This backend understands these config block keywords:
.IP "no_gen" 4
.IX Item "no_gen"
This statement takes a boolean value use 0 or 1.
.Sp
Skip everything for this backend
.IP "gantry_conf" 4
.IX Item "gantry_conf"
This statement takes a boolean value use 0 or 1.
.Sp
check here if you use the Conf Gantry backend
.IP "skip_config" 4
.IX Item "skip_config"
This statement takes a boolean value use 0 or 1.
.Sp
do not generate PerlSetVar statements [checking gantry_conf makes this true]
.IP "full_use" 4
.IX Item "full_use"
This statement takes a boolean value use 0 or 1.
.Sp
use Gantry qw( \-Engine=... ); [defaults to true]
.IP "gen_root" 4
.IX Item "gen_root"
used to make a default root on request, now you get defaults by defaul
.IP "template" 4
.IX Item "template"
A custom \s-1TT\s0 template.
.RE
.RS 4
.RE
.Sh "Init"
.IX Subsection "Init"
.IP "Std" 4
.IX Item "Std"
This Init Std makes the following:
.RS 4
.IP "Build.PL" 4
.IX Item "Build.PL"
Module::Build script
.IP "Changes" 4
.IX Item "Changes"
Almost empty Changes file
.IP "\s-1README\s0" 4
.IX Item "README"
Boilerplate \s-1README\s0
.IP "lib/" 4
.IX Item "lib/"
lib dir used by Control and Model backends
.IP "t/" 4
.IX Item "t/"
testing dir used by Control backend
.IP "docs/name.bigtop" 4
.IX Item "docs/name.bigtop"
Copy of your bigtop file [create mode only]
.RE
.RS 4
.Sp
This backend understands these config block keywords:
.IP "no_gen" 4
.IX Item "no_gen"
This statement takes a boolean value use 0 or 1.
.Sp
Skip \s-1MANIFEST\s0 generation
.IP "template" 4
.IX Item "template"
A custom \s-1TT\s0 template.
.RE
.RS 4
.RE
.Sh "Model"
.IX Subsection "Model"
.IP "GantryCDBI" 4
.IX Item "GantryCDBI"
This Model GantryCDBI makes the following:
.RS 4
.IP "lib/AppName/Model/*.pm" 4
.IX Item "lib/AppName/Model/*.pm"
Class::DBI style model stubs [safe to change]
.IP "lib/AppName/Model/GEN/*.pm" 4
.IX Item "lib/AppName/Model/GEN/*.pm"
Class::DBI style model specifications [please, do not change]
.RE
.RS 4
.Sp
Notes:
.IP "*" 4
This backend is incompatible with other Model backends.
.RE
.RS 4
.Sp
This backend understands these config block keywords:
.IP "no_gen" 4
.IX Item "no_gen"
This statement takes a boolean value use 0 or 1.
.Sp
Skip everything for this backend
.IP "model_base_class" 4
.IX Item "model_base_class"
Defaults to Gantry::Utils::CDBI
.IP "template" 4
.IX Item "template"
A custom \s-1TT\s0 template.
.RE
.RS 4
.RE
.IP "GantryDBIxClass" 4
.IX Item "GantryDBIxClass"
This Model GantryDBIxClass makes the following:
.RS 4
.IP "lib/AppName/Model/*.pm" 4
.IX Item "lib/AppName/Model/*.pm"
DBIx::Class style model stubs [safe to change]
.IP "lib/AppName/Model/GEN/*.pm" 4
.IX Item "lib/AppName/Model/GEN/*.pm"
DBIx::Class style model specifications [please, do not change]
.RE
.RS 4
.Sp
Notes:
.IP "*" 4
This backend requires \*(L"For use with DBIx::Class\*(R" to be checked for the Control Gantry backend.
.IP "*" 4
This backend is incompatible with other Model backends.
.RE
.RS 4
.Sp
This backend understands these config block keywords:
.IP "no_gen" 4
.IX Item "no_gen"
This statement takes a boolean value use 0 or 1.
.Sp
Skip everything for this backend
.IP "model_base_class" 4
.IX Item "model_base_class"
Defaults to Gantry::Utils::DBIxClass
.IP "template" 4
.IX Item "template"
A custom \s-1TT\s0 template.
.RE
.RS 4
.RE
.Sh "\s-1SQL\s0"
.IX Subsection "SQL"
.IP "MySQL" 4
.IX Item "MySQL"
This \s-1SQL\s0 MySQL makes the following:
.RS 4
.IP "docs/schema.sqlite" 4
.IX Item "docs/schema.sqlite"
MySQL database schema
.RE
.RS 4
.Sp
This backend understands these config block keywords:
.IP "no_gen" 4
.IX Item "no_gen"
This statement takes a boolean value use 0 or 1.
.Sp
Skip everything for this backend
.IP "template" 4
.IX Item "template"
A custom \s-1TT\s0 template.
.RE
.RS 4
.RE
.IP "Postgres" 4
.IX Item "Postgres"
This \s-1SQL\s0 Postgres makes the following:
.RS 4
.IP "docs/schema.postgres" 4
.IX Item "docs/schema.postgres"
Postgres database schema
.RE
.RS 4
.Sp
This backend understands these config block keywords:
.IP "no_gen" 4
.IX Item "no_gen"
This statement takes a boolean value use 0 or 1.
.Sp
Skip everything for this backend
.IP "template" 4
.IX Item "template"
A custom \s-1TT\s0 template.
.RE
.RS 4
.RE
.IP "SQLite" 4
.IX Item "SQLite"
This \s-1SQL\s0 SQLite makes the following:
.RS 4
.IP "docs/schema.sqlite" 4
.IX Item "docs/schema.sqlite"
SQLite database schema
.RE
.RS 4
.Sp
This backend understands these config block keywords:
.IP "no_gen" 4
.IX Item "no_gen"
This statement takes a boolean value use 0 or 1.
.Sp
Skip everything for this backend
.IP "template" 4
.IX Item "template"
A custom \s-1TT\s0 template.
.RE
.RS 4
.RE
.Sh "SiteLook"
.IX Subsection "SiteLook"
.IP "GantryDefault" 4
.IX Item "GantryDefault"
This SiteLook GantryDefault makes the following:
.RS 4
.IP "html/genwrapper.html" 4
.IX Item "html/genwrapper.html"
A sample template toolkit wrapper [please change it]
.RE
.RS 4
.Sp
This backend understands these config block keywords:
.IP "no_gen" 4
.IX Item "no_gen"
This statement takes a boolean value use 0 or 1.
.Sp
Skip everything for this backend
.IP "gantry_wrapper" 4
.IX Item "gantry_wrapper"
Path to sample_wrapper.tt in the Gantry distribution [defaults to ./html]
.RE
.RS 4
.RE
.SH "AUTHOR"
.IX Header "AUTHOR"
The skip/backends script generated this file Tue Aug 14 17:16:34 2007.
The script was written by Phil Crow <crow.phil@gmail.com>.
.SH "COPYRIGHT and LICENSE"
.IX Header "COPYRIGHT and LICENSE"
Copyright (C) 2007 by Phil Crow
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.6 or,
at your option, any later version of Perl 5 you may have available.
.PP
But keep in mind that it was generated.  Make modifications to the
generting script.