From a9814fa0c24e0f29dc0d31fe85a2d739f3f5bfba Mon Sep 17 00:00:00 2001 From: Steven Dake Date: Wed, 1 Jul 2009 06:18:56 +0000 Subject: [PATCH] Add votequorum_context_get/set man pages. git-svn-id: http://svn.fedorahosted.org/svn/corosync/trunk@2325 fd59a12c-fef9-0310-b244-a6a79926bd2f --- man/votequorum_context_get.3 | 58 ++++++++++++++++++++++++++++++++++ man/votequorum_context_set.3 | 60 ++++++++++++++++++++++++++++++++++++ 2 files changed, 118 insertions(+) create mode 100644 man/votequorum_context_get.3 create mode 100644 man/votequorum_context_set.3 diff --git a/man/votequorum_context_get.3 b/man/votequorum_context_get.3 new file mode 100644 index 00000000..29482b00 --- /dev/null +++ b/man/votequorum_context_get.3 @@ -0,0 +1,58 @@ +.\"/* +.\" * Copyright (c) 2007 Red Hat, Inc. +.\" * +.\" * All rights reserved. +.\" * +.\" * Author: Patrick Caulfield +.\" * +.\" * 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 VOTEQUORUM_CONTEXT_GET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" +.SH NAME +votequorum_context_get \- Gets the context variable for a VOTEQUORUM instance +.SH SYNOPSIS +.B #include +.sp +.BI "int votequorum_context_get(votequorum_handle_t " handle ", void **" context "); +.SH DESCRIPTION +The +.B votequorum_context_get +function is used to retrieve the context variable previously stored using +.B votequorum_context_set(3) +.SH RETURN VALUE +This call returns the VOTEQUORUM_OK value if successful, otherwise an error is returned. +.PP +.SH ERRORS +The errors are undocumented. +.SH "SEE ALSO" +.BR votequorum_initialize (3), +.BR votequorum_finalize (3), +.BR votequorum_fd_get (3), +.BR votequorum_dispatch (3), +.BR votequorum_context_get (3), +.BR votequorum_context_set (3), +.PP diff --git a/man/votequorum_context_set.3 b/man/votequorum_context_set.3 new file mode 100644 index 00000000..334f83a5 --- /dev/null +++ b/man/votequorum_context_set.3 @@ -0,0 +1,60 @@ +.\"/* +.\" * Copyright (c) 2007 Red Hat, Inc. +.\" * +.\" * All rights reserved. +.\" * +.\" * Author: Patrick Caulfield +.\" * +.\" * 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 VOTEQUORUM_CONTEXT_SET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" +.SH NAME +votequorum_context_set \- Sets the context variable for a VOTEQUORUM instance +.SH SYNOPSIS +.B #include +.sp +.BI "int votequorum_context_set(votequorum_handle_t " handle ", void *" context "); +.SH DESCRIPTION +The +.B votequorum_context_set +function is used to set the context variable for a votequorum instance. It has no +meaning insire libvotequorum itself and will not be touched by the library. It can +be retrieved using +.B votequorum_context_get(3) +.SH RETURN VALUE +This call returns the VOTEQUORUM_OK value if successful, otherwise an error is returned. +.PP +.SH ERRORS +The errors are undocumented. +.SH "SEE ALSO" +.BR votequorum_initialize (3), +.BR votequorum_finalize (3), +.BR votequorum_fd_get (3), +.BR votequorum_dispatch (3), +.BR votequorum_context_get (3), +.BR votequorum_context_set (3), +.PP