cluster: STABLE3 - config validate: add man page

cluster: STABLE3 - config validate: add man page

[Fabio M. Di Nitto]

Gitweb:        http://git.fedorahosted.org/git/cluster.git?p=cluster.git;a=commitdiff;h=3f88e836e582c63938d2fd3862080a8e920a6f52
Commit:        3f88e836e582c63938d2fd3862080a8e920a6f52
Parent:        b25166629f95f0e3a4e0cd527fb17f25e8ca1699
Author:        Fabio M. Di Nitto <fdinitto@redhat.com>
AuthorDate:    Fri Sep 11 13:29:25 2009 +0200
Committer:     Fabio M. Di Nitto <fdinitto@redhat.com>
CommitterDate: Fri Sep 11 13:29:25 2009 +0200

config validate: add man page

Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>
---
 config/tools/man/Makefile              |    1 +
 config/tools/man/ccs_config_validate.8 |   52 ++++++++++++++++++++++++++++++++
 2 files changed, 53 insertions(+), 0 deletions(-)

diff --git a/config/tools/man/Makefile b/config/tools/man/Makefile
index 7cb76ab..e29dbf0 100644
--- a/config/tools/man/Makefile
+++ b/config/tools/man/Makefile
@@ -1,4 +1,5 @@
 TARGET=	ccs_config_dump.8 \
+	ccs_config_validate.8 \
 	ccs_tool.8 \
 	confdb2ldif.8
 
diff --git a/config/tools/man/ccs_config_validate.8 b/config/tools/man/ccs_config_validate.8
new file mode 100644
index 0000000..8884952
--- /dev/null
+++ b/config/tools/man/ccs_config_validate.8
@@ -0,0 +1,52 @@
+.TH CCS_CONFIG_VALIDATE "8" "September 2009"
+.SH NAME
+ccs_config_validate
+.SH DESCRIPTION
+Usage:
+.PP
+ccs_config_validate [options]
+.SH OPTIONS
+.TP
+\fB\-h\fR
+Print this help, then exit
+.TP
+\fB\-V\fR
+Print program version information, then exit
+.TP
+\fB\-v\fR
+Produce verbose output
+.SS "Validating XML configuraton files:"
+.TP
+\fB\-f\fR configfile
+Validate an alternate config file without preloading it with default values.
+.TP
+\fB\-l\fR configfile
+Validate an alternate config file with preloading of default values (recommended option).
+.SS "Advanced options:"
+.TP
+\fB\-r\fR
+Force validation of runtime config
+.HP
+\fB\-C\fR config_loader
+Override config plugin loader
+.TP
+\fB\-t\fR tempfile
+Force temporay file to tempfile
+.TP
+\fB\-n\fR
+Do not remove temporary file
+.TP
+\fB\-o\fR
+Overwrite temporary file (dangerous)
+.SH "DEFAULT"
+Default operation for ccs_config_validate is to load the currently configured environment
+and verify the outcoming configuration.
+.TP
+Example 1: current environment uses a configuration file (/etc/cluster/cluster.conf).
+The user modifies cluser.conf and executes ccs_config_validate without options.
+The tool will validate the modified cluster.conf after including default values.
+.TP
+Example 2: current environment is set to load the configuration from LDAP. Users
+modifies LDAP databse and before pushing the change to the nodes, she/he can issue
+ccs_config_validate to verify the contents o the LDAP database automatically
+(as long as the correct LDAP environment is set in the cman/cluster sysconfig/defaults files).