Merging bzr://gaz.tangent.org/libmemcached/build/ to Build branch

[m6w6/libmemcached] / docs / man / memcached_sasl_set_auth_data.3

diff --git a/docs/man/memcached_sasl_set_auth_data.3 b/docs/man/memcached_sasl_set_auth_data.3
index 9ed62994495e6c72d2599c64484c3598a40ef82a..c5997fbd60b338f4f3c1873c4ab4b5e04c4ca237 100644 (file)
--- a/docs/man/memcached_sasl_set_auth_data.3
+++ b/docs/man/memcached_sasl_set_auth_data.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_SASL_SET_AUTH_DATA" "3" "April 08, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_SASL_SET_AUTH_DATA" "3" "April 08, 2012" "1.0.6" "libmemcached"

 .SH NAME
 memcached_sasl_set_auth_data \- libmemcached Documentation
 .
 .SH NAME
 memcached_sasl_set_auth_data \- libmemcached Documentation
 .


@@ -30,30 +30,27 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 ..
 .\" Man page generated from reStructeredText.
 .
 ..
 .\" Man page generated from reStructeredText.
 .

-.sp
-memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-**
-.sp
-SASL tests
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)

 .SH SYNOPSIS
 .sp
 .SH SYNOPSIS
 .sp

-.nf
-.ft C
-#include <libmemcached/memcached.h>
-
-void memcached_set_sasl_callbacks(memcached_st *ptr,
-                                  const sasl_callback_t *callbacks)
-
-const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr)
-
-memcached_return memcached_set_sasl_auth_data(memcached_st *ptr,
-                                              const char *username,
-                                              const char *password)
-memcached_return memcached_destroy_sasl_auth_data(memcached_st *ptr)
-.ft P
-.fi
+#include <libmemcached/memcached_pool.h>
+.INDENT 0.0
+.TP
+.B void memcached_set_sasl_callbacks(memcached_st\fI\ *ptr\fP, const sasl_callback_t\fI\ *callbacks\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st\fI\ *ptr\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_set_sasl_auth_data(memcached_st\fI\ *ptr\fP, const char\fI\ *username\fP, const char\fI\ *password\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_destroy_sasl_auth_data(memcached_st\fI\ *ptr\fP)
+.UNINDENT
+.sp
+Compile and link with \-lmemcached

 .SH DESCRIPTION
 .sp
 libmemcached(3) allows you to plug in your own callbacks function used by
 .SH DESCRIPTION
 .sp
 libmemcached(3) allows you to plug in your own callbacks function used by


@@ -62,23 +59,25 @@ libsasl to perform SASL authentication.
 Please note that SASL requires the memcached binary protocol, and you have
 to specify the callbacks before you connect to the server.
 .sp
 Please note that SASL requires the memcached binary protocol, and you have
 to specify the callbacks before you connect to the server.
 .sp

-memcached_set_sasl_auth_data() is a helper function for you defining
+\fI\%memcached_set_sasl_auth_data()\fP is a helper function defining

 the basic functionality for you, but it will store the username and password
 in memory. If you choose to use this method you have to call
 the basic functionality for you, but it will store the username and password
 in memory. If you choose to use this method you have to call

-memcached_destroy_sasl_auth_data before calling memcached_free to avoid
-a memory leak. You should NOT call memcached_destroy_sasl_auth_data if you
-specify your own callback function with memcached_set_sasl_callbacks().
+\fI\%memcached_destroy_sasl_auth_data\fP before calling
+\fBmemcached_free\fP to avoid a memory leak. You should NOT call
+\fI\%memcached_destroy_sasl_auth_data\fP if you specify your own callback
+function with \fI\%memcached_set_sasl_callbacks()\fP.
+.SH RETURN

 .sp
 .sp

-You as a client user have to initialize libsasl by using sasl_client_init
-before enabling it in libmemcached, and you have to shut down libsasl by
-calling sasl_done() when you are done using SASL from libmemcached.
-.sp
-memcached_get_sasl_callbacks() returns the callbacks currently used
-by this memcached handle.
-memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success.
+\fI\%memcached_get_sasl_callbacks()\fP returns the callbacks currently used by
+this memcached handle. \fI\%memcached_set_sasl_auth_data()\fP returns
+\fBMEMCACHED_SUCCESS\fP upon success.
+.SH HOME

 .sp
 To find out more information please check:
 \fI\%http://libmemcached.org/\fP
 .sp
 To find out more information please check:
 \fI\%http://libmemcached.org/\fP

+.SH AUTHOR
+.sp
+Brian Aker, <\fI\%brian@tangent.org\fP>

 .sp
 Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
 .SH SEE ALSO
 .sp
 Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
 .SH SEE ALSO


@@ -87,7 +86,7 @@ Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT

-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/

 .\" Generated by docutils manpage writer.
 .\" 
 .
 .\" Generated by docutils manpage writer.
 .\" 
 .