summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorChris St. Pierre <chris.a.st.pierre@gmail.com>2012-11-07 13:34:35 -0500
committerChris St. Pierre <chris.a.st.pierre@gmail.com>2012-11-07 13:34:35 -0500
commita732f8499e1b21df4704d2d8b046c0c7dcc4f7a3 (patch)
tree638991e9865fcf2bfb7306384106dbbdb853d7c6 /man
parentbf74317fdb4940eded368d12ce4e4877f72e3a45 (diff)
downloadbcfg2-a732f8499e1b21df4704d2d8b046c0c7dcc4f7a3.tar.gz
bcfg2-a732f8499e1b21df4704d2d8b046c0c7dcc4f7a3.tar.bz2
bcfg2-a732f8499e1b21df4704d2d8b046c0c7dcc4f7a3.zip
doc: made format of man page option lists consistent
Diffstat (limited to 'man')
-rw-r--r--man/bcfg2-admin.8471
-rw-r--r--man/bcfg2-build-reports.884
-rw-r--r--man/bcfg2-crypt.8219
-rw-r--r--man/bcfg2-info.8262
-rw-r--r--man/bcfg2-lint.8224
-rw-r--r--man/bcfg2-lint.conf.5247
-rw-r--r--man/bcfg2-reports.8192
-rw-r--r--man/bcfg2-server.8106
-rw-r--r--man/bcfg2.1373
-rw-r--r--man/bcfg2.conf.51153
10 files changed, 1990 insertions, 1341 deletions
diff --git a/man/bcfg2-admin.8 b/man/bcfg2-admin.8
index e5bcc55f3..564c30d81 100644
--- a/man/bcfg2-admin.8
+++ b/man/bcfg2-admin.8
@@ -1,260 +1,255 @@
-.
-.TH "BCFG2\-ADMIN" "8" "September 2012" "" ""
-.
-.SH "NAME"
-\fBbcfg2\-admin\fR \- Perform repository administration tasks
-.
-.SH "SYNOPSIS"
-\fBbcfg2\-admin\fR [\-C \fIconfigfile\fR] \fImode\fR [\fImode args\fR] [\fImode options\fR]
-.
-.SH "DESCRIPTION"
-\fBbcfg2\-admin\fR is used to perform Bcfg2 repository administration
-.
-.SH "OPTIONS"
-.
-.TP
-\fB\-C\fR \fIconfigfile\fR
-Specify alternate bcfg2\.conf location\.
-.
-.TP
-\fB\-E\fR \fIencoding\fR
-Specify the encoding of Cfg files\.
-.
-.TP
-\fB\-Q\fR \fIrepository path\fR
-Specify the path to the server repository\.
-.
-.TP
-\fB\-S\fR \fIhttps://server:port\fR
-Manually specify the server location (as opposed to using the value in bcfg2\.conf)\.
-.
-.TP
-\fB\-d\fR
-Enable debugging output\.
-.
-.TP
-\fB\-h\fR
-Print Usage information\.
-.
-.TP
-\fB\-o\fR \fIlogfile path\fR
-Writes a log to the specified path\.
-.
-.TP
-\fB\-v\fR
-Enable verbose output\.
-.
-.TP
-\fB\-x\fR \fIpassword\fR
-Use ’password’ for client communication\.
-.
-.TP
-\fB\-\-ssl\-key=\fR\fIssl key\fR
-Specifiy the path to the SSL key\.
-.
-.SH "MODES"
-.
-.TP
-\fBbackup\fR
-Create an archive of the entire Bcfg2 repository\.
-.
-.TP
-\fBbundle\fR \fIaction\fR
-Display details about the available bundles (See \fI\fBBUNDLE OPTIONS\fR\fR below)\.
-.
-.TP
-\fBclient\fR \fIaction\fR \fIclient\fR [attribute=value]
-Add, edit, or remove clients entries in metadata (See \fI\fBCLIENT OPTIONS\fR\fR below)\.
-.
-.TP
-\fBcompare\fR \fIold\fR \fInew\fR
-Compare two client configurations\. Can be used to verify consistent behavior between releases\. Determine differences between files or directories (See \fI\fBCOMPARE OPTIONS\fR\fR below)\.
-.
-.TP
-\fBinit\fR
-Initialize a new repository (interactive)\.
-.
-.TP
-\fBminestruct\fR \fIclient\fR [\-f xml\-file] [\-g groups]
-Build structure entries based on client statistics extra entries (See \fI\fBMINESTRUCT OPTIONS\fR\fR below)\.
-.
-.TP
-\fBperf\fR
-Query server for performance data\.
-.
-.TP
-\fBpull\fR \fIclient\fR \fIentry\-type\fR \fIentry\-name\fR
-Install configuration information into repo based on client bad entries (See \fI\fBPULL OPTIONS\fR\fR below)\.
-.
-.TP
-\fBquery\fR [g=group] [p=profile] [\-f output\-file] [\-n] [\-c]
-Search for clients based on group or profile (See \fI\fBQUERY OPTIONS\fR\fR below)\.
-.
-.TP
-\fBreports\fR [init|load_stats|purge|scrub|update]
-Interact with the dynamic reporting system (See \fI\fBREPORTS OPTIONS\fR\fR below)\.
-.
-.TP
-\fBsnapshots\fR [init|dump|query|reports]
-Interact with the Snapshots database (See \fI\fBSNAPSHOTS OPTIONS\fR\fR below)\.
-.
-.TP
-\fBsyncdb\fR
-Sync the Django ORM with the configured database\.
-.
-.TP
-\fBtidy\fR
-Remove unused files from repository\.
-.
+.TH "BCFG2-ADMIN" "8" "November 07, 2012" "1.3" "Bcfg2"
+.SH NAME
+bcfg2-admin \- Perform repository administration tasks
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
+.SH SYNOPSIS
+.sp
+\fBbcfg2\-admin\fP [\-C \fIconfigfile\fP] \fImode\fP [\fImode args\fP] [\fImode options\fP]
+.SH DESCRIPTION
+.sp
+\fBbcfg2\-admin\fP is used to perform Bcfg2 repository
+administration.
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.BI \-C \ configfile
+Specify alternate bcfg2.conf location.
+.TP
+.BI \-E \ encoding
+Specify the encoding of config files.
+.TP
+.BI \-Q \ path
+Specify the path to the server repository.
+.TP
+.BI \-S \ server
+Manually specify the server location (as opposed to
+using the value in bcfg2.conf). This should be in
+the format "\fI\%https://server:port\fP"
+.TP
+.B \-d
+Enable debugging output.
+.TP
+.B \-h
+Print usage information.
+.TP
+.BI \-o \ logfile
+Writes a log to the specified path.
+.TP
+.BI \-\-ssl\-key\fB= key
+Specify the path to the SSL key.
+.TP
+.B \-v
+Enable verbose output.
+.TP
+.BI \-x \ password
+Use \(aqpassword\(aq for client communication.
+.UNINDENT
+.SH MODES
+.INDENT 0.0
+.TP
+.B backup
+Create an archive of the entire Bcfg2 repository.
+.TP
+.B bundle \fIaction\fP
+Display details about the available bundles (See BUNDLE OPTIONS
+below).
+.TP
+.B client \fIaction\fP \fIclient\fP [attribute=value]
+Add, edit, or remove clients entries in metadata (See CLIENT OPTIONS
+below).
+.TP
+.B compare \fIold\fP \fInew\fP
+Compare two client configurations. Can be used to verify consistent
+behavior between releases. Determine differences between files or
+directories (See COMPARE OPTIONS below).
+.TP
+.B init
+Initialize a new repository (interactive).
+.TP
+.B minestruct \fIclient\fP [\-f xml\-file] [\-g groups]
+Build structure entries based on client statistics extra entries
+(See MINESTRUCT OPTIONS below).
+.TP
+.B perf
+Query server for performance data.
+.TP
+.B pull \fIclient\fP \fIentry\-type\fP \fIentry\-name\fP
+Install configuration information into repo based on client bad
+entries (See PULL OPTIONS below).
+.TP
+.B reports [init|load_stats|purge|scrub|update]
+Interact with the dynamic reporting system (See REPORTS OPTIONS
+below).
+.TP
+.B snapshots [init|dump|query|reports]
+Interact with the Snapshots database (See SNAPSHOTS OPTIONS below).
+.TP
+.B syncdb
+Sync the Django ORM with the configured database.
+.TP
+.B tidy
+Remove unused files from repository.
+.TP
+.B viz [\-H] [\-b] [\-k] [\-o png\-file]
+Create a graphviz diagram of client, group and bundle information
+(See VIZ OPTIONS below).
+.TP
+.B xcmd
+Provides a XML\-RPC Command Interface to the bcfg2\-server.
+.UNINDENT
+.SS BUNDLE OPTIONS
+.INDENT 0.0
.TP
-\fBviz\fR [\-H] [\-b] [\-k] [\-o png\-file]
-Create a graphviz diagram of client, group and bundle information (See \fI\fBVIZ OPTIONS\fR\fR below)\.
-.
+.B mode
+One of the following.
+.INDENT 7.0
.TP
-\fBxcmd\fR
-Provides a XML\-RPC Command Interface to the bcfg2\-server\.
-.
-.SS "BUNDLE OPTIONS"
-.
+.B \fIlist\-xml\fP
+List all available xml bundles
.TP
-\fBmode\fR
-List all available xml bundles ’list\-xml’ or for all available genshi bundles ’list\-genshi’\. ’show’ provides an interactive dialog to get details about the available bundles\.
-.
-.SS "CLIENT OPTIONS"
-.
+.B \fIlist\-genshi\fP
+List all available genshi bundles
.TP
-\fBmode\fR
-Add a client ’add’, delete a client ’del’, or ’list’ all client entries\.
-.
+.B \fIshow\fP
+Interactive dialog to get details about the available bundles
+.UNINDENT
+.UNINDENT
+.SS CLIENT OPTIONS
+.INDENT 0.0
.TP
-\fBclient\fR
-Specify the client’s name\.
-.
+.B mode
+One of the following.
+.INDENT 7.0
.TP
-\fBattribute=value\fR
-Set attribute values when adding a new client\. Allowed attributes are ’profile’, ’uuid’, ’password’, ’location’, ’secure’, and ’address’\.
-.
-.SS "QUERY OPTIONS"
-.
+.B \fIadd\fP
+Add a client
.TP
-\fBb=bundle\fR
-Specify a bundle to search for within client metadata\.
-.
+.B \fIdel\fP
+Delete a client
.TP
-\fBg=group\fR
-Specify a group to search within\.
-.
+.B \fIlist\fP
+List all client entries
+.UNINDENT
.TP
-\fBp=profile\fR
-Specify a profile to search within\.
-.
+.B client
+Specify the client\(aqs name.
.TP
-\fB\-f\fR \fIoutput file\fR
-Write the results of the query to a file\.
-.
+.B attribute=value
+Set attribute values when adding a new client. Allowed attributes
+are \(aqprofile\(aq, \(aquuid\(aq, \(aqpassword\(aq, \(aqlocation\(aq, \(aqsecure, and
+\(aqaddress\(aq.
+.UNINDENT
+.SS COMPARE OPTIONS
+.INDENT 0.0
+.TP
+.B old
+Specify the location of the old configuration file.
.TP
-\fB\-n\fR
-Print the results, one on each line\.
-.
+.B new
+Specify the location of the new configuration file.
+.UNINDENT
+.SS MINESTRUCT OPTIONS
+.INDENT 0.0
.TP
-\fB\-c\fR
-Print the results, separated by commas\.
-.
-.SS "COMPARE OPTIONS"
-.
+.B client
+Client whose metadata is to be searched for extra entries.
.TP
-\fBold\fR
-Specify the location of the old configuration file\.
-.
+.B \-g \fIgroups\fP
+Hierarchy of groups in which to place the extra entries in.
.TP
-\fBnew\fR
-Specify the location of the new configuration file\.
-.
-.SS "MINESTRUCT OPTIONS"
-.
+.B \-f \fIoutputfile\fP
+Specify the xml file in which to write the extra entries.
+.UNINDENT
+.SS PULL OPTIONS
+.INDENT 0.0
.TP
-\fBclient\fR
-Client whose metadata is to be searched for extra entries\.
-.
+.B client
+Specify the name of the client to search for.
.TP
-\fB\-g\fR \fIgroups\fR
-Hierarchy of groups in which to place the extra entries in\.
-.
+.B entry type
+Specify the type of the entry to pull.
.TP
-\fB\-f\fR \fIxml output file\fR
-Specify the xml file in which to write the extra entries\.
-.
-.SS "PULL OPTIONS"
-.
+.B entry name
+Specify the name of the entry to pull.
+.UNINDENT
+.SS REPORTS OPTIONS
+.INDENT 0.0
.TP
-\fBclient\fR
-Specify the name of the client to search for\.
-.
+.B load_stats [\-s] [\-c] [\-03]
+Load statistics data.
+.TP
+.B purge [\-\-client [n]] [\-\-days [n]] [\-\-expired]
+Purge historic and expired data.
.TP
-\fBentry type\fR
-Specify the type of the entry to pull\.
-.
+.B scrub
+Scrub the database for duplicate reasons and orphaned entries.
.TP
-\fBentry name\fR
-Specify the name of the entry to pull\.
-.
-.SS "REPORTS OPTIONS"
-.
-.TP
-\fBinit\fR
-Initialize the database\.
-.
-.TP
-\fBload_stats\fR [\-s] [\-c] [\-03]
-Load statistics data\.
-.
-.TP
-\fBpurge\fR [\-\-client [n]] [\-\-days [n]] [\-\-expired]
-Purge historic and expired data\.
-.
-.TP
-\fBscrub\fR
-Scrub the database for duplicate reasons and orphaned entries\.
-.
-.TP
-\fBupdate\fR
-Apply any updates to the reporting database\.
-.
-.SS "SNAPSHOTS OPTIONS"
-.
-.TP
-\fBinit\fR
-Initialize the snapshots database\.
-.
-.TP
-\fBquery\fR
-Query the snapshots database\.
-.
-.TP
-\fBdump\fR
-Dump some of the contents of the snapshots database\.
-.
-.TP
-\fBreports\fR [\-a] [\-b] [\-e] [\-\-date=\fIMM\-DD\-YYYY\fR]
-Generate reports for clients in the snapshots database\.
-.
-.SS "VIZ OPTIONS"
-.
-.TP
-\fB\-H\fR
-Include hosts in diagram\.
-.
-.TP
-\fB\-b\fR
-Include bundles in diagram\.
-.
-.TP
-\fB\-o\fR \fIoutput file\fR
-Write to outfile file instead of stdout\.
-.
+.B update
+Apply any updates to the reporting database.
+.UNINDENT
+.SS SNAPSHOTS OPTIONS
+.INDENT 0.0
+.TP
+.B init
+Initialize the snapshots database.
+.TP
+.B query
+Query the snapshots database.
+.TP
+.B dump
+Dump some of the contents of the snapshots database.
.TP
-\fB\-k\fR
-Add a shape/color key\.
+.B reports [\-a] [\-b] [\-e] [\-\-date=MM\-DD\-YYYY]
+Generate reports for clients in the snapshots database.
+.UNINDENT
+.SS VIZ OPTIONS
+.INDENT 0.0
+.TP
+.B \-H
+Include hosts in diagram.
+.TP
+.B \-b
+Include bundles in diagram.
+.TP
+.BI \-o \ <outfile>
+Write to outfile file instead of stdout.
+.TP
+.B \-k
+Add a shape/color key.
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIbcfg2\-info(8)\fP, \fIbcfg2\-server(8)\fP
+.SH COPYRIGHT
+2009-2012, Narayan Desai
+.\" Generated by docutils manpage writer.
+.\"
.
-.SH "SEE ALSO"
-bcfg2\-info(8), bcfg2\-server(8)
diff --git a/man/bcfg2-build-reports.8 b/man/bcfg2-build-reports.8
index 55aff8b31..be021c989 100644
--- a/man/bcfg2-build-reports.8
+++ b/man/bcfg2-build-reports.8
@@ -1,36 +1,64 @@
+.TH "BCFG2-BUILD-REPORTS" "8" "November 07, 2012" "1.3" "Bcfg2"
+.SH NAME
+bcfg2-build-reports \- Generate state reports for Bcfg2 clients
.
-.TH "BCFG2\-BUILD\-REPORTS" "8" "September 2012" "" ""
+.nr rst2man-indent-level 0
.
-.SH "NAME"
-\fBbcfg2\-build\-reports\fR \- Generate state reports for Bcfg2 clients
-.
-.SH "SYNOPSIS"
-\fBbcfg2\-build\-reports\fR [\fI\-A\fR] [\fI\-c\fR] [\fI\-s\fR] [\fI\-N\fR]
-.
-.SH "DESCRIPTION"
-\fBbcfg2\-build\-reports\fR is used to build all client state reports\. See the Bcfg2 manual for report setup information\.
-.
-.SH "OPTIONS"
-.
-.TP
-\fB\-A\fR
-Displays all data\.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
.
+.SH SYNOPSIS
+.sp
+\fBbcfg2\-build\-reports\fP [\fI\-A\fP] [\fI\-c\fP] [\fI\-s\fP]
+.SH DESCRIPTION
+.sp
+\fBbcfg2\-build\-reports\fP is used to build all client state
+reports. See the Bcfg2 manual for report setup information.
+.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-c\fR \fIconfiguration file\fR
-Specify an alternate report configuration path\. The default is repo/etc/reports\-configuration\.xml\.
-.
+.B \-A
+Displays all data.
.TP
-\fB\-h\fR
-Produce a help message\.
-.
+.BI \-c \ configfile
+Specify an alternate report configuration path. The
+default is \fBrepo/etc/reports\-configuration.xml\fP.
.TP
-\fB\-s\fR \fIstatistics path\fR
-Use an alternative path for the statistics file\. The default is repo/etc/statistics\.xml\.
-.
+.B \-h
+Print usage information.
.TP
-\fB\-N\fR
-No pinging\.
+.BI \-s \ statsfile
+Use an alternative path for the statistics file. The
+default is \fBrepo/etc/statistics.xml\fP.
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIbcfg2(1)\fP, \fIbcfg2\-server(8)\fP
+.SH COPYRIGHT
+2009-2012, Narayan Desai
+.\" Generated by docutils manpage writer.
+.\"
.
-.SH "SEE ALSO"
-bcfg2(1), bcfg2\-server(8)
diff --git a/man/bcfg2-crypt.8 b/man/bcfg2-crypt.8
index 64c10a902..2a26a4688 100644
--- a/man/bcfg2-crypt.8
+++ b/man/bcfg2-crypt.8
@@ -1,91 +1,156 @@
-.
-.TH "BCFG2\-CRYPT" "8" "September 2012" "" ""
-.
-.SH "NAME"
-\fBbcfg2\-crypt\fR \- Bcfg2 encryption and decryption utility
-.
-.SH "SYNOPSIS"
-\fBbcfg2\-crypt\fR [\fI\-C configfile\fR] [\-\-decrypt|\-\-encrypt] [\-\-cfg|\-\-properties] [\-\-stdout] [\-\-remove] [\-\-xpath \fIxpath\fR] [\-p \fIpassphrase\-or\-name\fR] [\-v] [\-I] \fIfilename\fR [\fIfilename\fR\.\.\.]
-.
-.SH "DESCRIPTION"
-\fBbcfg2\-crypt\fR performs encryption and decryption of Cfg and Properties files\. It\'s often sufficient to run \fBbcfg2\-crypt\fR with only the name of the file you wish to encrypt or decrypt; it can usually figure out what to do\.
-.
-.SH "OPTIONS"
-.
+.TH "BCFG2-CRYPT" "8" "November 07, 2012" "1.3" "Bcfg2"
+.SH NAME
+bcfg2-crypt \- Bcfg2 encryption and decryption utility
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
+.SH SYNOPSIS
+.sp
+\fBbcfg2\-crypt\fP [\-C \fIconfigfile\fP] [\-\-decrypt|\-\-encrypt]
+[\-\-cfg|\-\-properties] [\-\-stdout] [\-\-remove] [\-\-xpath \fIxpath\fP]
+[\-p \fIpassphrase\-or\-name\fP] [\-v] [\-I] \fIfilename\fP [\fIfilename\fP...]
+.SH DESCRIPTION
+.sp
+\fBbcfg2\-crypt\fP performs encryption and decryption of Cfg and
+Properties files. It\(aqs often sufficient to run \fBbcfg2\-crypt\fP
+with only the name of the file you wish to encrypt or decrypt; it can
+usually figure out what to do.
+.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-C\fR \fIconfigfile\fR
-Specify alternate bcfg2\.conf location
-.
+.BI \-C \ configfile
+Specify alternate bcfg2.conf location.
.TP
-\fB\-\-decrypt\fR, \fB\-\-encrypt\fR
-Specify which operation you\'d like to perform\. \fBbcfg2\-crypt\fR can usually determine which is necessary based on the contents of each file\.
-.
+.B \-\-decrypt, \-\-encrypt
+Select encryption or decryption mode for the
+given file(s). This is usually unnecessary, as
+\fBbcfg2\-crypt\fP can often determine which
+is necessary based on the contents of each file.
.TP
-\fB\-\-cfg\fR
-Tell \fBbcfg2\-crypt\fR that an XML file should be encrypted in its entirety rather than element\-by\-element\. This is only necessary if the file is an XML file whose name ends with \fB\.xml\fR and whose top\-level tag is \fB<Properties>\fR\. See \fIMODES\fR below for details\.
-.
+.B \-\-cfg
+An XML file should be encrypted in its entirety
+rather than element\-by\-element. This is only
+necessary if the file is an XML file whose name
+ends with \fI.xml\fP and whose top\-level tag is
+\fI<Properties>\fP. See [MODES] below for details.
.TP
-\fB\-\-properties\fR
-Tell \fBbcfg2\-crypt\fR to process a file as an XML Properties file, and encrypt the text of each element separately\. This is necessary if, for example, you\'ve used a different top\-level tag than \fB<Properties>\fR in your Properties files\. See \fIMODES\fR below for details\.
-.
+.B \-\-properties
+Process a file as an XML Properties file, and
+encrypt the text of each element
+separately. This is necessary if, for example,
+you\(aqve used a different top\-level tag than
+\fIProperties\fP in your Properties files. See
+[MODES] below for details.
.TP
-\fB\-\-stdout\fR
-Print the resulting file to stdout instead of writing it to a file\.
-.
+.B \-\-stdout
+Print the resulting file to stdout instead of
+writing it to a file.
.TP
-\fB\-\-remove\fR
-Remove the plaintext file after it has been encrypted\. Only meaningful for Cfg files\.
-.
+.B \-\-remove
+Remove the plaintext file after it has been
+encrypted. Only meaningful for Cfg files.
.TP
-\fB\-\-xpath <xpath>\fR
-Encrypt the character content of all elements that match the specified XPath expression\. The default is \fB*[@encrypted]\fR or \fB*\fR; see \fIMODES\fR below for more details\. Only meaningful for Properties files\.
-.
+.BI \-\-xpath \ xpath
+Encrypt the character content of all elements
+that match the specified XPath expression. The
+default is \fI*[@encrypted]\fP or \fI*\fP; see [MODES]
+below for more details. Only meaningful for
+Properties files.
.TP
-\fB\-p <passphrase>\fR
-Specify the name of a passphrase specified in the \fB[encryption]\fR section of \fBbcfg2\.conf\fR\. See \fISELECTING PASSPHRASE\fR below for more details\.
-.
+.BI \-p \ passphrase
+Specify the name of a passphrase specified in
+the \fI[encryption]\fP section of \fIbcfg2.conf\fP. See
+[SELECTING PASSPHRASE] below for more details.
.TP
-\fB\-v\fR
-Be verbose\.
-.
+.B \-v
+Be verbose.
.TP
-\fB\-I\fR
-When encrypting a Properties file, interactively select the elements whose data should be encrypted\.
-.
+.B \-I
+When encrypting a Properties file, interactively
+select the elements whose data should be
+encrypted.
.TP
-\fB\-h\fR
-Display help and exit\.
-.
-.SH "MODES"
-\fBbcfg2\-crypt\fR can encrypt Cfg files or Properties files; they are handled very differently\.
-.
+.B \-h
+Print usage information.
+.UNINDENT
+.SH MODES
+.sp
+\fBbcfg2\-crypt\fP can encrypt Cfg files or Properties files; they
+are handled very differently.
+.INDENT 0.0
.TP
-Cfg
-When \fBbcfg2\-crypt\fR is used on a Cfg file, the entire file is encrypted\. This is the default behavior on files that are not XML, or that are XML but whose top\-level tag is not \fB<Properties>\fR\. This can be enforced by use of the \fB\-\-cfg\fR option\.
-.
+.B Cfg
+When \fBbcfg2\-crypt\fP is used on a Cfg file, the entire file
+is encrypted. This is the default behavior on files that are not
+XML, or that are XML but whose top\-level tag is not \fI<Properties>\fP.
+This can be enforced by use of the \fI\-\-cfg\fP option.
.TP
-Properties
-When \fBbcfg2\-crypt\fR is used on a Properties file, it encrypts the character content of elements matching the XPath expression given by \fB\-\-xpath\fR\. By default the expression is \fB*[@encrypted]\fR, which matches all elements with an \fBencrypted\fR attribute\. If you are encrypting a file and that expression doesn\'t match any elements, then the default is \fB*\fR, which matches everything\. When \fBbcfg2\-crypt\fR encrypts the character content of an element, it also adds the \fBencrypted\fR attribute, set to the name of the passphrase used to encrypt that element\. When it decrypts an element it does not remove \fBencrypted\fR, though; this lets you easily and efficiently run \fBbcfg2\-crypt\fR against a single Properties file to encrypt and decrypt it without needing to specify a long list of options\. See the online Bcfg2 docs on Properties files for more information on how this works\.
-.
-.SH "SELECTING PASSPHRASE"
-The passphrase used to encrypt or decrypt a file is discovered in the following order:
-.
-.IP "\(bu" 4
-First, the passphrase given on the command line using \fB\-p\fR is used\.
-.
-.IP "\(bu" 4
-Next, if exactly one passphrase is specified in \fBbcfg2\.conf\fR, it will be used\.
-.
-.IP "\(bu" 4
-Next, if operating in Properties mode, \fBbcfg2\-crypt\fR will attempt to read the name of the passphrase from the encrypted elements\.
-.
-.IP "\(bu" 4
-Next, if decrypting, all passphrases will be tried sequentially\.
-.
-.IP "\(bu" 4
-If no passphrase has been determined at this point, an error is produced and the file being encrypted or decrypted is skipped\.
-.
-.IP "" 0
+.B Properties
+When \fBbcfg2\-crypt\fP is used on a Properties file, it
+encrypts the character content of elements matching the XPath
+expression given by \fI\-\-xpath\fP. By default the expression is
+\fI*[@encrypted]\fP, which matches all elements with an \fIencrypted\fP
+attribute. If you are encrypting a file and that expression doesn\(aqt
+match any elements, then the default is \fI*\fP, which matches
+everything. When \fBbcfg2\-crypt\fP encrypts the character
+content of an element, it also adds the \fIencrypted\fP attribute, set
+to the name of the passphrase used to encrypt that element. When it
+decrypts an element it does not remove \fIencrypted\fP, though; this
+lets you easily and efficiently run \fBbcfg2\-crypt\fP against a
+single Properties file to encrypt and decrypt it without needing to
+specify a long list of options. See the online Bcfg2 docs on
+Properties files for more information on how this works.
+.UNINDENT
+.SH SELECTING PASSPHRASE
+.sp
+The passphrase used to encrypt or decrypt a file is discovered in the
+following order.
+.INDENT 0.0
+.IP 1. 3
+The passphrase given on the command line using \fI\-p\fP is used.
+.IP 2. 3
+If exactly one passphrase is specified in \fIbcfg2.conf\fP, it will be
+used.
+.IP 3. 3
+If operating in Properties mode, \fIbcfg2.conf\fP will attempt to read
+the name of the passphrase from the encrypted elements.
+.IP 4. 3
+If decrypting, all passphrases will be tried sequentially.
+.IP 5. 3
+If no passphrase has been determined at this point, an error is
+produced and the file being encrypted or decrypted is skipped.
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIbcfg2\-server(8)\fP
+.SH COPYRIGHT
+2009-2012, Narayan Desai
+.\" Generated by docutils manpage writer.
+.\"
.
-.SH "SEE ALSO"
-bcfg2\-server(8)
diff --git a/man/bcfg2-info.8 b/man/bcfg2-info.8
index 9362776a1..1dde60440 100644
--- a/man/bcfg2-info.8
+++ b/man/bcfg2-info.8
@@ -1,134 +1,142 @@
-.
-.TH "BCFG2\-INFO" "8" "September 2012" "" ""
-.
-.SH "NAME"
-\fBbcfg2\-info\fR \- Creates a local version of the Bcfg2 server core for state observation
-.
-.SH "SYNOPSIS"
-\fBbcfg2\-info\fR [\fI\-C configfile\fR] [\-E \fIencoding\fR] [\-Q \fIrepository path\fR] [\-h] [\-p] [\-x \fIpassword\fR] [\fImode\fR] [\fImode args\fR] [\fImode options\fR]
-.
-.SH "DESCRIPTION"
-\fBbcfg2\-info\fR instantiates an instance of the Bcfg2 core for data examination and debugging purposes\.
-.
-.SH "OPTIONS"
-.
-.TP
-\fB\-C\fR \fIconfigfile\fR
-Specify alternate bcfg2\.conf location
-.
-.TP
-\fB\-E\fR \fIencoding\fR
-Specify the encoding of config files\.
-.
-.TP
-\fB\-Q\fR \fIrepository path\fR
-Specify the server repository path\.
-.
-.TP
-\fB\-d\fR
-Run in debug mode\.
-.
-.TP
-\fB\-h\fR
-Give a bit of help about the command line arguments and options\. After this bcfg2\-info exits\.
-.
-.TP
-\fB\-p\fR
-Specify a profile\.
-.
-.TP
-\fB\-x\fR \fIpassword\fR
-Set the communication password\.
-.
-.SH "MODES"
-.
-.TP
-\fBbuild\fR \fIhostname\fR \fIfilename\fR
-Build config for hostname, writing to filename\.
-.
-.TP
-\fBbuildall\fR \fIdirectory\fR
-Build configs for all clients in directory\.
-.
-.TP
-\fBbuildallfile\fR \fIdirectory\fR \fIfilename\fR [\fIhostnames\fR]
-Build config file for all clients in directory\.
-.
-.TP
-\fBbuildbundle\fR \fIfilename\fR \fIhostname\fR
-Build bundle for hostname (not written to disk)\. If filename is a bundle template, it is rendered\.
-.
+.TH "BCFG2-INFO" "8" "November 07, 2012" "1.3" "Bcfg2"
+.SH NAME
+bcfg2-info \- Creates a local version of the Bcfg2 server core for state observation
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
+.SH SYNOPSIS
+.sp
+\fBbcfg2\-info\fP [\-C \fIconfigfile\fP] [\-E \fIencoding\fP] [\-Q \fIrepository path\fP]
+[\-h] [\-p] [\-x \fIpassword\fP] [\fImode\fP] [\fImode args\fP] [\fImode options\fP]
+.SH DESCRIPTION
+.sp
+\fBbcfg2\-info\fP instantiates an instance of the Bcfg2 core for
+data examination and debugging purposes.
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.BI \-C \ configfile
+Specify alternate bcfg2.conf location.
+.TP
+.BI \-E \ encoding
+Specify the encoding of config files.
+.TP
+.BI \-Q \ path
+Specify the path to the server repository.
+.TP
+.B \-d
+Enable debugging output.
+.TP
+.B \-h
+Print usage information.
+.TP
+.BI \-p \ profile
+Specify a profile.
+.TP
+.BI \-x \ password
+Use \(aqpassword\(aq for client communication.
+.UNINDENT
+.SH MODES
+.INDENT 0.0
+.TP
+.B build \fIhostname\fP \fIfilename\fP
+Build config for hostname, writing to filename.
+.TP
+.B buildall \fIdirectory\fP
+Build configs for all clients in directory.
+.TP
+.B buildallfile \fIdirectory\fP \fIfilename\fP [\fIhostnames\fP]
+Build config file for all clients in directory.
+.TP
+.B buildbundle \fIfilename\fP \fIhostname\fP
+Build bundle for hostname (not written to disk). If filename is a
+bundle template, it is rendered.
+.TP
+.B builddir \fIhostname\fP \fIdirname\fP
+Build config for hostname, writing separate files to dirname.
+.TP
+.B buildfile [\-\-altsrc=*altsrc*] \fIfilename\fP \fIhostname\fP
+Build config file for hostname (not written to disk).
+.TP
+.B bundles
+Print out group/bundle information.
+.TP
+.B clients
+Print out client/profile information.
+.TP
+.B config
+Print out the configuration of the Bcfg2 server.
+.TP
+.B debug
+Shell out to native python interpreter.
+.TP
+.B event_debug
+Display filesystem events as they are processed.
+.TP
+.B groups
+List groups.
+.TP
+.B help
+Print the list of available commands.
+.TP
+.B mappings [\fIentry type\fP] [\fIentry name\fP]
+Print generator mappings for optional type and name.
+.TP
+.B packageresolve \fIhostname\fP \fIpackage\fP [\fIpackage\fP...]
+Resolve the specified set of packages.
+.TP
+.B packagesources \fIhostname\fP
+Show package sources.
.TP
-\fBbuilddir\fR \fIhostname\fR \fIdirname\fR
-Build config for hostname, writing separate files to dirname\.
-.
-.TP
-\fBbuildfile\fR [\-\-altsrc=\fIaltsrc\fR] \fIfilename\fR \fIhostname\fR
-Build config file for hostname (not written to disk)\.
-.
-.TP
-\fBbundles\fR
-Print out group/bundle information\.
-.
+.B profile \fIcommand\fP \fIargs\fP
+Profile a single bcfg2\-info command.
.TP
-\fBclients\fR
-Print out client/profile information\.
-.
+.B quit
+Exit bcfg2\-info command line.
.TP
-\fBconfig\fR
-Print out the configuration of the Bcfg2 server\.
-.
+.B showentries \fIhostname\fP \fItype\fP
+Show abstract configuration entries for a given host.
.TP
-\fBdebug\fR
-Shell out to native python interpreter\.
-.
+.B showclient \fIclient1\fP \fIclient2\fP
+Show metadata for given hosts.
.TP
-\fBevent_debug\fR
-Display filesystem events as they are processed\.
-.
-.TP
-\fBgroups\fR
-List groups\.
-.
-.TP
-\fBhelp\fR
-Print the list of available commands\.
-.
-.TP
-\fBmappings\fR [\fIentry type\fR] [\fIentry name\fR]
-Print generator mappings for optional type and name\.
-.
-.TP
-\fBpackageresolve\fR \fIhostname\fR \fIpackage\fR [\fIpackage\fR\.\.\.]
-Resolve the specified set of packages\.
-.
-.TP
-\fBpackagesources\fR \fIhostname\fR
-Show package sources\.
-.
-.TP
-\fBprofile\fR \fIcommand\fR \fIargs\fR
-Profile a single bcfg2\-info command\.
-.
-.TP
-\fBquit\fR
-Exit bcfg2\-info command line\.
-.
-.TP
-\fBshowentries\fR \fIhostname\fR \fItype\fR
-Show abstract configuration entries for a given host\.
-.
-.TP
-\fBshowclient\fR \fIclient1\fR \fIclient2\fR
-Show metadata for given hosts\.
-.
-.TP
-\fBupdate\fR
-Process pending file events\.
-.
+.B update
+Process pending file events.
.TP
-\fBversion\fR
-Print version of this tool\.
+.B version
+Print version of this tool.
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIbcfg2(1)\fP, \fIbcfg2\-server(8)\fP
+.SH COPYRIGHT
+2009-2012, Narayan Desai
+.\" Generated by docutils manpage writer.
+.\"
.
-.SH "SEE ALSO"
-bcfg2(1), bcfg2\-server(8)
diff --git a/man/bcfg2-lint.8 b/man/bcfg2-lint.8
index 6f2ee12a0..1f3c352ca 100644
--- a/man/bcfg2-lint.8
+++ b/man/bcfg2-lint.8
@@ -1,99 +1,155 @@
-.
-.TH "BCFG2\-LINT" "8" "October 2012" "" ""
-.
-.SH "NAME"
-\fBbcfg2\-lint\fR \- Check Bcfg2 specification for validity, common mistakes, and style
-.
-.SH "SYNOPSIS"
-\fBbcfg2\-lint\fR [\fIoptions\fR] [\fIplugin\fR [\fIplugin\fR\.\.\.]]
-.
-.SH "DESCRIPTION"
-\fBbcfg2\-lint\fR checks the Bcfg2 specification for schema validity, common mistakes, and other criteria\. It can be quite helpful in finding typos or malformed data\.
-.
-.P
-\fBbcfg2\-lint\fR exits with a return value of 2 if errors were found, and 3 if warnings (but no errors) were found\. Any other non\-0 exit value denotes some failure in the script itself\.
-.
-.P
-\fBbcfg2\-lint\fR is a rewrite of the older bcfg2\-repo\-validate tool\.
-.
-.SH "OPTIONS"
-.
+.TH "BCFG2-LINT" "8" "November 07, 2012" "1.3" "Bcfg2"
+.SH NAME
+bcfg2-lint \- Check Bcfg2 specification for validity, common mistakes, and style
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
+.SH SYNOPSIS
+.sp
+\fBbcfg2\-lint\fP [\fIoptions\fP] [\fIplugin\fP [\fIplugin\fP...]]
+.SH DESCRIPTION
+.sp
+\fBbcfg2\-lint\fP checks the Bcfg2 specification for schema
+validity, common mistakes, and other criteria. It can be quite helpful
+in finding typos or malformed data.
+.sp
+\fBbcfg2\-lint\fP exits with a return value of 2 if errors were
+found, and 3 if warnings (but no errors) were found. Any other non\-0
+exit value denotes some failure in the script itself.
+.sp
+\fBbcfg2\-lint\fP is a rewrite of the older bcfg2\-repo\-validate
+tool.
+.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-C\fR \fIconfigfile\fR
-Specify alternate bcfg2\.conf location\.
-.
+.BI \-C \ configfile
+Specify alternate bcfg2.conf location.
.TP
-\fB\-Q\fR
-Specify the server repository path\.
-.
+.BI \-Q \ path
+Specify the path to the server repository.
.TP
-\fB\-v\fR
-Be verbose\.
-.
+.B \-v
+Be verbose.
.TP
-\fB\-\-lint\-config\fR
-Specify path to bcfg2\-lint\.conf (default \fB/etc/bcfg2\-lint\.conf\fR)\.
-.
+.B \-\-lint\-config
+Specify path to bcfg2\-lint.conf (default
+\fB/etc/bcfg2\-lint.conf\fP).
.TP
-\fB\-\-stdin\fR
-Rather than operating on all files in the Bcfg2 specification, only validate a list of files supplied on stdin\. This mode is particularly useful in pre\-commit hooks\.
-.
-.IP
+.B \-\-stdin
+Rather than operating on all files in the Bcfg2
+specification, only validate a list of files
+supplied on stdin. This mode is particularly useful
+in pre\-commit hooks.
+.sp
This makes a few assumptions:
-.
-.IP
-Metadata files will only be checked if a valid chain of XIncludes can be followed all the way from clients\.xml or groups\.xml\. Since there are multiple formats of metadata stored in Metadata/ (i\.e\., clients and groups), there is no way to determine which sort of data a file contains unless there is a valid chain of XIncludes\. It may be useful to always specify all metadata files should be checked, even if not all of them have changed\.
-.
-.IP
-Property files will only be validated if both the property file itself and its matching schema are included on stdin\.
-.
+.sp
+Metadata files will only be checked if a valid chain
+of XIncludes can be followed all the way from
+clients.xml or groups.xml. Since there are multiple
+formats of metadata stored in Metadata/ (i.e.,
+clients and groups), there is no way to determine
+which sort of data a file contains unless there is a
+valid chain of XIncludes. It may be useful to always
+specify all metadata files should be checked, even
+if not all of them have changed.
+.sp
+Property files will only be validated if both the
+property file itself and its matching schema are
+included on stdin.
+.UNINDENT
+.SH PLUGINS
+.sp
+See \fIbcfg2\-lint.conf(5)\fP for more information on the
+configuration of the plugins listed below.
+.INDENT 0.0
.TP
-\fBrequire\-schema\fR
-Require property files to have matching schema files\.
-.
-.SH "PLUGINS"
-See \fBbcfg2\-lint\.conf\fR(5) for more information on the configuration of the plugins listed below\.
-.
+.B Bundles
+Check the specification for several issues with Bundler: bundles
+referenced in metadata but not found in \fIBundler/\fP; bundles whose
+\fIname\fP attribute does not match the filename; and Genshi template
+bundles that use the \fI<Group>\fP tag (which is not processed in
+templated bundles).
.TP
-\fBBundles\fR
-Check the specification for several issues with Bundler: bundles referenced in metadata but not found in \fBBundler/\fR; bundles whose \fIname\fR attribute does not match the filename; and Genshi template bundles that use the \fI\fIGroup\fR\fR tag (which is not processed in templated bundles)\.
-.
-.TP
-\fBComments\fR
-Check the specification for VCS keywords and any comments that are required\. By default, this only checks that the \fI$Id$\fR keyword is included and expanded in all files\. You may specify VCS keywords to check and comments to be required in the config file\. (For instance, you might require that every file have a "Maintainer" comment\.)
-.
-.IP
-In XML files, only comments are checked for the keywords and comments required\.
-.
+.B Comments
+Check the specification for VCS keywords and any comments that are
+required. By default, this only checks that the \fI$Id$\fP keyword is
+included and expanded in all files. You may specify VCS keywords to
+check and comments to be required in the config file. (For instance,
+you might require that every file have a "Maintainer" comment.)
+.sp
+In XML files, only comments are checked for the keywords and
+comments required.
.TP
-\fBDuplicates\fR
-Check for several types of duplicates in the Metadata: duplicate groups; duplicate clients; and multiple default groups\.
-.
+.B Duplicates
+Check for several types of duplicates in the Metadata: duplicate
+groups; duplicate clients; and multiple default groups.
.TP
-\fBInfoXML\fR
-Check that certain attributes are specified in \fBinfo\.xml\fR files\. By default, requires that \fIowner\fR, \fIgroup\fR, and \fImode\fR are specified\. Can also require that an \fBinfo\.xml\fR exists for all Cfg files, and that paranoid mode be enabled for all files\.
-.
+.B InfoXML
+Check that certain attributes are specified in \fIinfo.xml\fP files. By
+default, requires that \fIowner\fP, \fIgroup\fP, and \fImode\fP are specified.
+Can also require that an \fIinfo.xml\fP exists for all Cfg files, and
+that paranoid mode be enabled for all files.
.TP
-\fBMergeFiles\fR
-Suggest that similar probes and config files be merged into single probes or TGenshi templates\.
-.
+.B MergeFiles
+Suggest that similar probes and config files be merged into single
+probes or TGenshi templates.
.TP
-\fBPkgmgr\fR
-Check for duplicate packages specified in Pkgmgr\.
-.
+.B Pkgmgr
+Check for duplicate packages specified in Pkgmgr.
.TP
-\fBRequiredAttrs\fR
-Check that all \fIPath\fR and \fIBoundPath\fR tags have the attributes that are required by their type (e\.g\., a path of type symlink must have name and to specified to be valid)\. This sort of validation is beyond the scope of an XML schema\.
-.
+.B RequiredAttrs
+Check that all \fIPath\fP and \fIBoundPath\fP tags have the attributes that
+are required by their type (e.g., a path of type symlink must have
+name and to specified to be valid). This sort of validation is
+beyond the scope of an XML schema.
.TP
-\fBValidate\fR
-Validate the Bcfg2 specification against the XML schemas\.
-.
-.IP
-Property files are freeform XML, but if a \fB\.xsd\fR file with a matching filename is provided, then schema validation will be performed on property files individually as well\. For instance, if you have a property file named \fBntp\.xml\fR then by placing a schema for that file in \fBntp\.xsd\fR schema validation will be performed on \fBntp\.xml\fR\.
-.
-.SH "BUGS"
-\fBbcfg2\-lint\fR may not handle some older plugins as well as it handles newer ones\. For instance, there may be some places where it expects all of your configuration files to be handled by Cfg rather than by a mix of Cfg and TGenshi or TCheetah\.
+.B Validate
+Validate the Bcfg2 specification against the XML schemas.
+.sp
+Property files are freeform XML, but if a \fI.xsd\fP file with a matching
+filename is provided, then schema validation will be performed on
+property files individually as well. For instance, if you have a
+property file named \fIntp.xml\fP then by placing a schema for that file
+in \fIntp.xsd\fP schema validation will be performed on \fIntp.xml\fP.
+.UNINDENT
+.SH BUGS
+.sp
+\fBbcfg2\-lint\fP may not handle some older plugins as well as it
+handles newer ones. For instance, there may be some places where it
+expects all of your configuration files to be handled by Cfg rather than
+by a mix of Cfg and TGenshi or TCheetah.
+.SH SEE ALSO
+.sp
+\fIbcfg2(1)\fP, \fIbcfg2\-server(8)\fP,
+\fIbcfg2\-lint.conf(5)\fP
+.SH COPYRIGHT
+2009-2012, Narayan Desai
+.\" Generated by docutils manpage writer.
+.\"
.
-.SH "SEE ALSO"
-bcfg2(1), bcfg2\-server(8), bcfg2\-lint\.conf(5)
diff --git a/man/bcfg2-lint.conf.5 b/man/bcfg2-lint.conf.5
index 63fe73253..10cfb3046 100644
--- a/man/bcfg2-lint.conf.5
+++ b/man/bcfg2-lint.conf.5
@@ -1,99 +1,164 @@
-.
-.TH "BCFG2\-LINT\.CONF" "5" "October 2012" "" ""
-.
-.SH "NAME"
-\fBbcfg2\-lint\.conf\fR \- configuration parameters for bcfg2\-lint
-.
-.SH "DESCRIPTION"
-\fBbcfg2\-lint\.conf\fR includes configuration parameters for \fBbcfg2\-lint\fR\.
-.
-.SH "FILE FORMAT"
-The file is INI\-style and consists of sections and options\. A section begins with the name of the sections in square brackets and continues until the next section begins\.
-.
-.P
-Options are specified in the form "name=value"\.
-.
-.P
-The file is line\-based each newline\-terminated line represents either a comment, a section name or an option\.
-.
-.P
-Any line beginning with a hash (#) is ignored, as are lines containing only whitespace\.
-.
-.P
-The file consists of one \fB[lint]\fR section, up to one \fB[errors]\fR section, and then any number of plugin\-specific sections, documented below\. (Note that this makes it quite feasible to combine your \fBbcfg2\-lint\.conf\fR into your \fBbcfg2\.conf\fR(5) file, if you so desire)\.
-.
-.SH "GLOBAL OPTIONS"
-These options apply to \fBbcfg2\-lint\fR generally, and must be in the \fB[lint]\fR section\.
-.
+.TH "BCFG2-LINT.CONF" "5" "November 07, 2012" "1.3" "Bcfg2"
+.SH NAME
+bcfg2-lint.conf \- Configuration parameters for bcfg2-lint
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
+.SH DESCRIPTION
+.sp
+bcfg2\-lint.conf includes configuration parameters for bcfg2\-lint.
+.SH FILE FORMAT
+.sp
+The file is INI\-style and consists of sections and options. A section
+begins with the name of the sections in square brackets and continues
+until the next section begins.
+.sp
+Options are specified in the form "name=value".
+.sp
+The file is line\-based each newline\-terminated line represents either a
+comment, a section name or an option.
+.sp
+Any line beginning with a hash (#) is ignored, as are lines containing
+only whitespace.
+.sp
+The file consists of one \fI[lint]\fP section, up to one \fI[errors]\fP section,
+and then any number of plugin\-specific sections, documented below. (Note
+that this makes it quite feasible to combine your \fIbcfg2\-lint.conf\fP into
+your \fIbcfg2.conf(5)\fP file, if you so desire).
+.SH GLOBAL OPTIONS
+.sp
+These options apply to \fIbcfg2\-lint\fP generally, and must be in the
+\fI[lint]\fP section.
+.INDENT 0.0
.TP
-\fBplugins\fR
-A comma\-delimited list of plugins to run\. By default, all plugins are run\. This can be overridden by listing plugins on the command line\. See \fBbcfg2\-lint\fR(8) for a list of the available plugins\.
-.
-.SH "ERROR HANDLING"
-Error handling is configured in the \fB[errors]\fR section\. Each option should be the name of an error and one of \fIerror\fR, \fIwarning\fR, or \fIsilent\fR, which tells \fBbcfg2\-lint\fR(8) how to handle the warning\. Error names and their defaults can be displayed by running \fBbcfg2\-lint\fR(8) with the \fB\-\-list\-errors\fR option\.
-.
-.SH "PLUGIN OPTIONS"
-These options apply only to a single plugin\. Each option should be in a section named for its plugin; for instance, options for the InfoXML plugin would be in a section called \fB[InfoXML]\fR\.
-.
-.P
-If a plugin is not listed below, then it has no configuration\.
-.
-.P
-In many cases, the behavior of a plugin can be configured by modifying how errors from it are handled\. See \fI\fBERROR HANDLING\fR\fR, above\.
-.
-.SS "Comments"
-The \fBComments\fR plugin configuration specifies which VCS keywords and comments are required for which file types\. The valid types of file are \fIglobal\fR (all file types), \fIbundler\fR (non\-templated bundle files), \fIsgenshi\fR (templated bundle files), \fIproperties\fR (property files), \fIcfg\fR (non\-templated Cfg files), \fItgenshi\fR (templated Cfg files), \fIinfoxml\fR (info\.xml files), and \fIprobe\fR (probe files)\.
-.
-.P
-The specific types (i\.e\., types other than "global") all supplement global; they do not override it\. The exception is if you specify an empty option, e\.g\.:
-.
-.P
+.B plugins
+A comma\-delimited list of plugins to run. By default, all plugins
+are run. This can be overridden by listing plugins on the command
+line. See \fIbcfg2\-lint(8)\fP for a list of the available
+plugins.
+.UNINDENT
+.SH ERROR HANDLING
+.sp
+Error handling is configured in the \fI[errors]\fP section. Each option
+should be the name of an error and one of \fIerror\fP, \fIwarning\fP, or
+\fIsilent\fP, which tells \fBbcfg2\-lint\fP how to handle the
+warning. Error names and their defaults can be displayed by running
+\fBbcfg2\-lint\fP with the \fI\-\-list\-errors\fP option.
+.SH PLUGIN OPTIONS
+.sp
+These options apply only to a single plugin. Each option should be in a
+section named for its plugin; for instance, options for the InfoXML
+plugin would be in a section called \fI[InfoXML]\fP.
+.sp
+If a plugin is not listed below, then it has no configuration.
+.sp
+In many cases, the behavior of a plugin can be configured by modifying
+how errors from it are handled. See ERROR HANDLING, above.
+.SS Comments
+.sp
+The \fIComments\fP plugin configuration specifies which VCS keywords and
+comments are required for which file types. The valid types of file are
+\fIglobal\fP (all file types), \fIbundler\fP (non\-templated bundle files),
+\fIgenshibundler\fP (templated bundle files), \fIproperties\fP (property files),
+\fIcfg\fP (non\-templated Cfg files), \fIgenshi\fP or \fIcheetah\fP (templated Cfg
+files), \fIinfoxml\fP (info.xml files), and \fIprobe\fP (probe files).
+.sp
+The specific types (i.e., types other than "global") all supplement
+global; they do not override it. The exception is if you specify an
+empty option, e.g.:
+.INDENT 0.0
+.INDENT 3.5
cfg_keywords =
-.
-.P
-By default, the \fI$Id$\fR keyword is checked for and nothing else\.
-.
-.P
-Multiple keywords or comments should be comma\-delimited\.
-.
-.P
-· \fB<type>_keywords\fR
-.
-.P
-Ensure that files of the specified type have the given VCS keyword\. Do \fInot\fR include the dollar signs\. I\.e\.:
-.
-.P
+.UNINDENT
+.UNINDENT
+.sp
+By default, the \fI$Id$\fP keyword is checked for and nothing else.
+.sp
+Multiple keywords or comments should be comma\-delimited.
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP \(bu 2
+\fI<type>_keywords\fP
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+Ensure that files of the specified type have the given VCS keyword. Do
+\fInot\fP include the dollar signs. I.e.:
+.INDENT 0.0
+.INDENT 3.5
infoxml_keywords = Revision
-.
-.P
-\fInot\fR:
-.
-.P
+.UNINDENT
+.UNINDENT
+.sp
+\fInot\fP
+.INDENT 0.0
+.INDENT 3.5
infoxml_keywords = $Revision$
-.
-.P
-\fB· <type>_comments\fR
-.
-.P
-Ensure that files of the specified type have a comment containing the given string\. In XML files, only comments are checked\. In plain text files, all lines are checked since comment characters may vary\.
-.
-.SS "InfoXML"
-.
+.INDENT 0.0
+.IP \(bu 2
+\fI<type>_comments\fP
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+Ensure that files of the specified type have a comment containing the
+given string. In XML files, only comments are checked. In plain text
+files, all lines are checked since comment characters may vary.
+.SS InfoXML
+.INDENT 0.0
.TP
-\fBrequired_attrs\fR
-A comma\-delimited list of attributes to require on \fB<Info>\fR tags\. Default is "owner,group,mode"\.
-.
-.SS "MergeFiles"
-.
+.B required_attrs
+A comma\-delimited list of attributes to require on \fI<Info>\fP tags.
+Default is "owner,group,mode".
+.UNINDENT
+.SS MergeFiles
+.INDENT 0.0
.TP
-\fBthreshold\fR
-The threshold at which MergeFiles will suggest merging config files and probes\. Default is 75% similar\.
-.
-.SS "Validate"
-.
+.B threshold
+The threshold at which MergeFiles will suggest merging config files
+and probes. Default is 75% similar.
+.UNINDENT
+.SS Validate
+.INDENT 0.0
.TP
-\fBschema\fR
-The full path to the XML Schema files\. Default is \fB/usr/share/bcfg2/schema\fR\. This can be overridden with the \fI\-\-schema\fR command\-line option
+.B schema
+The full path to the XML Schema files. Default is
+\fB/usr/share/bcfg2/schema\fP. This can be overridden with the
+\fI\-\-schema\fP command\-line option.
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIbcfg2\-lint(8)\fP
+.SH COPYRIGHT
+2009-2012, Narayan Desai
+.\" Generated by docutils manpage writer.
+.\"
.
-.SH "SEE ALSO"
-bcfg2\-lint(8)
diff --git a/man/bcfg2-reports.8 b/man/bcfg2-reports.8
index 78b594047..cac01fc9b 100644
--- a/man/bcfg2-reports.8
+++ b/man/bcfg2-reports.8
@@ -1,76 +1,148 @@
-.
-.TH "BCFG2\-REPORTS" "8" "September 2012" "" ""
-.
-.SH "NAME"
-\fBbcfg2\-reports\fR \- Query reporting system for client status
-.
-.SH "SYNOPSIS"
-\fBbcfg2\-reports\fR [\-a] [\-b \fINAME\fR] [\-c] [\-d] [\-e \fINAME\fR] [\-h] [\-m \fINAME\fR] [\-s \fINAME\fR] [\-x \fINAME\fR] [\-\-badentry=\fIKIND,NAME\fR] [\-\-extraentry=\fIKIND,NAME\fR] [\-\-fields=<ARG1,ARG2,\.\.\.>] [\-\-modifiedentry=\fIKIND,NAME\fR] [\-\-sort=<ARG1,ARG2,\.\.\.>] [\-\-stale] [\-v]
-.
-.SH "DESCRIPTION"
-\fBbcfg2\-reports\fR allows you to retrieve data from the database about clients, and the states of their current interactions\. It also allows you to change the expired/unexpired states\. The utility runs as a standalone application\. It does, however, use the models from \fB/src/lib/Server/Reports/reports/models\.py\fR\.
-.
-.SH "OPTIONS"
-.
+.TH "BCFG2-REPORTS" "8" "November 07, 2012" "1.3" "Bcfg2"
+.SH NAME
+bcfg2-reports \- Query reporting system for client status
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
+.SH SYNOPSIS
+.sp
+\fBbcfg2\-reports\fP [\-a] [\-b \fINAME\fP] [\-c] [\-d] [\-e \fINAME\fP] [\-h]
+[\-m \fINAME\fP] [\-s \fINAME\fP] [\-x \fINAME\fP] [\-\-badentry=\fIKIND,NAME\fP]
+[\-\-extraentry=\fIKIND,NAME\fP] [\-\-fields=\fIARG1,ARG2,...\fP]
+[\-\-modifiedentry=\fIKIND,NAME\fP] [\-\-sort=\fIARG1,ARG2,...\fP] [\-\-stale] [\-v]
+.SH DESCRIPTION
+.sp
+\fBbcfg2\-reports\fP allows you to retrieve data from the database
+about clients, and the states of their current interactions. It also
+allows you to change the expired/unexpired states. The utility runs as a
+standalone application. It does, however, use the models from
+\fBsrc/lib/Bcfg2/Reporting/models.py\fP.
+.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-a\fR
-Specify alternate bcfg2\.conf location
-.
+.B \-h
+Print usage information.
+.UNINDENT
+.SH MODES
+.sp
+The following are various modes available for \fBbcfg2\-reports\fP.
+.SS Single\-Host Modes
+.INDENT 0.0
.TP
-\fB\-b\fR \fIhostname\fR
-Single host mode \- shows bad entries from the current interaction of \fIhostname\fR\.
-.
+.BI \-b, \-\-bad \ hostname
+Shows bad entries from the current
+interaction of \fIhostname\fP.
.TP
-\fB\-c\fR
-Shows only clean hosts\.
-.
+.BI \-e, \-\-extra \ hostname
+Shows extra entries from the current
+interaction of \fIhostname\fP.
.TP
-\fB\-d\fR
-Shows only dirty hosts\.
-.
+.BI \-m, \-\-modified \ hostname
+Shows modified entries from the current
+interaction of \fIhostname\fP.
.TP
-\fB\-e\fR \fIhostname\fR
-Single host mode \- shows extra entries from the current interaction of \fIhostname\fR\.
-.
+.BI \-s, \-\-show \ hostname
+Shows bad, modified, and extra entries from
+the current interaction of \fIhostname\fP.
.TP
-\fB\-h\fR
-Shows help and usage info about \fBbcfg2\-reports\fR\.
-.
+.BI \-t, \-\-total \ hostname
+Shows total number of managed and good
+entries from the current interaction of
+\fIhostname\fP.
.TP
-\fB\-m\fR \fIhostname\fR
-Single host mode \- shows modified entries from the current interaction of \fIhostname\fR\.
-.
+.BI \-x, \-\-expire \ hostname
+Toggles expired/unexpired state of
+\fIhostname\fP.
.TP
-\fB\-s\fR \fIhostname\fR
-Single host mode \- shows bad, modified, and extra entries from the current interaction of \fIhostname\fR\.
-.
+.B \-a, \-\-all
+Show all hosts, including expired hosts.
+.UNINDENT
+.SS Host Selection Modes
+.INDENT 0.0
.TP
-\fB\-x\fR \fIhostname\fR
-Toggles expired/unexpired state of \fIhostname\fR\.
-.
+.B \-a, \-\-all
+Show all hosts, including expired hosts.
.TP
-\fB\-\-badentry=\fR\fIentry type, entry name\fR
-Shows only hosts whose current interaction has bad entries of type \fIentry type\fR and name \fIentry name\fR\. If a single argument ARG1 is given, then \fIentry type\fR,\fIentry name\fR pairs will be read from a file of name ARG1\.
-.
+.B \-c, \-\-clean
+Show only clean hosts.
.TP
-\fB\-\-extraentry=\fR\fIentry type, entry name\fR
-Shows only hosts whose current interaction has extra entries of type \fIentry type\fR and name \fIentry name\fR\. If a single argument ARG1 is given, then \fIentry type\fR,\fIentry name\fR pairs will be read from a file of name ARG1\.
-.
+.B \-d, \-\-dirty
+Show only dirty hosts.
.TP
-\fB\-\-fields=\fR<ARG1,ARG2,\.\.\.>
-Only displays the fields \fIARG1,ARG2,\.\.\.\fR (name, time, state, total, good, bad)\.
-.
+.B \-\-stale
+Show hosts that haven\(aqt run in the last 24 hours.
+.UNINDENT
+.SS Entry Modes
+.sp
+The following mode flags require either a comma\-delimited list of any
+number of \fI<entry type>:<entry name>\fP arguments describing entries, or
+the \fI\-\-file\fP option.
+.INDENT 0.0
.TP
-\fB\-\-modifiedentry=\fR\fIentry type, entry name\fR
-Shows only hosts whose current interaction has modified entries of type \fIentry type\fR and name \fIentry name\fR\. If a single argument ARG1 is given, then \fIentry type\fR,\fIentry name\fR pairs will be read from a file of name ARG1\.
-.
+.BI \-\-badentry\fB= entrylist
+Shows only hosts whose current interaction
+has bad entries matching the given entry or
+entries.
.TP
-\fB\-\-sort=\fR<ARG1,ARG2,\.\.\.>
-Sorts output on ARG1,ARG2,\.\.\. (name, time, state, total, good, bad)\.
-.
+.BI \-\-extraentry\fB= entrylist
+Shows only hosts whose current interaction
+has extra entries matching the given entry
+or entries.
+.TP
+.BI \-\-entrystatus\fB= entry
+Shows the status of the single entry (given
+by \fI<entry type>:<entry name>\fP) on all
+hosts.
+.TP
+.BI \-\-modifiedentry\fB= entrylist
+Shows only hosts whose current interaction
+has modified entries matching the given
+entry or entries.
+.UNINDENT
+.SS Entry Options
+.sp
+The following options can be used with the above Entry Modes.
+.INDENT 0.0
+.TP
+.BI \-\-fields\fB= fields
+Only display the listed fields. Takes a
+comma\-delimited list of field names
.TP
-\fB\-\-stale\fR
-Shows hosts which haven’t run in the last 24 hours\.
+.BI \-\-file\fB= file
+Read \fI<entry type>:<entry name>\fP pairs from the
+specified file instead of the command line.
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIbcfg2(1)\fP, \fIbcfg2\-server(8)\fP
+.SH COPYRIGHT
+2009-2012, Narayan Desai
+.\" Generated by docutils manpage writer.
+.\"
.
-.SH "SEE ALSO"
-bcfg2(1), bcfg2\-server(8)
diff --git a/man/bcfg2-server.8 b/man/bcfg2-server.8
index 7bbfb87c3..2a34ede70 100644
--- a/man/bcfg2-server.8
+++ b/man/bcfg2-server.8
@@ -1,48 +1,82 @@
+.TH "BCFG2-SERVER" "8" "November 07, 2012" "1.3" "Bcfg2"
+.SH NAME
+bcfg2-server \- Server for client configuration specifications
.
-.TH "BCFG2\-SERVER" "8" "September 2012" "" ""
+.nr rst2man-indent-level 0
.
-.SH "NAME"
-\fBbcfg2\-server\fR \- Server for client configuration specifications
-.
-.SH "SYNOPSIS"
-\fBbcfg2\-server\fR [\-d] [\-v] [\-C \fIconfigfile\fR] [\-D \fIpidfile\fR] [\-E \fIencoding\fR] [\-Q \fIrepo path\fR] [\-S \fIserver url\fR] [\-o \fIlogfile\fR] [\-x \fIpassword\fR] [\-\-ssl\-key=\fIssl key\fR]
-.
-.SH "DESCRIPTION"
-\fBbcfg2\-server\fR is the daemon component of Bcfg2 which serves configurations to clients based on the data in its repository\.
-.
-.SH "OPTIONS"
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
.
+.SH SYNOPSIS
+.sp
+\fBbcfg2\-server\fP [\-d] [\-v] [\-C \fIconfigfile\fP] [\-D \fIpidfile\fP] [\-E
+\fIencoding\fP] [\-Q \fIrepo path\fP] [\-S \fIserver url\fP] [\-o \fIlogfile\fP] [\-x
+\fIpassword\fP] [\-\-ssl\-key=\fIssl key\fP]
+.SH DESCRIPTION
+.sp
+\fBbcfg2\-server\fP is the daemon component of Bcfg2 which serves
+configurations to clients based on the data in its repository.
+.SH OPTIONS
+.INDENT 0.0
.TP
-\fB\-C\fR \fIconfigfile\fR
-Specify alternate bcfg2\.conf location\.
-.
+.BI \-C \ configfile
+Specify alternate bcfg2.conf location.
.TP
-\fB\-D\fR \fIpidfile\fR
-Daemonize, placing the program pid in the specified pidfile\.
-.
+.BI \-D \ pidfile
+Daemonize, placing the program pid in the specified
+pidfile.
.TP
-\fB\-E\fR \fIencoding\fR
-Specify alternate encoding (default is UTF\-8)\.
-.
+.BI \-E \ encoding
+Specify the encoding of config files.
.TP
-\fB\-Q\fR \fIrepo path\fR
-Set repository path\.
-.
+.BI \-Q \ path
+Specify the path to the server repository.
.TP
-\fB\-S\fR \fIserver url\fR
-Set server address\.
-.
+.BI \-S \ server
+Manually specify the server location (as opposed to
+using the value in bcfg2.conf). This should be in
+the format "\fI\%https://server:port\fP"
.TP
-\fB\-d\fR
-Run \fBbcfg2\-server\fR in debug mode\.
-.
+.B \-d
+Enable debugging output.
.TP
-\fB\-v\fR
-Run \fBbcfg2\-server\fR in verbose mode\.
-.
+.B \-v
+Run in verbose mode.
+.TP
+.B \-h
+Print usage information.
.TP
-\fB\-\-ssl\-key=\fR\fIssl key\fR
-Set path to SSL key\.
+.BI \-\-ssl\-key\fB= key
+Specify the path to the SSL key.
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIbcfg2(1)\fP, \fIbcfg2\-lint(8)\fP
+.SH COPYRIGHT
+2009-2012, Narayan Desai
+.\" Generated by docutils manpage writer.
+.\"
.
-.SH "SEE ALSO"
-bcfg2(1), bcfg2\-lint(8)
diff --git a/man/bcfg2.1 b/man/bcfg2.1
index 231155797..af6faa609 100644
--- a/man/bcfg2.1
+++ b/man/bcfg2.1
@@ -1,175 +1,212 @@
-.
-.TH "BCFG2" "1" "September 2012" "" ""
-.
-.SH "NAME"
-\fBbcfg2\fR \- Bcfg2 client tool
-.
-.SH "SYNOPSIS"
-\fBbcfg2\fR [\fIoptions\fR][\fI\.\.\.\fR]
-.
-.SH "DESCRIPTION"
-\fBbcfg2\fR runs the Bcfg2 configuration process on the current host\. This process consists of the following steps\.
-.
-.IP "\(bu" 4
+.TH "BCFG2" "1" "November 07, 2012" "1.3" "Bcfg2"
+.SH NAME
+bcfg2 \- Bcfg2 client tool
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
+.SH SYNOPSIS
+.sp
+\fBbcfg2\fP [\fIoptions\fP]
+.SH DESCRIPTION
+.sp
+\fBbcfg2\fP runs the Bcfg2 configuration process on the current
+host. This process consists of the following steps.
+.INDENT 0.0
+.IP \(bu 2
Fetch and execute probes
-.
-.IP "\(bu" 4
+.IP \(bu 2
Upload probe results
-.
-.IP "\(bu" 4
+.IP \(bu 2
Fetch the client configuration
-.
-.IP "\(bu" 4
+.IP \(bu 2
Check the current client state
-.
-.IP "\(bu" 4
+.IP \(bu 2
Attempt to install the desired configuration
-.
-.IP "\(bu" 4
+.IP \(bu 2
Upload statistics about the Bcfg2 execution and client state
+.UNINDENT
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.B \-B
+Configure everything except the given bundle(s).
+.TP
+.BI \-C \ configfile
+Specify alternate bcfg2.conf location.
+.TP
+.BI \-D \ drivers
+Specify a comma\-delimited set of Bcfg2 tool
+drivers. \fINOTE: only drivers listed will be
+loaded. (e.g., if you do not include POSIX, you will
+be unable to verify/install Path entries).\fP
+.TP
+.BI \-E \ encoding
+Specify the encoding of config files.
+.TP
+.B \-I
+Run bcfg2 in interactive mode. The user will be
+prompted before each change.
+.TP
+.B \-O
+Omit lock check.
+.TP
+.B \-P
+Run bcfg2 in paranoid mode. Diffs will be logged for
+configuration files marked as paranoid by the Bcfg2
+server.
+.TP
+.B \-Q
+Run bcfg2 in "bundle quick" mode, where only entries
+in a bundle are verified or installed. This runs
+much faster than \-q, but doesn\(aqt provide statistics
+to the server at all. In order for this option to
+work, the \-b option must also be provided. This
+option is incompatible with \-r.
+.TP
+.BI \-R \ retrycount
+Specify the number of times that the client will
+attempt to retry network communication.
+.TP
+.BI \-S \ server
+Manually specify the server location (as opposed to
+using the value in bcfg2.conf). This should be in
+the format "\fI\%https://server:port\fP"
+.TP
+.B \-Z
+Do not configure independent entries.
+.TP
+.BI \-b \ bundles
+Run only the specified colon\-delimited set of
+bundles.
+.TP
+.BI \-c \ cachefile
+Cache a copy of the configuration in cachefile.
+.TP
+.BI \-\-ca\-cert\fB= cacert
+Specifiy the path to the SSL CA certificate.
+.TP
+.B \-d
+Enable debugging output.
+.TP
+.B \-e
+When in verbose mode, display extra entry
+information.
+.TP
+.BI \-f \ path
+Configure from a file rather than querying the
+server.
+.TP
+.B \-h
+Print usage information.
+.TP
+.B \-k
+Run in bulletproof mode. This currently only
+affects behavior in the debian toolset; it calls
+apt\-get update and clean and dpkg \-\-configure
+\-\-pending.
+.TP
+.BI \-l \ decisionmode
+Run the client in the specified decision list mode
+("whitelist" or "blacklist"), or "none", which can
+be used in order to override the decision list mode
+specified in bcfg2.conf). This approach is needed
+when particular changes are deemed "high risk". It
+gives the ability tocentrally specify these changes,
+but only install them on clients when administrator
+supervision is available. Because collaborative
+configuration is one of the remaining hard issues in
+configuration management, these issues typically
+crop up in environments with several administrators
+and much configuration variety. (This setting will
+be ignored if the \-f option is also specified).
+.TP
+.B \-n
+Run bcfg2 in dry\-run mode. No changes will be made
+to the system.
+.TP
+.BI \-o \ logfile
+Writes a log to the specified path.
+.TP
+.BI \-p \ profile
+Assert a profile for the current client.
+.TP
+.B \-q
+Run bcfg2 in quick mode. Package checksum
+verification won\(aqt be performed. This mode relaxes
+the constraints of correctness, and thus should only
+be used in safe conditions.
+.TP
+.BI \-r \ mode
+Cause bcfg2 to remove extra configuration elements
+it detects. Mode is one of "all", "Services", or
+"Packages". "all" removes all entries. Likewise,
+"Services" and "Packages" remove only the extra
+configuration elements of the respective type.
+.TP
+.BI \-s \ servicemode
+Set bcfg2 interaction level for services. Default
+behavior is to modify all services affected by
+reconfiguration. "build" mode attempts to stop all
+services started. "disabled" suppresses all attempts
+to modify services.
+.TP
+.BI \-\-ssl\-cert\fB= cert
+Specify the path to the SSL certificate.
+.TP
+.BI \-\-ssl\-cns\fB= CNs
+Colon\-delimited list of acceptable SSL server Common
+Names.
+.TP
+.BI \-\-ssl\-key\fB= key
+Specify the path to the SSL key.
+.TP
+.BI \-u \ user
+Attempt to authenticate as \(aquser\(aq.
+.TP
+.BI \-t \ timeout
+Set the timeout (in seconds) for client
+communication. Default is 90 seconds.
+.TP
+.B \-v
+Run bcfg2 in verbose mode.
+.TP
+.BI \-x \ password
+Use \(aqpassword\(aq for client communication.
+.TP
+.B \-z
+Only configure independent entries, ignore bundles.
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIbcfg2\-server(8)\fP, \fIbcfg2\-info(8)\fP
+.SH COPYRIGHT
+2009-2012, Narayan Desai
+.\" Generated by docutils manpage writer.
+.\"
.
-.IP "" 0
-.
-.SH "OPTIONS"
-.
-.TP
-\fB\-B\fR
-Configure everything except the given bundle(s)\.
-.
-.TP
-\fB\-C\fR \fIconfigfile\fR
-Specify alternate bcfg2\.conf location\.
-.
-.TP
-\fB\-D\fR [\fIdriver1\fR,\fIdriver2\fR]
-Specify a set of Bcfg2 tool drivers\.
-.
-.IP
-\fINOTE: only drivers listed will be loaded\. (e\.g\., if you do not include POSIX, you will be unable to verify/install Path entries)\.\fR
-.
-.TP
-\fB\-E\fR \fIencoding\fR
-Specify the encoding of Cfg files\.
-.
-.TP
-\fB\-I\fR
-Run bcfg2 in interactive mode\. The user will be prompted before each change\.
-.
-.TP
-\fB\-O\fR
-Omit lock check\.
-.
-.TP
-\fB\-P\fR
-Run bcfg2 in paranoid mode\. Diffs will be logged for configuration files marked as paranoid by the Bcfg2 server\.
-.
-.TP
-\fB\-R\fR \fIretry count\fR
-Specify the number of times that the client will attempt to retry network communication\.
-.
-.TP
-\fB\-S\fR \fIhttps://server:port\fR
-Manually specify the server location (as opposed to using the value in bcfg2\.conf)\.
-.
-.TP
-\fB\-Z\fR
-Do not configure independent entries\.
-.
-.TP
-\fB\-b\fR [\fIbundle1:bundle2\fR]
-Run bcfg2 against one or multiple bundles in the configuration\.
-.
-.TP
-\fB\-c\fR \fIcachefile\fR
-Cache a copy of the configuration in cachefile\.
-.
-.TP
-\fB\-\-ca\-cert=\fR\fIca cert\fR
-Specifiy the path to the SSL CA certificate\.
-.
-.TP
-\fB\-d\fR
-Run bcfg2 in debug mode\.
-.
-.TP
-\fB\-e\fR
-When in verbose mode, display extra entry information (temporary until verbosity rework)\.
-.
-.TP
-\fB\-f\fR \fIspecification path\fR
-Configure from a file rather than querying the server\.
-.
-.TP
-\fB\-h\fR
-Print Usage information\.
-.
-.TP
-\fB\-k\fR
-Run in bulletproof mode\. This currently only affects behavior in the debian toolset; it calls apt\-get update and clean and dpkg \-\-configure \-\-pending\.
-.
-.TP
-\fB\-l\fR \fIwhitelist|blacklist|none\fR
-Run the client in the server decision list mode (unless "none" is specified, which can be done in order to override the decision list mode specified in bcfg2\.conf)\. This approach is needed when particular changes are deemed "high risk"\. It gives the ability to centrally specify these changes, but only install them on clients when administrator supervision is available\. Because collaborative configuration is one of the remaining hard issues in configuration management, these issues typically crop up in environments with several administrators and much configuration variety\. (This setting will be ignored if the \-f option is also specified)\.
-.
-.TP
-\fB\-n\fR
-Run bcfg2 in dry\-run mode\. No changes will be made to the system\.
-.
-.TP
-\fB\-o\fR \fIlogfile path\fR
-Writes a log to the specified path\.
-.
-.TP
-\fB\-p\fR \fIprofile\fR
-Assert a profile for the current client\.
-.
-.TP
-\fB\-q\fR
-Run bcfg2 in quick mode\. Package checksum verification won’t be performed\. This mode relaxes the constraints of correctness, and thus should only be used in safe conditions\.
-.
-.TP
-\fB\-Q\fR
-Run bcfg2 in "bundle quick" mode, where only entries in a bundle are verified or installed\. This runs much faster than \-q, but doesn’t provide statistics to the server at all\. In order for this option to work, the \-b option must also be provided\. This option is incompatible with \-r\.
-.
-.TP
-\fB\-r\fR \fImode\fR
-Cause bcfg2 to remove extra configuration elements it detects\. Mode is one of all, Services, or Packages\. All removes all entries\. Likewise, Services and Packages remove only the extra configuration elements of the respective type\.
-.
-.TP
-\fB\-s\fR \fIservice mode\fR
-Set bcfg2 interaction level for services\. Default behavior is to modify all services affected by reconfiguration\. build mode attempts to stop all services started\. disabled suppresses all attempts to modify services\.
-.
-.TP
-\fB\-\-ssl\-cert=\fR\fIssl cert\fR
-Specifiy the path to the SSL certificate\.
-.
-.TP
-\fB\-\-ssl\-cns=\fR[\fICN1:CN2\fR]
-List of acceptable SSL server Common Names\.
-.
-.TP
-\fB\-\-ssl\-key=\fR\fIssl key\fR
-Specifiy the path to the SSL key\.
-.
-.TP
-\fB\-u\fR \fIuser\fR
-Attempt to authenticate as ’user’\.
-.
-.TP
-\fB\-x\fR \fIpassword\fR
-Use ’password’ for client communication\.
-.
-.TP
-\fB\-t\fR \fItimeout\fR
-Set the timeout (in seconds) for client communication\. Default is 90 seconds\.
-.
-.TP
-\fB\-v\fR
-Run bcfg2 in verbose mode\.
-.
-.TP
-\fB\-z\fR
-Only configure independent entries, ignore bundles\.
-.
-.SH "SEE ALSO"
-bcfg2\-server(8), bcfg2\-info(8)
diff --git a/man/bcfg2.conf.5 b/man/bcfg2.conf.5
index da7022a07..b20eb0156 100644
--- a/man/bcfg2.conf.5
+++ b/man/bcfg2.conf.5
@@ -1,446 +1,735 @@
-.
-.TH "BCFG2\.CONF" "5" "October 2012" "" ""
-.
-.SH "NAME"
-\fBbcfg2\.conf\fR \- configuration parameters for Bcfg2
-.
-.SH "DESCRIPTION"
-\fBbcfg2\.conf\fR includes configuration parameters for the Bcfg2 server and client\.
-.
-.SH "FILE FORMAT"
-The file is INI\-style and consists of sections and options\. A section begins with the name of the sections in square brackets and continues until the next section begins\.
-.
-.P
-Options are specified in the form "name=value"\.
-.
-.P
-The file is line\-based each newline\-terminated line represents either a comment, a section name or an option\.
-.
-.P
-Any line beginning with a hash (#) is ignored, as are lines containing only whitespace\.
-.
-.SH "SERVER OPTIONS"
-These options are only necessary on the Bcfg2 server\. They are specified in the \fB[server]\fR section of the configuration file\.
-.
-.TP
-\fBrepository\fR
-Specifies the path to the Bcfg2 repository containing all of the configuration specifications\. The repository should be created using the \fBbcfg2\-admin init\fR command\.
-.
-.TP
-\fBfilemonitor\fR
-The file monitor used to watch for changes in the repository\. The default is the best available monitor\. The following values are valid:
-.
-.IP
-\fBinotify\fR, \fBgamin\fR, \fBfam\fR, \fBpseudo\fR
-.
-.TP
-\fBignore_files\fR
-A comma\-separated list of globs that should be ignored by the file monitor\. Default values are:
-.
-.IP
-\fB*~\fR, \fB*#\fR, \fB\.#*\fR, \fB*\.swp\fR, \fB\.*\.swx\fR, \fBSCCS\fR, \fB\.svn\fR, \fB4913\fR, \fB\.gitignore\fR
-.
-.TP
-\fBlisten_all\fR
-This setting tells the server to listen on all available interfaces\. The default is to only listen on those interfaces specified by the bcfg2 setting in the components section of \fBbcfg2\.conf\fR\.
-.
-.TP
-\fBplugins\fR
-A comma\-delimited list of enabled server plugins\. Currently available plugins are:
-.
-.IP
-\fBAccount\fR, \fBActions\fR, \fBBase\fR, \fBBundler\fR, \fBBzr\fR, \fBCfg\fR, \fBCvs\fR, \fBDarcs\fR, \fBDBStats\fR, \fBDecisions\fR, \fBDeps\fR, \fBEditor\fR, \fBFossil\fR, \fBGit\fR, \fBGroupPatterns\fR, \fBHg\fR, \fBHostbase\fR, \fBMetadata\fR, \fBNagiosGen\fR, \fBOhai\fR, \fBPackages\fR, \fBPkgmgr\fR, \fBProbes\fR, \fBProperties\fR, \fBRules\fR, \fBSnapshots\fR, \fBSSHbase\fR, \fBSvn\fR, \fBSvn2\fR, \fBTCheetah\fR, \fBTGenshi\fR, \fBTrigger\fR
-.
-.IP
-Descriptions of each plugin can be found in their respective sections below\.
-.
-.TP
-\fBprefix\fR
-Specifies a prefix if the Bcfg2 installation isn’t placed in the default location (e\.g\. /usr/local)\.
-.
-.TP
-\fBbackend\fR
-Specifies which server core backend to use\. Current available options are:
-.
-.IP
-\fBcherrypy\fR, \fBbuiltin\fR, \fBbest\fR
-.
-.IP
-The default is \fBbest\fR, which is currently an alias for \fBbuiltin\fR\. More details on the backends can be found in the official documentation\.
-.
-.TP
-\fBuser\fR
-The username or UID to run the daemon as\. Default is \fB0\fR
-.
-.TP
-\fBgroup\fR
-The group name or GID to run the daemon as\. Default is \fB0\fR
-.
-.SS "Account Plugin"
-The account plugin manages authentication data, including the following\.
-.
-.IP "\(bu" 4
-\fB/etc/passwd\fR
-.
-.IP "\(bu" 4
-\fB/etc/group\fR
-.
-.IP "\(bu" 4
-\fB/etc/security/limits\.conf\fR
-.
-.IP "\(bu" 4
-\fB/etc/sudoers\fR
-.
-.IP "\(bu" 4
-\fB/root/\.ssh/authorized_keys\fR
-.
-.IP "" 0
-.
-.SS "Base Plugin"
-A structure plugin that provides the ability to add lists of unrelated entries into client configuration entry inventories\. Base works much like Bundler in its file format\. This structure plugin is good for the pile of independent configs needed for most actual systems\.
-.
-.SS "Bundler Plugin"
-Bundler is used to describe groups of inter\-dependent configuration entries, such as the combination of packages, configuration files, and service activations that comprise typical Unix daemons\. Bundles are used to add groups of configuration entries to the inventory of client configurations, as opposed to describing particular versions of those entries\.
-.
-.SS "Bzr Plugin"
-The Bzr plugin allows you to track changes to your Bcfg2 repository using a GNU Bazaar version control backend\. Currently, it enables you to get revision information out of your repository for reporting purposes\.
-.
-.SS "Cfg Plugin"
-The Cfg plugin provides a repository to describe configuration file contents for clients\. In its simplest form, the Cfg repository is just a directory tree modeled off of the directory tree on your client machines\.
-.
-.SS "Cvs Plugin (experimental)"
-The Cvs plugin allows you to track changes to your Bcfg2 repository using a Concurrent version control backend\. Currently, it enables you to get revision information out of your repository for reporting purposes\.
-.
-.SS "Darcs Plugin (experimental)"
-The Darcs plugin allows you to track changes to your Bcfg2 repository using a Darcs version control backend\. Currently, it enables you to get revision information out of your repository for reporting purposes\.
-.
-.SS "DBStats Plugin"
-Direct to database statistics plugin\.
-.
-.SS "Decisions Plugin"
-The Decisions plugin has support for a centralized set of per\-entry installation decisions\. This approach is needed when particular changes are deemed "\fIhigh risk\fR"; this gives the ability to centrally specify these changes, but only install them on clients when administrator supervision is available\.
-.
-.SS "Deps Plugin"
-The Deps plugin allows you to make a series of assertions like "Package X requires Package Y (and optionally also Package Z etc\.)"
-.
-.SS "Editor Plugin"
-The Editor plugin attempts to allow you to partially manage configuration for a file\. Its use is not recommended and not well documented\.
-.
-.SS "Fossil Plugin"
-The Fossil plugin allows you to track changes to your Bcfg2 repository using a Fossil SCM version control backend\. Currently, it enables you to get revision information out of your repository for reporting purposes\.
-.
-.SS "Git Plugin"
-The Git plugin allows you to track changes to your Bcfg2 repository using a Git version control backend\. Currently, it enables you to get revision information out of your repository for reporting purposes\.
-.
-.SS "GroupPatterns Plugin"
-The GroupPatterns plugin is a connector that can assign clients group membership based on patterns in client hostnames\.
-.
-.SS "Hg Plugin (experimental)"
-The Hg plugin allows you to track changes to your Bcfg2 repository using a Mercurial version control backend\. Currently, it enables you to get revision information out of your repository for reporting purposes\.
-.
-.SS "Hostbase Plugin"
-The Hostbase plugin is an IP management system built on top of Bcfg2\.
-.
-.SS "Metadata Plugin"
-The Metadata plugin is the primary method of specifying Bcfg2 server metadata\.
-.
-.SS "NagiosGen Plugin"
-NagiosGen is a Bcfg2 plugin that dynamically generates Nagios configuration files based on Bcfg2 data\.
-.
-.SS "Ohai Plugin (experimental)"
-The Ohai plugin is used to detect information about the client operating system\. The data is reported back to the server using JSON\.
-.
-.SS "Packages Plugin"
-The Packages plugin is an alternative to Pkgmgr for specifying package entries for clients\. Where Pkgmgr explicitly specifies package entry information, Packages delegates control of package version information to the underlying package manager, installing the latest version available from through those channels\.
-.
-.SS "Pkgmgr Plugin"
-The Pkgmgr plugin resolves the Abstract Configuration Entity "Package" to a package specification that the client can use to detect, verify and install the specified package\.
-.
-.SS "Probes Plugin"
-The Probes plugin gives you the ability to gather information from a client machine before you generate its configuration\. This information can be used with the various templating systems to generate configuration based on the results\.
-.
-.SS "Properties Plugin"
-The Properties plugin is a connector plugin that adds information from properties files into client metadata instances\.
-.
-.SS "Rules Plugin"
-The Rules plugin provides literal configuration entries that resolve the abstract configuration entries normally found in the Bundler and Base plugins\. The literal entries in Rules are suitable for consumption by the appropriate client drivers\.
-.
-.SS "Snapshots Plugin"
-The Snapshots plugin stores various aspects of a client’s state when the client checks in to the server\.
-.
-.SS "SSHbase Plugin"
-The SSHbase generator plugin manages ssh host keys (both v1 and v2) for hosts\. It also manages the ssh_known_hosts file\. It can integrate host keys from other management domains and similarly export its keys\.
-.
-.SS "Svn Plugin"
-The Svn plugin allows you to track changes to your Bcfg2 repository using a Subversion backend\. Currently, it enables you to get revision information out of your repository for reporting purposes\.
-.
-.SS "Svn2 Plugin"
-The Svn2 plugin extends on the capabilities in the Svn plugin\. It provides Update and Commit methods which provide hooks for modifying subversion\-backed Bcfg2 repositories\.
-.
-.SS "TCheetah Plugin"
-The TCheetah plugin allows you to use the cheetah templating system to create files\. It also allows you to include the results of probes executed on the client in the created files\.
-.
-.SS "TGenshi Plugin"
-The TGenshi plugin allows you to use the Genshi templating system to create files\. It also allows you to include the results of probes executed on the client in the created files\.
-.
-.SS "Trigger Plugin"
-The Trigger plugin provides a method for calling external scripts when clients are configured\.
-.
-.SH "CLIENT OPTIONS"
-These options only affect client functionality, specified in the \fB[client]\fR section\.
-.
-.TP
-\fBdecision\fR
-Specify the server decision list mode (whitelist or blacklist)\. (This settiing will be ignored if the client is called with the \-f option\.)
-.
-.TP
-\fBdrivers\fR
-Specify tool driver set to use\. This option can be used to explicitly specify the client tool drivers you want to use when the client is run\.
-.
-.TP
-\fBparanoid\fR
-Run the client in paranoid mode\.
-.
-.TP
-\fBprofile\fR
-Assert the given profile for the host\.
-.
-.SH "COMMUNICATION OPTIONS"
-Specified in the \fB[communication]\fR section\. These options define settings used for client\-server communication\.
-.
-.TP
-\fBca\fR
-The path to a file containing the CA certificate\. This file is required on the server, and optional on clients\. However, if the cacert is not present on clients, the server cannot be verified\.
-.
-.TP
-\fBcertificate\fR
-The path to a file containing a PEM formatted certificate which signs the key with the ca certificate\. This setting is required on the server in all cases, and required on clients if using client certificates\.
-.
-.TP
-\fBkey\fR
-Specifies the path to a file containing the SSL Key\. This is required on the server in all cases, and required on clients if using client certificates\.
-.
-.TP
-\fBpassword\fR
-Required on both the server and clients\. On the server, sets the password clients need to use to communicate\. On a client, sets the password to use to connect to the server\.
-.
-.TP
-\fBprotocol\fR
-Communication protocol to use\. Defaults to xmlrpc/ssl\.
-.
-.TP
-\fBretries\fR
-A client\-only option\. Number of times to retry network communication\. Default is 3 retries\.
-.
-.TP
-\fBretry_delay\fR
-A client\-only option\. Number of seconds to wait in between retrying network communication\. Default is 1 second\.
-.
-.TP
-\fBserverCommonNames\fR
-A client\-only option\. A colon\-separated list of Common Names the client will accept in the SSL certificate presented by the server\.
-.
-.TP
-\fBtimeout\fR
-A client\-only option\. The network communication timeout\.
-.
-.TP
-\fBuser\fR
-A client\-only option\. The UUID of the client\.
-.
-.SH "COMPONENT OPTIONS"
-Specified in the \fB[components]\fR section\.
-.
-.TP
-\fBbcfg2\fR
-URL of the server\. On the server this specifies which interface and port the server listens on\. On the client, this specifies where the client will attempt to contact the server\.
-.
-.IP
-e\.g\. \fBbcfg2 = https://10\.3\.1\.6:6789\fR
-.
-.TP
-\fBencoding\fR
-Text encoding of configuration files\. Defaults to UTF\-8\.
-.
-.TP
-\fBlockfile\fR
-The path to the client lock file, which is used to ensure that only one Bcfg2 client runs at a time on a single client\.
-.
-.SH "LOGGING OPTIONS"
-Specified in the \fB[logging]\fR section\. These options control the server logging functionality\.
-.
-.TP
-\fBdebug\fR
-Whether or not to enable debug\-level log output\. Default is false\.
-.
-.TP
-\fBpath\fR
-Server log file path\.
-.
-.TP
-\fBsyslog\fR
-Whether or not to send logging data to syslog\. Default is true\.
-.
-.TP
-\fBverbose\fR
-Whether or not to enable verbose log output\. Default is false\.
-.
-.SH "MDATA OPTIONS"
-Specified in the \fB[mdata]\fR section\. These options affect the default metadata settings for Paths with type=’file’\.
-.
-.TP
-\fBowner\fR
+.TH "BCFG2.CONF" "5" "November 07, 2012" "1.3" "Bcfg2"
+.SH NAME
+bcfg2.conf \- Configuration parameters for Bcfg2
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
+.SH DESCRIPTION
+.sp
+bcfg2.conf includes configuration parameters for the Bcfg2 server and
+client.
+.SH FILE FORMAT
+.sp
+The file is INI\-style and consists of sections and options. A section
+begins with the name of the sections in square brackets and continues
+until the next section begins.
+.sp
+Options are specified in the form "name=value".
+.sp
+The file is line\-based each newline\-terminated line represents either a
+comment, a section name or an option.
+.sp
+Any line beginning with a hash (#) is ignored, as are lines containing
+only whitespace.
+.SH SERVER OPTIONS
+.sp
+These options are only necessary on the Bcfg2 server. They are specified
+in the \fB[server]\fP section of the configuration file.
+.INDENT 0.0
+.TP
+.B repository
+Specifies the path to the Bcfg2 repository containing all of the
+configuration specifications. The repository should be created using
+the \fIbcfg2\-admin init\fP command.
+.TP
+.B filemonitor
+The file monitor used to watch for changes in the repository. The
+default is the best available monitor. The following values are
+valid:
+.sp
+.nf
+.ft C
+inotify
+gamin
+fam
+pseudo
+.ft P
+.fi
+.TP
+.B ignore_files
+A comma\-separated list of globs that should be ignored by the file
+monitor. Default values are:
+.sp
+.nf
+.ft C
+*~
+*#
+#*
+*.swp
+*.swpx
+*.swx
+SCCS
+\&.svn
+4913
+\&.gitignore
+.ft P
+.fi
+.TP
+.B listen_all
+This setting tells the server to listen on all available interfaces.
+The default is to only listen on those interfaces specified by the
+bcfg2 setting in the components section of \fBbcfg2.conf\fP.
+.TP
+.B plugins
+A comma\-delimited list of enabled server plugins. Currently
+available plugins are:
+.sp
+.nf
+.ft C
+Account
+Base
+Bundler
+Bzr
+Cfg
+Cvs
+Darcs
+DBStats
+Decisions
+Deps
+Editor
+FileProbes
+Fossil
+Git
+GroupPatterns
+Guppy
+Hg
+Hostbase
+Ldap
+Metadata
+NagiosGen
+Ohai
+Packages
+Pkgmgr
+POSIXCompat
+Probes
+Properties
+PuppetENC
+Reporting
+Rules
+SEModules
+ServiceCompat
+Snapshots
+SSHbase
+SSLCA
+Statistics
+Svn
+TCheetah
+TemplateHelper
+TGenshi
+Trigger
+.ft P
+.fi
+.sp
+Descriptions of each plugin can be found in their respective
+sections below.
+.TP
+.B prefix
+Specifies a prefix if the Bcfg2 installation isn\(aqt placed in the
+default location (e.g. \fB/usr/local\fP).
+.TP
+.B backend
+Specifies which server core backend to use. Current available
+options are:
+.sp
+.nf
+.ft C
+cherrypy
+builtin
+best
+.ft P
+.fi
+.sp
+The default is \fIbest\fP, which is currently an alias for \fIbuiltin\fP.
+More details on the backends can be found in the official
+documentation.
+.TP
+.B user
+The username or UID to run the daemon as. Default is \fI0\fP.
+.TP
+.B group
+The group name or GID to run the daemon as. Default is \fI0\fP.
+.TP
+.B vcs_root
+Specifies the path to the root of the VCS working copy that holds
+your Bcfg2 specification, if it is different from \fIrepository\fP.
+E.g., if the VCS repository does not hold the bcfg2 data at the top
+level, you may need to set this option.
+.UNINDENT
+.SH SERVER PLUGINS
+.sp
+This section has a listing of all the plugins currently provided with
+Bcfg2.
+.SS Account Plugin
+.sp
+The account plugin manages authentication data, including the following.
+.INDENT 0.0
+.IP \(bu 2
+\fB/etc/passwd\fP
+.IP \(bu 2
+\fB/etc/group\fP
+.IP \(bu 2
+\fB/etc/security/limits.conf\fP
+.IP \(bu 2
+\fB/etc/sudoers\fP
+.IP \(bu 2
+\fB/root/.ssh/authorized_keys\fP
+.UNINDENT
+.SS Base Plugin
+.sp
+The Base plugin is a structure plugin that provides the ability
+to add lists of unrelated entries into client configuration entry
+inventories. Base works much like Bundler in its file format. This
+structure plugin is good for the pile of independent configs needed for
+most actual systems.
+.SS Bundler Plugin
+.sp
+The Bundler plugin is used to describe groups of inter\-dependent
+configuration entries, such as the combination of packages, configuration
+files, and service activations that comprise typical Unix daemons. Bundles
+are used to add groups of configuration entries to the inventory of
+client configurations, as opposed to describing particular versions of
+those entries.
+.SS Bzr Plugin
+.sp
+The Bzr plugin allows you to track changes to your Bcfg2 repository
+using a GNU Bazaar version control backend. Currently, it enables you to
+get revision information out of your repository for reporting purposes.
+.SS Cfg Plugin
+.sp
+The Cfg plugin provides a repository to describe configuration file
+contents for clients. In its simplest form, the Cfg repository is just a
+directory tree modeled off of the directory tree on your client
+machines.
+.SS Cvs Plugin (experimental)
+.sp
+The Cvs plugin allows you to track changes to your Bcfg2 repository
+using a Concurrent version control backend. Currently, it enables you to
+get revision information out of your repository for reporting purposes.
+.SS Darcs Plugin (experimental)
+.sp
+The Darcs plugin allows you to track changes to your Bcfg2 repository
+using a Darcs version control backend. Currently, it enables you to get
+revision information out of your repository for reporting purposes.
+.SS DBStats Plugin
+.sp
+Direct to database statistics plugin.
+.SS Decisions Plugin
+.sp
+The Decisions plugin has support for a centralized set of per\-entry
+installation decisions. This approach is needed when particular changes
+are deemed "\fIhigh risk\fP"; this gives the ability to centrally specify
+these changes, but only install them on clients when administrator
+supervision is available.
+.SS Defaults Plugin
+.sp
+The Defaults plugin can be used to populate default attributes for
+entries. Defaults is \fInot\fP a Generator plugin, so it does not actually
+bind an entry; Defaults are applied after an entry has been bound,
+and only populate attributes that are not yet set.
+.SS Deps Plugin
+.sp
+The Deps plugin allows you to make a series of assertions like "Package
+X requires Package Y (and optionally also Package Z etc.)"
+.SS Editor Plugin
+.sp
+The Editor plugin attempts to allow you to partially manage
+configuration for a file. Its use is not recommended and not well
+documented.
+.SS FileProbes Plugin
+.sp
+The FileProbes plugin allows you to probe a client for a file, which is
+then added to the Cfg specification. If the file changes on the client,
+FileProbes can either update it in the specification or allow Cfg to
+replace it.
+.SS Fossil Plugin
+.sp
+The Fossil plugin allows you to track changes to your Bcfg2 repository
+using a Fossil SCM version control backend. Currently, it enables you to
+get revision information out of your repository for reporting purposes.
+.SS Git Plugin
+.sp
+The Git plugin allows you to track changes to your Bcfg2 repository
+using a Git version control backend. Currently, it enables you to get
+revision information out of your repository for reporting purposes.
+.SS GroupPatterns Plugin
+.sp
+The GroupPatterns plugin is a connector that can assign clients group
+membership based on patterns in client hostnames.
+.SS Guppy Plugin
+.sp
+The Guppy plugin is used to trace memory leaks within the bcfg2\-server
+process using Guppy.
+.SS Hg Plugin (experimental)
+.sp
+The Hg plugin allows you to track changes to your Bcfg2 repository using
+a Mercurial version control backend. Currently, it enables you to get
+revision information out of your repository for reporting purposes.
+.SS Hostbase Plugin
+.sp
+The Hostbase plugin is an IP management system built on top of Bcfg2.
+.SS Ldap Plugin
+.sp
+The Ldap plugin makes it possible to fetch data from an LDAP directory,
+process it and attach it to your metadata.
+.SS Metadata Plugin
+.sp
+The Metadata plugin is the primary method of specifying Bcfg2 server
+metadata.
+.SS NagiosGen Plugin
+.sp
+The NagiosGen plugin dynamically generates Nagios configuration files
+based on Bcfg2 data.
+.SS Ohai Plugin (experimental)
+.sp
+The Ohai plugin is used to detect information about the client operating
+system. The data is reported back to the server using JSON.
+.SS Packages Plugin
+.sp
+The Packages plugin is an alternative to Pkgmgr for specifying package
+entries for clients. Where Pkgmgr explicitly specifies package entry
+information, Packages delegates control of package version information
+to the underlying package manager, installing the latest version
+available from through those channels.
+.SS Pkgmgr Plugin
+.sp
+The Pkgmgr plugin resolves the Abstract Configuration Entity "Package"
+to a package specification that the client can use to detect, verify and
+install the specified package.
+.SS POSIXCompat Plugin
+.sp
+The POSIXCompat plugin provides a compatibility layer for 1.3 POSIX
+Entries so that they are compatible with older clients.
+.SS Probes Plugin
+.sp
+The Probes plugin gives you the ability to gather information from a
+client machine before you generate its configuration. This information
+can be used with the various templating systems to generate
+configuration based on the results.
+.SS Properties Plugin
+.sp
+The Properties plugin is a connector plugin that adds information from
+properties files into client metadata instances.
+.SS PuppetENC Plugin
+.sp
+The PuppetENC plugin is a connector plugin that adds support for Puppet
+External Node Classifiers.
+.SS Reporting Plugin
+.sp
+The Reporting plugin enables the collection of data for use with Bcfg2\(aqs
+dynamic reporting system.
+.SS Rules Plugin
+.sp
+The Rules plugin provides literal configuration entries that resolve the
+abstract configuration entries normally found in the Bundler and Base
+plugins. The literal entries in Rules are suitable for consumption by
+the appropriate client drivers.
+.SS SEModules Plugin
+.sp
+The SEModules plugin provides a way to distribute SELinux modules via
+Bcfg2.
+.SS ServiceCompat Plugin
+.sp
+The ServiceCompat plugin converts service entries for older clients.
+.SS Snapshots Plugin
+.sp
+The Snapshots plugin stores various aspects of a client’s state when the
+client checks in to the server.
+.SS SSHbase Plugin
+.sp
+The SSHbase generator plugin manages ssh host keys (both v1 and v2) for
+hosts. It also manages the ssh_known_hosts file. It can integrate host
+keys from other management domains and similarly export its keys.
+.SS SSLCA Plugin
+.sp
+The SSLCA plugin is designed to handle creation of SSL privatekeys and
+certificates on request.
+.SS Statistics
+.sp
+The Statistics plugin is deprecated (see Reporting).
+.SS Svn Plugin
+.sp
+The Svn plugin allows you to track changes to your Bcfg2 repository
+using a Subversion backend. Currently, it enables you to get revision
+information out of your repository for reporting purposes.
+.SS TCheetah Plugin
+.sp
+The TCheetah plugin allows you to use the cheetah templating system to
+create files. It also allows you to include the results of probes
+executed on the client in the created files.
+.SS TGenshi Plugin
+.sp
+The TGenshi plugin allows you to use the Genshi templating system to
+create files. It also allows you to include the results of probes
+executed on the client in the created files.
+.SS Trigger Plugin
+.sp
+The Trigger plugin provides a method for calling external scripts when
+clients are configured.
+.SH CLIENT OPTIONS
+.sp
+These options only affect client functionality. They can be specified in
+the \fB[client]\fP section.
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B decision
+Specify the server decision list mode (whitelist or blacklist).
+(This settiing will be ignored if the client is called with the
+\-f option).
+.TP
+.B drivers
+Specify tool driver set to use. This option can be used to
+explicitly specify the client tool drivers you want to use when
+the client is run.
+.TP
+.B paranoid
+Run the client in paranoid mode.
+.TP
+.B profile
+Assert the given profile for the host.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SH COMMUNICATION OPTIONS
+.sp
+Specified in the \fB[communication]\fP section. These options define
+settings used for client\-server communication.
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B ca
+The path to a file containing the CA certificate. This file is
+required on the server, and optional on clients. However, if the
+cacert is not present on clients, the server cannot be verified.
+.TP
+.B certificate
+The path to a file containing a PEM formatted certificate which
+signs the key with the ca certificate. This setting is required
+on the server in all cases, and required on clients if using
+client certificates.
+.TP
+.B key
+Specifies the path to a file containing the SSL Key. This is
+required on the server in all cases, and required on clients if
+using client certificates.
+.TP
+.B password
+Required on both the server and clients. On the server, sets
+the password clients need to use to communicate. On a client,
+sets the password to use to connect to the server.
+.TP
+.B protocol
+Communication protocol to use. Defaults to xmlrpc/ssl.
+.TP
+.B retries
+A client\-only option. Number of times to retry network
+communication. Default is 3 retries.
+.TP
+.B retry_delay
+A client\-only option. Number of seconds to wait in between
+retrying network communication. Default is 1 second.
+.TP
+.B serverCommonNames
+A client\-only option. A colon\-separated list of Common Names the
+client will accept in the SSL certificate presented by the server.
+.TP
+.B timeout
+A client\-only option. The network communication timeout.
+.TP
+.B user
+A client\-only option. The UUID of the client.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SH COMPONENT OPTIONS
+.sp
+Specified in the \fB[components]\fP section.
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B bcfg2
+URL of the server. On the server this specifies which interface
+and port the server listens on. On the client, this specifies
+where the client will attempt to contact the server.
+.sp
+e.g. \fIbcfg2 = https://10.3.1.6:6789\fP
+.TP
+.B encoding
+Text encoding of configuration files. Defaults to UTF\-8.
+.TP
+.B lockfile
+The path to the client lock file, which is used to ensure that
+only one Bcfg2 client runs at a time on a single client.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SH LOGGING OPTIONS
+.sp
+Specified in the \fB[logging]\fP section. These options control the server
+logging functionality.
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B debug
+Whether or not to enable debug\-level log output. Default is false.
+.TP
+.B path
+Server log file path.
+.TP
+.B syslog
+Whether or not to send logging data to syslog. Default is true.
+.TP
+.B verbose
+Whether or not to enable verbose log output. Default is false.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SH MDATA OPTIONS
+.sp
+Specified in the \fB[mdata]\fP section. These options affect the default
+metadata settings for Paths with type=\(aqfile\(aq.
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B owner
Global owner for Paths (defaults to root)
-.
.TP
-\fBgroup\fR
+.B group
Global group for Paths (defaults to root)
-.
.TP
-\fBmode\fR
+.B mode
Global permissions for Paths (defaults to 644)
-.
.TP
-\fBsecontext\fR
-Global SELinux context for Path entries (defaults to \fB__default__\fR, which restores the expected context)
-.
+.B secontext
+Global SELinux context for Path entries (defaults to
+\fI__default__\fP, which restores the expected context)
.TP
-\fBparanoid\fR
+.B paranoid
Global paranoid settings for Paths (defaults to false)
-.
.TP
-\fBsensitive\fR
+.B sensitive
Global sensitive settings for Paths (defaults to false)
-.
.TP
-\fBimportant\fR
-Global important settings for Paths\. Defaults to false, and anything else is probably not a good idea\.
-.
-.SH "PACKAGES OPTIONS"
-The following options are specified in the \fB[packages]\fR section of the configuration file\.
-.
-.TP
-\fBresolver\fR
-Enable dependency resolution\. Default is 1 (true)\.
-.
-.TP
-\fBmetadata\fR
-Enable metadata processing\. Default is 1 (true)\. If metadata is disabled, it’s implied that resolver is also disabled\.
-.
-.TP
-\fByum_config\fR
-The path at which to generate Yum configs\. No default\.
-.
-.TP
-\fBapt_config\fR
-The path at which to generate APT configs\. No default\.
-.
-.TP
-\fBgpg_keypath\fR
-The path on the client where RPM GPG keys will be copied before they are imported on the client\. Default is \fB/etc/pki/rpm\-gpg\fR\.
-.
-.TP
-\fBversion\fR
-Set the version attribute used when binding Packages\. Default is auto\.
-.
-.P
-The following options are specified in the \fB[packages:yum]\fR section of the configuration file\.
-.
-.TP
-\fBuse_yum_libraries\fR
-By default, Bcfg2 uses an internal implementation of Yum’s dependency resolution and other routines so that the Bcfg2 server can be run on a host that does not support Yum itself\. If you run the Bcfg2 server on a machine that does have Yum libraries, however, you can enable use of those native libraries in Bcfg2 by setting this to 1\.
-.
-.TP
-\fBhelper\fR
-Path to bcfg2\-yum\-helper\. By default, Bcfg2 looks first in $PATH and then in \fB/usr/sbin/bcfg2\-yum\-helper\fR for the helper\.
-.
-.P
-All other options in the \fB[packages:yum]\fR section will be passed along verbatim to the Yum configuration if you are using the native Yum library support\.
-.
-.P
-The following options are specified in the \fB[packages:pulp]\fR section of the configuration file\.
-.
-.TP
-\fBusername\fR
-The username of a Pulp user that will be used to register new clients and bind them to repositories\.
-.
-.TP
-\fBpassword\fR
-The password of a Pulp user that will be used to register new clients and bind them to repositories\.
-.
-.SH "PARANOID OPTIONS"
-These options allow for finer\-grained control of the paranoid mode on the Bcfg2 client\. They are specified in the \fB[paranoid]\fR section of the configuration file\.
-.
-.TP
-\fBpath\fR
-Custom path for backups created in paranoid mode\. The default is in \fB/var/cache/bcfg2\fR\.
-.
-.TP
-\fBmax_copies\fR
-Specify a maximum number of copies for the server to keep when running in paranoid mode\. Only the most recent versions of these copies will be kept\.
-.
-.SH "SNAPSHOTS OPTIONS"
-Specified in the \fB[snapshots]\fR section\. These options control the server snapshots functionality\.
-.
-.TP
-\fBdriver\fR
+.B important
+Global important settings for Paths. Defaults to false.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SH PACKAGES OPTIONS
+.sp
+The following options are specified in the \fB[packages]\fP section.
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B resolver
+Enable dependency resolution. Default is 1 (true).
+.TP
+.B metadata
+Enable metadata processing. Default is 1 (true). If metadata is
+disabled, it’s implied that resolver is also disabled.
+.TP
+.B yum_config
+The path at which to generate Yum configs. No default.
+.TP
+.B apt_config
+The path at which to generate APT configs. No default.
+.TP
+.B gpg_keypath
+The path on the client where RPM GPG keys will be copied before
+they are imported on the client. Default is \fB/etc/pki/rpm\-gpg\fP.
+.TP
+.B version
+Set the version attribute used when binding Packages. Default is
+auto.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+The following options are specified in the \fB[packages:yum]\fP section.
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B use_yum_libraries
+By default, Bcfg2 uses an internal implementation of Yum’s
+dependency resolution and other routines so that the Bcfg2 server
+can be run on a host that does not support Yum itself. If you
+run the Bcfg2 server on a machine that does have Yum libraries,
+however, you can enable use of those native libraries in Bcfg2
+by setting this to 1.
+.TP
+.B helper
+Path to bcfg2\-yum\-helper. By default, Bcfg2 looks first in $PATH
+and then in \fB/usr/sbin/bcfg2\-yum\-helper\fP for the helper.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+The following options are specified in the \fB[packages:pulp]\fP section.
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B username
+The username of a Pulp user that will be used to register new
+clients and bind them to repositories.
+.TP
+.B password
+The password of a Pulp user that will be used to register new
+clients and bind them to repositories.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+All other options in the \fB[packages:yum]\fP section will be passed along
+verbatim to the Yum configuration if you are using the native Yum
+library support.
+.SH PARANOID OPTIONS
+.sp
+These options allow for finer\-grained control of the paranoid mode on
+the Bcfg2 client. They are specified in the \fB[paranoid]\fP section of
+the configuration file.
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B path
+Custom path for backups created in paranoid mode. The default is
+in \fB/var/cache/bcfg2\fP.
+.TP
+.B max_copies
+Specify a maximum number of copies for the server to keep when
+running in paranoid mode. Only the most recent versions of these
+copies will be kept.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SH SNAPSHOTS OPTIONS
+.sp
+Specified in the \fB[snapshots]\fP section. These options control the
+server snapshots functionality.
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B driver
sqlite
-.
-.TP
-\fBdatabase\fR
-The name of the database to use for statistics data\.
-.
-.IP
-eg: \fB$REPOSITORY_DIR/etc/bcfg2\.sqlite\fR
-.
-.SH "SSLCA OPTIONS"
-These options are necessary to configure the SSLCA plugin and can be found in the \fB[sslca_default]\fR section of the configuration file\.
-.
-.TP
-\fBconfig\fR
-Specifies the location of the openssl configuration file for your CA\.
-.
-.TP
-\fBpassphrase\fR
-Specifies the passphrase for the CA’s private key (if necessary)\. If no passphrase exists, it is assumed that the private key is stored unencrypted\.
-.
-.TP
-\fBchaincert\fR
-Specifies the location of your ssl chaining certificate\. This is used when pre\-existing certifcate hostfiles are found, so that they can be validated and only regenerated if they no longer meet the specification\. If you’re using a self signing CA this would be the CA cert that you generated\.
-.
-.SH "DATABASE OPTIONS"
-Server\-only, specified in the \fB[database]\fR section\. These options control the database connection of the server\.
-.
-.TP
-\fBengine\fR
-The database engine used by the statistics module\. One of the following:
-.
-.IP
-\fBpostgresql\fR, \fBmysql\fR, \fBsqlite3\fR, \fBado_mssql\fR
-.
-.TP
-\fBname\fR
-The name of the database to use for statistics data\. If ‘database_engine’ is set to ‘sqlite3’ this is a file path to sqlite file and defaults to \fB$REPOSITORY_DIR/etc/brpt\.sqlite\fR\.
-.
-.TP
-\fBuser\fR
-User for database connections\. Not used for sqlite3\.
-.
-.TP
-\fBpassword\fR
-Password for database connections\. Not used for sqlite3\.
-.
-.TP
-\fBhost\fR
-Host for database connections\. Not used for sqlite3\.
-.
-.TP
-\fBport\fR
-Port for database connections\. Not used for sqlite3\.
-.
.TP
-\fBtime_zone\fR
-Specify a time zone other than that used on the system\. (Note that this will cause the Bcfg2 server to log messages in this time zone as well)\.
+.B database
+The name of the database to use for statistics data.
+.sp
+e.g.: \fB$REPOSITORY_DIR/etc/bcfg2.sqlite\fP
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SH SSLCA OPTIONS
+.sp
+These options are necessary to configure the SSLCA plugin and can be
+found in the \fB[sslca_default]\fP section of the configuration file.
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B config
+Specifies the location of the openssl configuration file for
+your CA.
+.TP
+.B passphrase
+Specifies the passphrase for the CA’s private key (if
+necessary). If no passphrase exists, it is assumed that the
+private key is stored unencrypted.
+.TP
+.B chaincert
+Specifies the location of your ssl chaining certificate. This is
+used when pre\-existing certifcate hostfiles are found, so that
+they can be validated and only regenerated if they no longer
+meet the specification. If you’re using a self signing CA this
+would be the CA cert that you generated.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SH DATABASE OPTIONS
+.sp
+Server\-only, specified in the \fB[database]\fP section. These options
+control the database connection of the server.
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B engine
+The database engine used by the statistics module. One of the
+following:
+.sp
+.nf
+.ft C
+postgresql
+mysql
+sqlite3
+ado_mssql
+.ft P
+.fi
+.TP
+.B name
+The name of the database to use for statistics data. If
+\(aqdatabase_engine\(aq is set to \(aqsqlite3\(aq this is a file path to
+the sqlite file and defaults to \fB$REPOSITORY_DIR/etc/brpt.sqlite\fP.
+.TP
+.B user
+User for database connections. Not used for sqlite3.
+.TP
+.B password
+Password for database connections. Not used for sqlite3.
+.TP
+.B host
+Host for database connections. Not used for sqlite3.
+.TP
+.B port
+Port for database connections. Not used for sqlite3.
+.TP
+.B time_zone
+Specify a time zone other than that used on the system. (Note
+that this will cause the Bcfg2 server to log messages in this
+time zone as well).
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIbcfg2(1)\fP, \fIbcfg2\-server(8)\fP
+.SH COPYRIGHT
+2009-2012, Narayan Desai
+.\" Generated by docutils manpage writer.
+.\"
.
-.SH "SEE ALSO"
-bcfg2(1), bcfg2\-server(8)