From e9991f9359844113418ed08873fd8ebe2573ca06 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Thu, 9 Aug 2012 13:26:45 -0500 Subject: bcfg2-admin: Add options from 75c6e2a to man page Signed-off-by: Sol Jerome --- man/bcfg2-admin.8 | 66 ++++++++++++++++++++++++++++++++----- tools/manpagegen/bcfg2-admin.8.ronn | 53 ++++++++++++++++++++++++----- 2 files changed, 102 insertions(+), 17 deletions(-) diff --git a/man/bcfg2-admin.8 b/man/bcfg2-admin.8 index 075aad13d..bed51ff9a 100644 --- a/man/bcfg2-admin.8 +++ b/man/bcfg2-admin.8 @@ -1,5 +1,5 @@ . -.TH "BCFG2\-ADMIN" "8" "July 2012" "" "" +.TH "BCFG2\-ADMIN" "8" "August 2012" "" "" . .SH "NAME" \fBbcfg2\-admin\fR \- Perform repository administration tasks @@ -14,13 +14,45 @@ . .TP \fB\-C\fR \fIconfigfile\fR -Specify alternate bcfg2\.conf location +Specify alternate bcfg2\.conf location\. . -.SH "MODES" +.TP +\fB\-E\fR \fIencoding\fR +Specify the encoding of Cfg files\. . .TP -\fBinit\fR -Initialize a new repository (interactive)\. +\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 @@ -35,22 +67,30 @@ Display details about the available bundles (See \fI\fBBUNDLE OPTIONS\fR\fR belo 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 +\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)\. . @@ -59,6 +99,10 @@ Interact with the dynamic reporting system (See \fI\fBREPORTS OPTIONS\fR\fR belo 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\. . @@ -66,6 +110,10 @@ Remove unused files from repository\. \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)\. . +.TP +\fBxcmd\fR +Provides a XML\-RPC Command Interface to the bcfg2\-server\. +. .SS "BUNDLE OPTIONS" . .TP diff --git a/tools/manpagegen/bcfg2-admin.8.ronn b/tools/manpagegen/bcfg2-admin.8.ronn index c827265ca..f90865d9c 100644 --- a/tools/manpagegen/bcfg2-admin.8.ronn +++ b/tools/manpagegen/bcfg2-admin.8.ronn @@ -12,12 +12,37 @@ bcfg2-admin(8) -- Perform repository administration tasks ## OPTIONS * `-C` : - Specify alternate bcfg2.conf location + Specify alternate bcfg2.conf location. -## MODES + * `-E` : + Specify the encoding of Cfg files. - * `init`: - Initialize a new repository (interactive). + * `-Q` : + Specify the path to the server repository. + + * `-S` : + Manually specify the server location (as opposed to using the value + in bcfg2.conf). + + * `-d`: + Enable debugging output. + + * `-h`: + Print Usage information. + + * `-o` : + Writes a log to the specified path. + + * `-v`: + Enable verbose output. + + * `-x` : + Use ’password’ for client communication. + + * `--ssl-key=`: + Specifiy the path to the SSL key. + +## MODES * `backup`: Create an archive of the entire Bcfg2 repository. @@ -30,23 +55,29 @@ bcfg2-admin(8) -- Perform repository administration tasks Add, edit, or remove clients entries in metadata (See [`CLIENT OPTIONS`](###CLIENT OPTIONS) below). - * `query` [g=group] [p=profile] [-f output-file] [-n] [-c]: - Search for clients based on group or profile (See [`QUERY - OPTIONS`](###QUERY OPTIONS) below). - * `compare` : Compare two client configurations. Can be used to verify consistent behavior between releases. Determine differences between files or directories (See [`COMPARE OPTIONS`](###COMPARE OPTIONS) below). + * `init`: + Initialize a new repository (interactive). + * `minestruct` [-f xml-file] [-g groups]: Build structure entries based on client statistics extra entries (See [`MINESTRUCT OPTIONS`](###MINESTRUCT OPTIONS) below). + * `perf`: + Query server for performance data. + * `pull` : Install configuration information into repo based on client bad entries (See [`PULL OPTIONS`](###PULL OPTIONS) below). + * `query` [g=group] [p=profile] [-f output-file] [-n] [-c]: + Search for clients based on group or profile (See [`QUERY + OPTIONS`](###QUERY OPTIONS) below). + * `reports` [init|load_stats|purge|scrub|update]: Interact with the dynamic reporting system (See [`REPORTS OPTIONS`](###REPORTS OPTIONS) below). @@ -55,6 +86,9 @@ bcfg2-admin(8) -- Perform repository administration tasks Interact with the Snapshots database (See [`SNAPSHOTS OPTIONS`](###SNAPSHOTS OPTIONS) below). + * `syncdb`: + Sync the Django ORM with the configured database. + * `tidy`: Remove unused files from repository. @@ -62,6 +96,9 @@ bcfg2-admin(8) -- Perform repository administration tasks Create a graphviz diagram of client, group and bundle information (See [`VIZ OPTIONS`](###VIZ OPTIONS) below). + * `xcmd`: + Provides a XML-RPC Command Interface to the bcfg2-server. + ### BUNDLE OPTIONS * `mode`: -- cgit v1.2.3-1-g7c22