Merge from trunk.

[m6w6/libmemcached] / docs / man / libmemcached.3

diff --git a/docs/man/libmemcached.3 b/docs/man/libmemcached.3
index 0891b66e074f0951b7639482c14737e79b7acad8..e0334668e8c318449227d852ab26d3770088e3aa 100644 (file)
--- a/docs/man/libmemcached.3
+++ b/docs/man/libmemcached.3
@@ -1,4 +1,4 @@
-.TH "LIBMEMCACHED" "3" "April 13, 2011" "0.47" "libmemcached"
+.TH "LIBMEMCACHED" "3" "June 17, 2011" "0.49" "libmemcached"
 .SH NAME
 libmemcached \- Introducing the C Client Library for memcached
 .
@@ -35,6 +35,33 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 #include <libmemcached/memcached.h>
 .sp
 Compile and link with \-lmemcached
+.sp
+libMemcached is an open source C/C++ client library and tools for the memcached server (\fI\%http://danga.com/memcached\fP). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods.
+.sp
+libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided:
+.INDENT 0.0
+.IP 1. 3
+.
+Asynchronous and Synchronous Transport Support.
+.IP 2. 3
+.
+Consistent Hashing and Distribution.
+.IP 3. 3
+.
+Tunable Hashing algorithm to match keys.
+.IP 4. 3
+.
+Access to large object support.
+.IP 5. 3
+.
+Local replication.
+.IP 6. 3
+.
+A complete reference guide and documentation to the API.
+.IP 7. 3
+.
+Tools to Manage your Memcached networks.
+.UNINDENT
 .SH DESCRIPTION
 .sp
 "Memcached is a high\-performance, distributed memory object caching
@@ -42,14 +69,14 @@ system, generic in nature, but intended for use in speeding up dynamic web
 applications by alleviating database load." \fI\%http://danga.com/memcached/\fP
 .sp
 \fBlibmemcached\fP is a small, thread\-safe client library for the
-memcached protocol. The code has all been written with an eye to allow
+memcached protocol. The code has all been written to allow
 for both web and embedded usage. It handles the work behind routing
-particular keys to specific servers that you specify (and values are
-matched based on server order as supplied by you). It implements both
-a modula and consistent method of object distribution.
+individual keys to specific servers specified by the developer (and values are
+matched based on server order as supplied by the user). It implements
+a modular and consistent method of object distribution.
 .sp
 There are multiple implemented routing and hashing methods. See the
-memcached_behavior_set() manpage.
+memcached_behavior_set() manpage for more information.
 .sp
 All operations are performed against a \fBmemcached_st\fP structure.
 These structures can either be dynamically allocated or statically
@@ -129,9 +156,9 @@ Hex value of the version number. "0x00048000" This can be used for comparing ver
 .UNINDENT
 .SH THREADS AND PROCESSES
 .sp
-When using threads or forked processes it is important to keep an instance
+When using threads or forked processes it is important to keep one instance
 of \fBmemcached_st\fP per process or thread. Without creating your own locking
-structures you can not share a single \fBmemcached_st\fP. You can though call
+structures you can not share a single \fBmemcached_st\fP. However, you can call
 memcached_quit(3) on a \fBmemcached_st\fP and then use the resulting cloned
 structure.
 .SH HOME