X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_sasl.3;h=78c3d677543cb9be923ec224dfa3f111454868d9;hb=625e84ebfc422790372bc2984f504bdcb4da779c;hp=946b0dfb929bdf948f009f6ece4c6f6fd1f995a4;hpb=55cf7c68679083cdd7351db3b888c6f8ddcebe09;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_sasl.3 b/docs/man/memcached_sasl.3 index 946b0dfb..78c3d677 100644 --- a/docs/man/memcached_sasl.3 +++ b/docs/man/memcached_sasl.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_SASL" "3" "April 11, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_SASL" "3" "June 17, 2011" "0.49" "libmemcached" .SH NAME memcached_sasl \- libmemcached Documentation . @@ -30,26 +30,27 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . -.SH LIBRARY -.sp -C Client Library for memcached (libmemcached, \-lmemcached) .SH SYNOPSIS .sp -.nf -.ft C -#include - -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 +.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 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 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 @@ -58,7 +59,7 @@ 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 for you defining +memcached_set_sasl_auth_data() 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