Signed-off-by: Jan Friesse <jfriesse@xxxxxxxxxx> --- man/Makefile.am | 8 ++++- man/corosync-xmlproc.8 | 57 ++++++++++++++++++++++++++++++++++++++ man/corosync.xml.5 | 72 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 136 insertions(+), 1 deletions(-) create mode 100644 man/corosync-xmlproc.8 create mode 100644 man/corosync.xml.5 diff --git a/man/Makefile.am b/man/Makefile.am index 11e9aba..fe4ea6b 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -121,7 +121,13 @@ dist_man_MANS = \ sam_start.3 \ sam_stop.3 \ sam_warn_signal_set.3 - + +if INSTALL_XMLCONF +dist_man_MANS += \ + corosync-xmlproc.8 \ + corosync.xml.5 +endif + if BUILD_HTML_DOCS HTML_DOCS = $(dist_man_MANS:%=%.html) diff --git a/man/corosync-xmlproc.8 b/man/corosync-xmlproc.8 new file mode 100644 index 0000000..8b86760 --- /dev/null +++ b/man/corosync-xmlproc.8 @@ -0,0 +1,57 @@ +.\"/* +.\" * Copyright (C) 2011 Red Hat, Inc. +.\" * +.\" * All rights reserved. +.\" * +.\" * Author: Jan Friesse <jfriesse@xxxxxxxxxx> +.\" * +.\" * This software licensed under BSD license, the text of which follows: +.\" * +.\" * Redistribution and use in source and binary forms, with or without +.\" * modification, are permitted provided that the following conditions are met: +.\" * +.\" * - Redistributions of source code must retain the above copyright notice, +.\" * this list of conditions and the following disclaimer. +.\" * - Redistributions in binary form must reproduce the above copyright notice, +.\" * this list of conditions and the following disclaimer in the documentation +.\" * and/or other materials provided with the distribution. +.\" * - Neither the name of Red Hat, Inc. nor the names of its +.\" * contributors may be used to endorse or promote products derived from this +.\" * software without specific prior written permission. +.\" * +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF +.\" * THE POSSIBILITY OF SUCH DAMAGE. +.\" */ +.TH COROSYNC-XMLPROC 8 2011-12-16 +.SH NAME +corosync-xmlproc \- Converts corosync.xml to the Corosync configuration file. +.SH SYNOPSIS +.B "corosync-xmlproc input_xml [output_file]" +.SH DESCRIPTION +.B corosync-xmlproc +Converts valid corosync.xml file to the Corosync configuration file format. Command internally +uses +.B +xsltproc +for XML conversion. +.SH OPTIONS +.TP +.B input_xml +Valid XML file to convert. +.TP +.B output_file +Destination file name. If parameter is - or omitted, output is written to standard output. +.SH SEE ALSO +.BR corosync-xml (5), +.SH AUTHOR +Jan Friesse +.PP diff --git a/man/corosync.xml.5 b/man/corosync.xml.5 new file mode 100644 index 0000000..c44d916 --- /dev/null +++ b/man/corosync.xml.5 @@ -0,0 +1,72 @@ +.\"/* +.\" * Copyright (c) 2011 Red Hat, Inc. +.\" * +.\" * All rights reserved. +.\" * +.\" * Author: Jan Friesse (jfriesse@xxxxxxxxxx) +.\" * +.\" * This software licensed under BSD license, the text of which follows: +.\" * +.\" * Redistribution and use in source and binary forms, with or without +.\" * modification, are permitted provided that the following conditions are met: +.\" * +.\" * - Redistributions of source code must retain the above copyright notice, +.\" * this list of conditions and the following disclaimer. +.\" * - Redistributions in binary form must reproduce the above copyright notice, +.\" * this list of conditions and the following disclaimer in the documentation +.\" * and/or other materials provided with the distribution. +.\" * - Neither the name of the Red Hat, Inc. nor the names of its +.\" * contributors may be used to endorse or promote products derived from this +.\" * software without specific prior written permission. +.\" * +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF +.\" * THE POSSIBILITY OF SUCH DAMAGE. +.\" */ +.TH COROSYNC_XML 5 2011-12-16 "corosync XML config Man Page" "Corosync Cluster Engine Programmer's Manual" +.SH NAME +corosync.xml - XML version of corosync executive configuration file + +.SH SYNOPSIS +/etc/corosync/corosync.xml + +.SH DESCRIPTION +The corosync.xml is XML version of corosync.conf file. It is processed by +.B corosync-xmlproc (8) +to generate valid conf file. + +File must be valid XML. File starts with root element +.B corosync +which can contain same arguments as described in +.B corosync.conf (5). + +Within corosync tag are other tags which are processed as follows: +.TP +- Every tag is start of new directive +.TP +- Every tag attribute is one of options in directive +.TP +- Directive is automatically closed +.TP +- Sub-tags are processed same and stays within directive +.PP +For example, see /etc/corosync/corosync.xml.example + +.SH "FILES" +.TP +/etc/corosync/corosync.xml +XML version of the corosync executive configuration file. + +.SH "SEE ALSO" +.BR corosync_overview (8), +.BR corosync.conf (5), +.BR corosync-xmlproc (8) +.PP -- 1.7.1 _______________________________________________ discuss mailing list discuss@xxxxxxxxxxxx http://lists.corosync.org/mailman/listinfo/discuss
