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 79cff931f4f3e1e4d6c659982d26854989bb38e4..9b3111dd36fe891ace6fcd1e9593859debf17bba 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" "June 17, 2011" "0.49" "libmemcached"
+.TH "MEMCACHED_SASL_SET_AUTH_DATA" "3" "April 28, 2012" "1.0.7" "libmemcached"

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


@@ -43,11 +43,11 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .UNINDENT
 .INDENT 0.0
 .TP
 .UNINDENT
 .INDENT 0.0
 .TP

-.B memcached_return memcached_set_sasl_auth_data(memcached_st\fI\ *ptr\fP, const char\fI\ *username\fP, const char\fI\ *password\fP)
+.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
 .UNINDENT
 .INDENT 0.0
 .TP

-.B memcached_return memcached_destroy_sasl_auth_data(memcached_st\fI\ *ptr\fP)
+.B memcached_return_t memcached_destroy_sasl_auth_data(memcached_st\fI\ *ptr\fP)

 .UNINDENT
 .sp
 Compile and link with \-lmemcached
 .UNINDENT
 .sp
 Compile and link with \-lmemcached


@@ -59,21 +59,18 @@ 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 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().
-.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.
+\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
 .SH RETURN
 .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:
 .SH HOME
 .sp
 To find out more information please check: