Update for deprecated functions.
[m6w6/libmemcached] / docs / man / libmemcached.3
index 5b31728e5fd3f07136232e2e7c40e00e688238df..70fbd16baa335420ce657bdca8122d543818ba2d 100644 (file)
@@ -1,6 +1,6 @@
-.TH "LIBMEMCACHED" "3" "April 08, 2011" "0.47" "libmemcached"
+.TH "LIBMEMCACHED" "3" "April 13, 2011" "0.47" "libmemcached"
 .SH NAME
-libmemcached \- libmemcached Documentation
+libmemcached \- Introducing the C Client Library for memcached
 .
 .nr rst2man-indent-level 0
 .
@@ -30,18 +30,11 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 ..
 .\" Man page generated from reStructeredText.
 .
-.sp
-Client library for memcached
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)
 .SH SYNOPSIS
 .sp
-.nf
-.ft C
 #include <libmemcached/memcached.h>
-.ft P
-.fi
+.sp
+Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
 "Memcached is a high\-performance, distributed memory object caching
@@ -67,8 +60,11 @@ recommended that you operate directly against the structure.
 Nearly all functions return a \fBmemcached_return_t\fP value.
 This value can be translated to a printable string with memcached_strerror(3).
 .sp
-Partitioning based on keys is testsed in the library. Using the key partioning
-functions it is possible to group sets of object onto servers.
+Objects are stored on servers by hashing keys. The hash value maps the key to a particular server. All clients understand how this hashing works, so it is possibly to reliably both push data to a server and retrieve data from a server.
+.sp
+Group keys can be optionally used to group sets of objects with servers.
+.sp
+Namespaces are supported, and can be used to partition caches so that multiple applications can use the same memcached servers.
 .sp
 \fBmemcached_st\fP structures are thread\-safe, but each thread must
 contain its own structure (that is, if you want to share these among