From a732f8499e1b21df4704d2d8b046c0c7dcc4f7a3 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Wed, 7 Nov 2012 13:34:35 -0500 Subject: doc: made format of man page option lists consistent --- man/bcfg2-admin.8 | 471 +++++++++++++++++++++++++++--------------------------- 1 file changed, 233 insertions(+), 238 deletions(-) (limited to 'man/bcfg2-admin.8') 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 \ +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) -- cgit v1.2.3-1-g7c22