cluster: STABLE3 - config dump: add man page

cluster: STABLE3 - config dump: add man page

[Fabio M. Di Nitto]

Gitweb:        http://git.fedorahosted.org/git/cluster.git?p=cluster.git;a=commitdiff;h=a5de3f2eb0585ad00571e513e15c7c2618cc4464
Commit:        a5de3f2eb0585ad00571e513e15c7c2618cc4464
Parent:        da0b095e5195d3d1522c81ac981fa3b24c3cd6f0
Author:        Fabio M. Di Nitto <fdinitto@redhat.com>
AuthorDate:    Fri Sep 4 11:56:20 2009 +0200
Committer:     Fabio M. Di Nitto <fdinitto@redhat.com>
CommitterDate: Fri Sep 4 11:56:20 2009 +0200

config dump: add man page

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

diff --git a/config/tools/man/Makefile b/config/tools/man/Makefile
index f2d6d92..7cb76ab 100644
--- a/config/tools/man/Makefile
+++ b/config/tools/man/Makefile
@@ -1,4 +1,5 @@
-TARGET= ccs_tool.8 \
+TARGET=	ccs_config_dump.8 \
+	ccs_tool.8 \
 	confdb2ldif.8
 
 include ../../../make/defines.mk
diff --git a/config/tools/man/ccs_config_dump.8 b/config/tools/man/ccs_config_dump.8
new file mode 100644
index 0000000..e31d3ce
--- /dev/null
+++ b/config/tools/man/ccs_config_dump.8
@@ -0,0 +1,35 @@
+.TH "ccs_config_dump" "8" "" "" ""
+.SH "NAME"
+ccs_config_dump \- Tool to generate XML output of running configuration.
+
+.SH "SYNOPSIS"
+.B ccs_config_dump
+[\fIOPTION\fR]..
+
+.SH "DESCRIPTION"
+
+\fBccs_config_dump\fP is part of the Cluster Configuration System (CCS).
+It is used to dump the current running configuration in XML format.
+The running configuration is, sometimes, different from the stored
+configuration on file or ldap because some subsystems store or set
+some default information into the configuration. Those values are
+generally not present on the on-disk version of the configuration
+but are required at runtime for the cluster to work properly.
+
+.SH "OPTIONS"
+.TP 
+\fB\-h\fP
+Help.  Print out the usage.
+.TP 
+\fB\-V\fP
+Print the version information.
+.TP
+\fB\-r\fP
+Force config dump from running cluster. This option is only for expert users
+and debugging sessions. Don't use it for random purposes.
+ccs_config_dump can be configured to use different configuration sources via
+environment variables. This option will clear them to use the default and use
+only the runtime configuration.
+
+.SH "SEE ALSO"
+ccs_config_validate(8), cluster.conf(5)