Update for version release.

[awesomized/libmemcached] / docs / man / memcached_set_encoding_key.3

diff --git a/docs/man/memcached_set_encoding_key.3 b/docs/man/memcached_set_encoding_key.3
new file mode 100644 (file)
index 0000000..b4abdde
--- /dev/null
+++ b/docs/man/memcached_set_encoding_key.3
@@ -0,0 +1,68 @@
+.TH "MEMCACHED_SET_ENCODING_KEY" "3" "May 22, 2012" "1.0.8" "libmemcached"
+.SH NAME
+memcached_set_encoding_key \- libmemcached Documentation
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
+.SH SYNOPSIS
+.sp
+#include <libmemcached/memcached.h>
+.INDENT 0.0
+.TP
+.B void memcached_set_encoding_key(memcached_st\fI\ *ptr\fP, const char\fI\ *string\fP, const size_t\fI\ string_length\fP)
+.UNINDENT
+.sp
+Compile and link with \-lmemcached
+.SH DESCRIPTION
+.sp
+\fI\%memcached_set_encoding_key()\fP sets the key that will be used to encrypt and decrypt data as it is sent and recieved from the server.
+.sp
+Currently only AES is is supported.
+.SH RETURN
+.sp
+A value of type \fBmemcached_return_t\fP is returned On success that value
+will be \fBMEMCACHED_SUCCESS\fP.  Use \fBmemcached_strerror()\fP to
+translate this value to a printable string.
+.SH HOME
+.sp
+To find out more information please check:
+\fI\%http://libmemcached.org/\fP
+.SH AUTHOR
+.sp
+Brian Aker, <\fI\%brian@tangent.org\fP>
+.SH SEE ALSO
+.sp
+\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
+.SH AUTHOR
+Brian Aker
+.SH COPYRIGHT
+2011, Brian Aker DataDifferential, http://datadifferential.com/
+.\" Generated by docutils manpage writer.
+.\" 
+.