Update to handle newer endian autoconf components.
[awesomized/libmemcached] / docs / man / memcached_set_encoding_key.3
1 .TH "MEMCACHED_SET_ENCODING_KEY" "3" "July 05, 2012" "1.0.9" "libmemcached"
2 .SH NAME
3 memcached_set_encoding_key \- libmemcached Documentation
4 .
5 .nr rst2man-indent-level 0
6 .
7 .de1 rstReportMargin
8 \\$1 \\n[an-margin]
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
11 -
12 \\n[rst2man-indent0]
13 \\n[rst2man-indent1]
14 \\n[rst2man-indent2]
15 ..
16 .de1 INDENT
17 .\" .rstReportMargin pre:
18 . RS \\$1
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
22 ..
23 .de UNINDENT
24 . RE
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30 ..
31 .\" Man page generated from reStructeredText.
32 .
33 .SH SYNOPSIS
34 .sp
35 #include <libmemcached/memcached.h>
36 .INDENT 0.0
37 .TP
38 .B void memcached_set_encoding_key(memcached_st\fI\ *ptr\fP, const char\fI\ *string\fP, const size_t\fI\ string_length\fP)
39 .UNINDENT
40 .sp
41 Compile and link with \-lmemcached
42 .SH DESCRIPTION
43 .sp
44 \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.
45 .sp
46 Currently only AES is is supported.
47 .SH RETURN
48 .sp
49 A value of type \fBmemcached_return_t\fP is returned On success that value
50 will be \fBMEMCACHED_SUCCESS\fP. Use \fBmemcached_strerror()\fP to
51 translate this value to a printable string.
52 .SH HOME
53 .sp
54 To find out more information please check:
55 \fI\%http://libmemcached.org/\fP
56 .SH AUTHOR
57 .sp
58 Brian Aker, <\fI\%brian@tangent.org\fP>
59 .SH SEE ALSO
60 .sp
61 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
62 .SH AUTHOR
63 Brian Aker
64 .SH COPYRIGHT
65 2011, Brian Aker DataDifferential, http://datadifferential.com/
66 .\" Generated by docutils manpage writer.
67 .\"
68 .