Merge in local trunk

[awesomized/libmemcached] / docs / memcached_sasl.rst

diff --git a/docs/memcached_sasl.rst b/docs/memcached_sasl.rst
index 74a4e919e6da65395e2987de9420490af35c7ca6..4dc4039c4f0aec375e754116b7cab5b8a1a36d1f 100644 (file)
--- a/docs/memcached_sasl.rst
+++ b/docs/memcached_sasl.rst
@@ -1,40 +1,25 @@
-.. highlight:: perl
+============
+SASL support
+============

 
 

-
-memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data
-------------------------------------------------------------------------------------------------------------------------**
-
-
-SASL tests
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
+.. index:: object: memcached_st

 
 
 --------
 SYNOPSIS
 --------
 
 
 
 --------
 SYNOPSIS
 --------
 

+#include <libmemcached/memcached_pool.h>
+
+.. c:function:: void memcached_set_sasl_callbacks(memcached_st *ptr, const sasl_callback_t *callbacks)

 
 

+.. c:function:: const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr)

 
 

-.. code-block:: perl
+.. c:function:: memcached_return memcached_set_sasl_auth_data(memcached_st *ptr, const char *username, const char *password)

 
 

-   #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)
+.. c:function:: memcached_return memcached_destroy_sasl_auth_data(memcached_st *ptr)
+
+Compile and link with -lmemcached

 
 
 
 
 
 


@@ -49,7 +34,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.
 
 Please note that SASL requires the memcached binary protocol, and you have
 to specify the callbacks before you connect to the server.
 

-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
 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


@@ -61,9 +46,9 @@ before enabling it in libmemcached, and you have to shut down libsasl by
 calling sasl_done() when you are done using SASL from libmemcached.
 
 
 calling sasl_done() when you are done using SASL from libmemcached.
 
 

-******
+------

 RETURN
 RETURN

-******
+------

 
 
 memcached_get_sasl_callbacks() returns the callbacks currently used
 
 
 memcached_get_sasl_callbacks() returns the callbacks currently used


@@ -71,19 +56,21 @@ by this memcached handle.
 memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success.
 
 
 memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success.
 
 

-****
+----

 HOME
 HOME

-****
+----

 
 
 To find out more information please check:
 `http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 
 
 To find out more information please check:
 `http://libmemcached.org/ <http://libmemcached.org/>`_
 
 

-******
+------

 AUTHOR
 AUTHOR

-******
+------
+

 
 

+Brian Aker, <brian@tangent.org>

 
 Trond Norbye, <trond.norbye@gmail.com>
 
 
 Trond Norbye, <trond.norbye@gmail.com>