man: Clean up man pages

Created new rst files with man page information so that generating man
pages is easier and more consistent throughout bcfg2.

Signed-off-by: Sol Jerome <sol.jerome@gmail.com>

1 files changed, 208 insertions, 214 deletions

diff --git a/man/bcfg2-admin.8 b/man/bcfg2-admin.8
index 6607344d8..a863151d4 100644
--- a/man/bcfg2-admin.8
+++ b/man/bcfg2-admin.8
@@ -1,214 +1,208 @@
-.TH "bcfg2-admin" 8
-.SH NAME
-bcfg2-admin \- Perform repository administration tasks
-.SH SYNOPSIS
-.B bcfg2-admin
-.I [-C config-file]
-.I <mode>
-.I <mode args>
-.I <mode options>
-.SH DESCRIPTION
-.PP
-.B bcfg2-admin
-Perform Bcfg2 repository administration
-.SH OPTIONS
-.PP
-.B \-C <config-file>
-.RS
-Specify the location of the configuration file (if it is not in
-/etc/bcfg2.conf).
-.RE
-.SH MODES
-.PP
-.B init
-.RS
-Initialize a new repository (interactive).
-.RE
-.B backup
-.RS
-Create an archive of the whole Bcfg2 repository.
-.RE
-.B bundle <action>
-.RS
-Display details about the available bundles.
-.RE
-.B client <action> <client> [attribute=value]
-.RS
-Add, edit, or remove clients entries in metadata.
-.RE
-.B query [g=group] [p=profile] [-f output-file] [-n] [-c]
-.RS
-Search for clients based on group or profile.
-.RE
-.B compare <old> <new>
-.RS
-Compare two client configurations. Can be used to verify consistent
-behavior between releases. Determine differences between files or
-directories.
-.RE
-.B minestruct <client> [-f xml-file] [-g groups]
-.RS
-Build structure entries based on client statistics extra entries.
-.RE
-.B pull <client> <entry-type> <entry-name>
-.RS
-Install configuration information into repo based on client bad
-entries.
-.RE
-.B reports [init|load_stats|purge|scrub|update]
-.RS
-Interact with the dynamic reporting system.
-.RE
-.B snapshots [init|dump|query|reports]
-.RS
-Interact with the Snapshots database.
-.RE
-.B tidy
-.RS
-Remove unused files from repository.
-.RE
-.B viz [-H] [-b] [-k] [-o png-file]
-.RS
-Create a graphviz diagram of client, group and bundle information.
-.RE
-.SH BUNDLE OPTIONS
-.PP
-.B mode
-.RS
-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.
-.RE
-.SH CLIENT OPTIONS
-.PP
-.B mode
-.RS
-Add a client 'add', delete a client 'del', or 'list' all client entries.
-.RE
-.B client
-.RS
-Specify the client's name.
-.RE
-.B attribute=value
-.RS
-Set attribute values when adding a new client. Allowed attributes
-are 'profile', 'uuid', 'password', 'location', 'secure', and 'address'.
-.RE
-.SH QUERY OPTIONS
-.PP
-.B g=group
-.RS
-Specify a group to search within.
-.RE
-.B p=profile
-.RS
-Specify a profile to search within.
-.RE
-.B \-f <output-file>
-.RS
-Write the results of the query to a file.
-.RE
-.B \-n
-.RS
-Print the results, one on each line.
-.RE
-.B \-c
-.RS
-Print the results, separated by commas.
-.RE
-.SH COMPARE OPTIONS
-.PP
-.B old
-.RS
-Specify the location of the old configuration file.
-.RE
-.B new
-.RS
-Specify the location of the new configuration file.
-.RE
-.SH MINESTRUCT OPTIONS
-.PP
-.B client
-.RS
-Client whose metadata is to be searched for extra entries.
-.RE
-.B \-g <groups>
-.RS
-Hierarchy of groups in which to place the extra entries in.
-.RE
-.B \-f <xml-output-file>
-.RS
-Specify the xml file in which to write the extra entries.
-.RE
-.SH PULL OPTIONS
-.PP
-.B client
-.RS
-Specify the name of the client to search for.
-.RE
-.B entry-type
-.RS
-Specify the type of the entry to pull.
-.RE
-.B entry-name
-.RS
-Specify the name of the entry to pull.
-.RE
-.SH REPORTS OPTIONS
-.PP
-.B init
-.RS
-Initialize the database.
-.RE
-.B load_stats [-s] [-c] [-03]
-.RS
-Load statistics data.
-.RE
-.B purge [--client [n]] [--days [n]] [--expired]
-.RS
-Purge historic and expired data.
-.RE
-.B scrub
-.RS
-Scrub the database for duplicate reasons and orphaned entries.
-.RE
-.B update
-.RS
-Apply any updates to the reporting database.
-.RE
-.SH SNAPSHOTS OPTIONS
-.PP
-.B init
-.RS
-Initialize the snapshots database.
-.RE
-.B query
-.RS
-Query the snapshots database.
-.RE
-.B dump
-.RS
-Dump some of the contents of the snapshots database.
-.RE
-.B reports [-a] [-b] [-e] [--date=<MM-DD-YYYY>]
-.RS
-Generate reports for clients in the snapshots database.
-.RE
-.SH VIZ OPTIONS
-.PP
-.B \-H
-.RS
-Include hosts in diagram.
-.RE
-.B \-b
-.RS
-Include bundles in diagram.
-.RE
-.B \-o <output file>
-.RS
-Write to outfile file instead of stdout.
-.RE
-.B \-k
-.RS
-Add a shape/color key.
-.RE
+.
+.TH "BCFG2\-ADMIN" "8" "June 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
+.
+.SH "MODES"
+.
+.TP
+\fBinit\fR
+Initialize a new repository (interactive)\.
+.
+.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
+\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
+\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
+\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
+\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
+\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
+\fBtidy\fR
+Remove unused files from repository\.
+.
+.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)\.
+.
+.SS "BUNDLE OPTIONS"
+.
+.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"
+.
+.TP
+\fBmode\fR
+Add a client ’add’, delete a client ’del’, or ’list’ all client entries\.
+.
+.TP
+\fBclient\fR
+Specify the client’s name\.
+.
+.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"
+.
+.TP
+\fBg=group\fR
+Specify a group to search within\.
+.
+.TP
+\fBp=profile\fR
+Specify a profile to search within\.
+.
+.TP
+\fB\-f\fR \fIoutput file\fR
+Write the results of the query to a file\.
+.
+.TP
+\fB\-n\fR
+Print the results, one on each line\.
+.
+.TP
+\fB\-c\fR
+Print the results, separated by commas\.
+.
+.SS "COMPARE OPTIONS"
+.
+.TP
+\fBold\fR
+Specify the location of the old configuration file\.
+.
+.TP
+\fBnew\fR
+Specify the location of the new configuration file\.
+.
+.SS "MINESTRUCT OPTIONS"
+.
+.TP
+\fBclient\fR
+Client whose metadata is to be searched for extra entries\.
+.
+.TP
+\fB\-g\fR \fIgroups\fR
+Hierarchy of groups in which to place the extra entries in\.
+.
+.TP
+\fB\-f\fR \fIxml output file\fR
+Specify the xml file in which to write the extra entries\.
+.
+.SS "PULL OPTIONS"
+.
+.TP
+\fBclient\fR
+Specify the name of the client to search for\.
+.
+.TP
+\fBentry type\fR
+Specify the type of the entry to pull\.
+.
+.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\.
+.
+.TP
+\fB\-k\fR
+Add a shape/color key\.
+.
+.SH "SEE ALSO"
+bcfg2\-info(8), bcfg2\-server(8)