From 1add5c6332fb8f59abf377d4167099ae9c5f1125 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Wed, 13 Apr 2011 14:14:07 -0500 Subject: man: Update the bcfg2-reports man page Signed-off-by: Sol Jerome --- man/bcfg2-repo-validate.8 | 29 +++++++++++++++++++++++------ man/bcfg2-reports.8 | 6 +++--- man/bcfg2-server.8 | 10 +++++----- man/bcfg2.1 | 42 +++++++++++++++++++++--------------------- man/bcfg2.conf.5 | 10 +++++----- 5 files changed, 57 insertions(+), 40 deletions(-) (limited to 'man') diff --git a/man/bcfg2-repo-validate.8 b/man/bcfg2-repo-validate.8 index d00885313..81ba61099 100644 --- a/man/bcfg2-repo-validate.8 +++ b/man/bcfg2-repo-validate.8 @@ -3,18 +3,35 @@ bcfg2-repo-validate \- Check Bcfg2 repository data against data schemas .SH SYNOPSIS .B bcfg2-repo-validate -.I [-v] +.I [-v] .SH DESCRIPTION .PP .B bcfg2-repo-validate This script checks data against schemas, and it quite helpful in -finding typos or malformed data. +finding typos or malformed data. .SH OPTIONS -.PP -.B "\-C" -.RS + +.TP +.BR "-Q " +Server repository path + +.TP +.BR "-C " Specify path to bcfg2.conf (default /etc/bcfg2.conf) -.RE + +.TP +.BR "--stdin" +Operate on a list of files supplied on stdin + +.TP +.BR "-v" +Enable verbose output + +.TP +.BR "--schema=" +Path to XML Schema files + +.RE .SH "SEE ALSO" .BR bcfg2(1), .BR bcfg2-server(8) diff --git a/man/bcfg2-reports.8 b/man/bcfg2-reports.8 index bc4c9344b..7597818cd 100644 --- a/man/bcfg2-reports.8 +++ b/man/bcfg2-reports.8 @@ -3,7 +3,7 @@ bcfg2-reports \- Query reporting system for client status .SH SYNOPSIS .B bcfg2-reports -.I [-v] +.I [-v] .SH DESCRIPTION .PP \fBbcfg2-reports\fR allows you to retrieve data from the database about @@ -53,14 +53,14 @@ Toggles expired/unexpired state of NAME. NAME is the name of the entry. Shows only hosts whose current interaction has bad entries in of KIND kind and NAME name; if a single argument ARG1 is given, then KIND,NAME pairs will be read from a file of name ARG1. KIND is the type of entry -(Package, Path, Service, etc). NAME is the name of the entry. +(Package, Path, Service, etc). NAME is the name of the entry. .RE .B "\-\-extraentry=KIND,NAME" .RS Shows only hosts whose current interaction has extra entries in of KIND kind and NAME name; if a single argument ARG1 is given, then KIND,NAME pairs will be read from a file of name ARG1. KIND is the type of entry -(Package, Path, Service, etc). NAME is the name of the entry. +(Package, Path, Service, etc). NAME is the name of the entry. .RE .B "\-\-fields=ARG1,ARG2,..." .RS diff --git a/man/bcfg2-server.8 b/man/bcfg2-server.8 index a6bffc1fa..9f99ee8b7 100644 --- a/man/bcfg2-server.8 +++ b/man/bcfg2-server.8 @@ -7,11 +7,11 @@ bcfg2-server \- Server for client configuration specifications .SH DESCRIPTION .PP .B bcfg2-server -This daemon serves configurations to clients based on the data in its -repository. +This daemon serves configurations to clients based on the data in its +repository. .SH OPTIONS .PP -.B \-d +.B \-d .RS Run bcfg2 in debug mode. .RE @@ -19,11 +19,11 @@ Run bcfg2 in debug mode. .RS Run bcfg2 in verbose mode. .RE -.B "\-C " +.B "\-C " .RS Use an alternative path for bcfg2.conf. The default is /etc/bcfg2.conf .RE -.B \-D +.B \-D .RS Daemonize, placing the program pid in the specified pidfile. .RE diff --git a/man/bcfg2.1 b/man/bcfg2.1 index 938d41dfe..14398fdab 100644 --- a/man/bcfg2.1 +++ b/man/bcfg2.1 @@ -31,15 +31,15 @@ Specify the encoding of Cfg files. .TP .BR "\-I" -Run bcfg2 in interactive mode. The user will be prompted before each +Run bcfg2 in interactive mode. The user will be prompted before each change. .TP -.BR "\-O" +.BR "\-O" Omit lock check. -.TP -.BR "\-P" +.TP +.BR "\-P" Run bcfg2 in paranoid mode. Diffs will be logged for configuration files marked as paranoid by the Bcfg2 server. @@ -62,24 +62,24 @@ Run bcfg2 against one or multiple bundles in the configuration. Cache a copy of the configuration in cachefile. .TP -.BR "\-d" +.BR "\-d" Run bcfg2 in debug mode. -.TP -.BR "\-e" +.TP +.BR "\-e" When in verbose mode, display extra entry information (temporary until verbosity rework). .TP -.BR "\-f " +.BR "\-f " Configure from a file rather than querying the server. -.TP -.BR "\-h" +.TP +.BR "\-h" Print Usage information. -.TP -.BR "\-k" +.TP +.BR "\-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. @@ -97,14 +97,14 @@ administrators and much configuration variety. .TP .BR "\-n" Run bcfg2 in dry\-run mode. No changes will be made to the -system. +system. .TP .BR "\-o " Writes a log to the specified path. .TP -.BR "\-p " +.BR "\-p " Assert a profile for the current client. .TP @@ -112,16 +112,16 @@ Assert a profile for the current client. 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 .BR "\-Q" -Run bcfg2 in "bundle quick" mode, where only entries in a bundle are -or installed. This runs much faster than -q, but doesn't provide +Run bcfg2 in "bundle quick" mode, where only entries in a bundle are +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. +-b option must also be provided. This option is incompatible with -r. .TP -.BR "\-r " +.BR "\-r " 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 @@ -139,11 +139,11 @@ modify services. Specifiy the path to the SSL key. .TP -.BR "\-u " +.BR "\-u " Attempt to authenticate as 'user'. .TP -.BR "\-x " +.BR "\-x " Use 'password' for client communication. .TP diff --git a/man/bcfg2.conf.5 b/man/bcfg2.conf.5 index f2e47b7ac..c32ccde16 100644 --- a/man/bcfg2.conf.5 +++ b/man/bcfg2.conf.5 @@ -64,7 +64,7 @@ reporting system, so they can be centrally observed. \(bu .B BB -The BB plugin maps users to machines and metadata to machines. +The BB plugin maps users to machines and metadata to machines. (experimental) \(bu @@ -339,20 +339,20 @@ settings used for client-server communication. .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. +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. +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. +certificates. .TP .B password @@ -379,7 +379,7 @@ of the configuration file. .TP .B path -Custom path for backups created in paranoid mode. The default is in +Custom path for backups created in paranoid mode. The default is in /var/cache/bcfg2. .TP -- cgit v1.2.3-1-g7c22