Update man-pages
[awesomized/libmemcached] / docs / man / memcached_sasl.3
index fd704330b1afd4598932c79bbddd75c7d0eca9bb..d969b9d8539b43548ae938a6612295d89a6677e6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_SASL" "3" "April 07, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_SASL" "3" "May 23, 2011" "0.47" "libmemcached"
 .SH NAME
 memcached_sasl \- libmemcached Documentation
 .
 .SH NAME
 memcached_sasl \- libmemcached Documentation
 .
@@ -30,28 +30,27 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 ..
 .\" Man page generated from reStructeredText.
 .
 ..
 .\" Man page generated from reStructeredText.
 .
-.sp
-SASL support
-.SH LIBRARY
-.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 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
 .SH DESCRIPTION
 .sp
 libmemcached(3) allows you to plug in your own callbacks function used by
@@ -60,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
 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
 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
@@ -81,14 +80,16 @@ To find out more information please check:
 \fI\%http://libmemcached.org/\fP
 .SH AUTHOR
 .sp
 \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
 .sp
-memcached(1) libmemcached(3)
+\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\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.
 .\" 
 .