X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_sasl.3;h=fd6fe595e3365b3e4e8e8aa3fc760e89e60557e9;hb=23ebff2eb0d5aea343ce743b1a45ecebdb8d7403;hp=78c3d677543cb9be923ec224dfa3f111454868d9;hpb=5a9c49c1e9f1950045eb845277c370324ac9ef16;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_sasl.3 b/docs/man/memcached_sasl.3 index 78c3d677..fd6fe595 100644 --- a/docs/man/memcached_sasl.3 +++ b/docs/man/memcached_sasl.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_SASL" "3" "June 17, 2011" "0.49" "libmemcached" +.TH "MEMCACHED_SASL" "3" "October 18, 2011" "1.01" "libmemcached" .SH NAME memcached_sasl \- libmemcached Documentation . @@ -59,21 +59,20 @@ 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 -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 -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. .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. +You as a client user have to initialize libsasl by using \fBsasl_client_init\fP before enabling it in libmemcached, and you have to shut down libsasl by +calling \fBsasl_done()\fP when you are done using SASL from libmemcached. .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. \fBmemcached_get_sasl_set_auth_data()\fP returns \fBMEMCACHED_SUCCESS\fP upon success. .SH HOME .sp To find out more information please check: