Reviewed-by: Steven Dake <sd...@redhat.com> On 05/26/2011 07:41 AM, Jan Friesse wrote: > Missing man pages are: > - ais-keygen > - aisexec > - openais-cfgtool > - openais-confdb-display > --- > branches/whitetank/man/Makefile | 9 ++- > branches/whitetank/man/ais-keygen.8 | 78 > +++++++++++++++++++++++ > branches/whitetank/man/aisexec.8 | 52 +++++++++++++++ > branches/whitetank/man/openais-cfgtool.8 | 52 +++++++++++++++ > branches/whitetank/man/openais-confdb-display.8 | 76 ++++++++++++++++++++++ > 5 files changed, 265 insertions(+), 2 deletions(-) > create mode 100644 branches/whitetank/man/ais-keygen.8 > create mode 100644 branches/whitetank/man/aisexec.8 > create mode 100644 branches/whitetank/man/openais-cfgtool.8 > create mode 100644 branches/whitetank/man/openais-confdb-display.8 > > diff --git a/branches/whitetank/man/Makefile b/branches/whitetank/man/Makefile > index 3f03027..0afbd9f 100644 > --- a/branches/whitetank/man/Makefile > +++ b/branches/whitetank/man/Makefile > @@ -56,10 +56,15 @@ html: > groff -mandoc -Thtml cpg_leave.3 > html/cpg_leave.html > groff -mandoc -Thtml cpg_mcast_joined.3 > html/cpg_mcast_joined.html > groff -mandoc -Thtml cpg_membership_get.3 > html/cpg_membership_get.html > - groff -mandoc -Thtml cpg_context_get.3 > html/cpg_context_get.html > - groff -mandoc -Thtml cpg_context_set.3 > html/cpg_context_set.html > + groff -mandoc -Thtml cpg_context_get.3 > html/cpg_context_get.html > + groff -mandoc -Thtml cpg_context_set.3 > html/cpg_context_set.html > groff -mandoc -Thtml cpg_local_get.3 > html/cpg_local_get.html > > + groff -mandoc -Thtml ais-keygen.8 > html/ais-keygen.html > + groff -mandoc -Thtml aisexec.8 > html/aisexec.html > + groff -mandoc -Thtml openais-cfgtool.8 > html/openais-cfgtool.html > + groff -mandoc -Thtml openais-confdb-display.8 > > html/openais-confdb-display.html > + > cp index.html html > > clean: > diff --git a/branches/whitetank/man/ais-keygen.8 > b/branches/whitetank/man/ais-keygen.8 > new file mode 100644 > index 0000000..b8e875a > --- /dev/null > +++ b/branches/whitetank/man/ais-keygen.8 > @@ -0,0 +1,78 @@ > +.\"/* > +.\" * Copyright (C) 2010-2011 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Angus Salkeld <asalk...@redhat.com> > +.\" * Jan Friesse <jfrie...@redhat.com> > +.\" * > +.\" * 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 MontaVista Software, 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 AIS-KEYGEN 8 2011-05-26 > +.SH NAME > +ais-keygen \- Generate an authentication key for OpenAIS. > +.SH SYNOPSIS > +.B "ais-keygen" > +.SH DESCRIPTION > + > +If you want to configure OpenAIS to use cryptographic techniques to ensure > authenticity > +.br > +and privacy of the messages, you will need to generate a private key. > +.PP > +.B ais-keygen > +creates this key and writes it to /etc/ais/authkey. > +.PP > +This private key must be copied to every processor in the cluster. If the > +.br > +private key isn't the same for every node, those nodes with nonmatching > private > +.br > +keys will not be able to join the same configuration. > +.PP > +Copy the key to some security transportable storage or use ssh to transmit > the > +.br > +key from node to node. Then install the key with the command: > +.PP > +unix#: install -D --group=0 --owner=0 --mode=0400 /path_to_authkey/authkey > /etc/ais/authkey > +.PP > +If a message "Invalid digest" appears from the aisexec executive, the keys > +.br > +are not consistent between processors. > +.SH EXAMPLES > +.TP > +Generate the key. > +.PP > +$ ais-keygen > +.br > +OpenAIS Authentication key generator. > +.br > +Gathering 1024 bits for key from /dev/random. > +.br > +Writing openais key to /etc/ais/authkey. > +.br > +.SH SEE ALSO > +.BR openais_overview (8), > +.BR openais.conf (5), > diff --git a/branches/whitetank/man/aisexec.8 > b/branches/whitetank/man/aisexec.8 > new file mode 100644 > index 0000000..6f0715d > --- /dev/null > +++ b/branches/whitetank/man/aisexec.8 > @@ -0,0 +1,52 @@ > +.\"/* > +.\" * Copyright (C) 2010-2011 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Angus Salkeld <asalk...@redhat.com> > +.\" * Jan Friesse <jfrie...@redhat.com> > +.\" * > +.\" * 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 MontaVista Software, 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 AISEXEC 8 2011-05-26 > +.SH NAME > +aisexec \- The OpenAIS Standards Based Cluster Framewor. > +.SH SYNOPSIS > +.B "aisexec [\-f]" > +.SH DESCRIPTION > +.B aisexec > +The OpenAIS Standards Based Cluster Framework is an OSI Certified > implementation > +of the Service Availability Forum Application Interface Specification (AIS). > +.SH OPTIONS > +.TP > +.B -f > +Start application in foreground. > +.SH SEE ALSO > +.BR openais_overview (8), > +.BR openais.conf (5), > +.BR cpg_overview (8), > +.BR evs_overview (8), > diff --git a/branches/whitetank/man/openais-cfgtool.8 > b/branches/whitetank/man/openais-cfgtool.8 > new file mode 100644 > index 0000000..4486edc > --- /dev/null > +++ b/branches/whitetank/man/openais-cfgtool.8 > @@ -0,0 +1,52 @@ > +.\"/* > +.\" * Copyright (C) 2010-2011 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Angus Salkeld <asalk...@redhat.com> > +.\" * Jan Friesse <jfrie...@redhat.com> > +.\" * > +.\" * 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 MontaVista Software, 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 "OPENAIS-CFGTOOL" "8" "2011-05-26" "" "" > +.SH "NAME" > +openais-cfgtool \- An administrative tool for OpenAIS. > +.SH "SYNOPSIS" > +.B openais\-cfgtool [\-s] [\-r] > +.SH "DESCRIPTION" > +.B openais\-cfgtool > +A tool for displaying and configuring active parameters within OpenAIS. > +.SH "OPTIONS" > +.TP > +.B -s > +Displays the status of the current rings on this node. > +.TP > +.B -r > +Reset redundant ring state cluster wide after a fault to > +re-enable redundant ring operation. > +.SH "SEE ALSO" > +.BR openais_overview (8), > diff --git a/branches/whitetank/man/openais-confdb-display.8 > b/branches/whitetank/man/openais-confdb-display.8 > new file mode 100644 > index 0000000..4892cb6 > --- /dev/null > +++ b/branches/whitetank/man/openais-confdb-display.8 > @@ -0,0 +1,76 @@ > +.\"/* > +.\" * Copyright (C) 2010-2011 Red Hat, Inc. > +.\" * > +.\" * All rights reserved. > +.\" * > +.\" * Author: Jan Friesse <jfrie...@redhat.com> > +.\" * > +.\" * 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 MontaVista Software, 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 "OPENAIS-CONFDB-DISPLAY" "8" "2011-05-26" "" "" > +.SH "NAME" > +openais-confdb-display \- Display objects in the Object Database > +.SH "SYNOPSIS" > +.B openais\-confdb\-display [object] [key...] > +.SH "DESCRIPTION" > +.B openais\-confdb\-display > +A tool for displaying objects keys in the Object Database. > +.SH "OPTIONS" > +.TP > +.B [object] > +Object to display > +.TP > +.B [key...] > +key in object to display > +.SH EXAMPLES > +.TP > +Display node id: > +.PP > +$ openais-confdb-display totem nodeid > +.br > +totem.nodeid = '2' > +.PP > +Display totem version and secauth: > +.PP > +.br > +$ openais-confdb-display > +.br > +totem.version = '2' > +.br > +totem.secauth = 'off' > +.PP > +Display logging to_stderr, to_file and logfile: > +.PP > +$ openais-confdb-display logging to_stderr to_file logfile > +.br > +logging.to_stderr = 'yes' > +.br > +logging.to_file = 'yes' > +.br > +logging.logfile = '/tmp/ais' > +.SH "SEE ALSO" > +.BR openais_overview (8),
_______________________________________________ Openais mailing list Openais@lists.linux-foundation.org https://lists.linux-foundation.org/mailman/listinfo/openais
