Bigtop::Docs::AutoBackends - lists all backends and their config statements
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 SQL 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.
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.
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
bigtop docs/app.bigtop all
A typical backend block looks like this:
CGI Gantry { with_server 1; }
Here there is a backend type CGI, a specific backend Bigtop::Backend::CGI::Gantry and a block with one statement: with_server.
CGI
Bigtop::Backend::CGI::Gantry
with_server
That block goes in the config block at the top of the file:
config { # config statements like 'engine' statements CGI Gantry { with_server 1; } # ... other backends }
Now that you know what backend blocks look like, and where to put them, it's time for the "Litany of Backends".
Below is a subsection for each backend type. Within the subsection is a list of backends in that type family.
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.
This CGI Gantry makes the following:
CGI or FastCGI dispatching script
Stand alone Gantry::Server [optional]
This backend understands these config block keywords:
This statement takes a boolean value use 0 or 1.
Skip everything for this backend
Make the script for use with FastCGI
check here if you use the Conf Gantry backend
Turns on stand alone Gantry::Server generation
Specifies the port for stand alone server [ignored unless Build Server is checked]
used to make a default root on request, now you get defaults by defaul
Adds command line args to stand alone server to allow easy DBD switching
A custom TT template.
This Conf Gantry makes the following:
Your config info for immediate use with Gantry::Conf
Your Gantry::Conf instance
Your master conf file [use a full path]
This Conf General makes the following:
Your config info in Config::General format
This Control Gantry makes the following:
Base module stub [safe to change]
Controller stubs [safe to change]
Generated code [please, do not edit]
Makes tests which hit pages via a simple server
use Gantry qw( -Engine=... ); [defaults to false]
Makes controllers usable with DBIx::Class
This Diagram GraphvizSql makes the following:
Graphviz dot file for SQL data model
Do NOT run a Graphviz layout program like dot.
Some Graphviz layout program like neato. [Default is dot]
Command line flags for Graphviz layout program. [Default is -Tpdf]
This HttpdConf Gantry makes the following:
Include file for mod_perl apache conf
do not generate PerlSetVar statements [checking gantry_conf makes this true]
use Gantry qw( -Engine=... ); [defaults to true]
This Init Std makes the following:
Module::Build script
Almost empty Changes file
Boilerplate README
lib dir used by Control and Model backends
testing dir used by Control backend
Copy of your bigtop file [create mode only]
Skip MANIFEST generation
This Model GantryCDBI makes the following:
Class::DBI style model stubs [safe to change]
Class::DBI style model specifications [please, do not change]
Notes:
This backend is incompatible with other Model backends.
Defaults to Gantry::Utils::CDBI
This Model GantryDBIxClass makes the following:
DBIx::Class style model stubs [safe to change]
DBIx::Class style model specifications [please, do not change]
This backend requires "For use with DBIx::Class" to be checked for the Control Gantry backend.
Defaults to Gantry::Utils::DBIxClass
Things other than PK::Auto and Core to load. Separate multiples with spaces.
This SQL DB2 makes the following:
SQL for DB2 database creation
This SQL MySQL makes the following:
MySQL database schema
This SQL Postgres makes the following:
Postgres database schema
This SQL SQLite makes the following:
SQLite database schema
This SiteLook GantryDefault makes the following:
A sample template toolkit wrapper [please change it]
Path to sample_wrapper.tt in the Gantry distribution [defaults to ./html]
The skip/backends script generated this file Sat Jul 10 17:04:09 2010. The script was written by Phil Crow <crow.phil@gmail.com>.
Copyright (C) 2007 by Phil Crow
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.
But keep in mind that it was generated. Make modifications to the generting script.
To install Bigtop, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Bigtop
CPAN shell
perl -MCPAN -e shell install Bigtop
For more information on module installation, please visit the detailed CPAN module installation guide.