.\" 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::TOC 3"
.TH Bigtop::Docs::TOC 3 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Bigtop::Docs::TOC \- Table of Contents for Bigtop::Docs::* documentation modules
.SH "What Should I Read?"
.IX Header "What Should I Read?"
This document is a brief annotated list of each Bigtop::Docs::* module.
.PP
Here are the highlights:
.PP
.Vb 5
\&    Very lazy people should start with Bigtop::Docs::QuickStart
\&    Merely lazy people should start with Bigtop::Docs::TentTut
\&    Those allergic to web apps should start with Bigtop::Docs::Tutorial
\&    Pedants should look in Bigtop::Docs::Syntax instead
\&    Bigtop developers should carefully read Bigtop::Docs::Modules
.Ve
.ie n .IP """Bigtop::Docs::About""" 4
.el .IP "\f(CWBigtop::Docs::About\fR" 4
.IX Item "Bigtop::Docs::About"
Describes the features and motivations of Bigtop.
.ie n .IP """Bigtop::Docs::AutoBackends""" 4
.el .IP "\f(CWBigtop::Docs::AutoBackends\fR" 4
.IX Item "Bigtop::Docs::AutoBackends"
Documentation on each available backend and how to configure it.  This
one is auto\-generated, and is therefore more likely to be up to date.
.ie n .IP """Bigtop::Docs::Cookbook""" 4
.el .IP "\f(CWBigtop::Docs::Cookbook\fR" 4
.IX Item "Bigtop::Docs::Cookbook"
Modeled after the Perl Cookbook, this provides a list of things you might
want to do, the syntax needed to make Bigtop do them for you, and the
output produced by them.  It focuses on hand written bigtop files, rather
than on tentmaker.
.ie n .IP """Bigtop::Docs::FullKeywords""" 4
.el .IP "\f(CWBigtop::Docs::FullKeywords\fR" 4
.IX Item "Bigtop::Docs::FullKeywords"
Documents all the valid keywords Bigtop understands by the block in
which they appear.  This one is auto-generated and shows exactly the
same information as tentmaker.
.ie n .IP """Bigtop::Docs::Modules""" 4
.el .IP "\f(CWBigtop::Docs::Modules\fR" 4
.IX Item "Bigtop::Docs::Modules"
Documents many of the modules in the bigtop distribution including at least:
Bigtop.pm and Bigtop::Parser.  This includes a description of the grammar
of the Bigtop language and how to work with it.  (Note that the grammar
is now in its own file called bigtop.grammar, but this has no effect on
the docs in Bigtop::Docs::Modules.  It may be out of date, but the extraction
of the grammar is not the reason.)
.ie n .IP """Bigtop::Docs::QuickKeywords""" 4
.el .IP "\f(CWBigtop::Docs::QuickKeywords\fR" 4
.IX Item "Bigtop::Docs::QuickKeywords"
Abbreviated version of Bigtop::Docs::FullKeywords.  Reduces most
descriptions to one line.
.ie n .IP """Bigtop::Docs::QuickStart""" 4
.el .IP "\f(CWBigtop::Docs::QuickStart\fR" 4
.IX Item "Bigtop::Docs::QuickStart"
Guide for the truly impatient.  Explains how to build a complete auto-CRUD
app from the command line alone using either kickstart syntax or connection
information for a PostgreSQL 8 database.
.ie n .IP """Bigtop::Docs::Syntax""" 4
.el .IP "\f(CWBigtop::Docs::Syntax\fR" 4
.IX Item "Bigtop::Docs::Syntax"
This is meant to fully describe all of the syntax (including deprecations)
in the Bigtop language.  It is the encyclopedic version of
Bigtop::Docs::Keywords and is meant as complete documentation of
Bigtop::Keywords.
.Sp
Much of the information here is also in \f(CW\*(C`Bigtop::Docs::AutoBackends\*(C'\fR
and \f(CW\*(C`Bigtop::Docs::AutoKeywords\*(C'\fR.  But, there is more discussion in this
one.  The others are more up-to-date on actual keyword availability, etc.
.ie n .IP """Bigtop::Docs::TentRef""" 4
.el .IP "\f(CWBigtop::Docs::TentRef\fR" 4
.IX Item "Bigtop::Docs::TentRef"
A comprehensive tour of tentmaker which assumes you understand the material
from \f(CW\*(C`Bigtop::Docs::TentTut\*(C'\fR.
.ie n .IP """Bigtop::Docs::TentTut""" 4
.el .IP "\f(CWBigtop::Docs::TentTut\fR" 4
.IX Item "Bigtop::Docs::TentTut"
The tentmaker tutorial.  Explains in detail how to use tentmaker to edit
Bigtop files.  Filled with beautiful screen shots (sometimes, they are even
up to date and available to your browser).
.ie n .IP """Bigtop::Docs::Tutorial""" 4
.el .IP "\f(CWBigtop::Docs::Tutorial\fR" 4
.IX Item "Bigtop::Docs::Tutorial"
If you don't like tentmaker, this is where you should start.  It walks
through building a moderately complex application from scratch using
a text editor to enter the proper Bigtop syntax.
.ie n .IP """Bigtop::Docs::Vim""" 4
.el .IP "\f(CWBigtop::Docs::Vim\fR" 4
.IX Item "Bigtop::Docs::Vim"
Explains how to install vim syntax highlighting for Bigtop source files.
.SH "AUTHOR"
.IX Header "AUTHOR"
Phil Crow