Merging bzr://gaz.tangent.org/libmemcached/build/ to Build branch

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

diff --git a/docs/man/libmemcached.3 b/docs/man/libmemcached.3
index a0788e2ab749246b03cd12a0d67143e183afa4e3..11f84718deaadf081a0c1da162110c735142a7b1 100644 (file)
--- a/docs/man/libmemcached.3
+++ b/docs/man/libmemcached.3
@@ -1,4 +1,4 @@
-.TH "LIBMEMCACHED" "3" "September 26, 2011" "0.53" "libmemcached"
+.TH "LIBMEMCACHED" "3" "April 08, 2012" "1.0.6" "libmemcached"
 .SH NAME
 libmemcached \- Introducing the C Client Library for memcached
 .
@@ -43,37 +43,30 @@ Compile and link with \-lmemcached
 .ce 0
 .sp
 .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.
+libMemcached is an open source C/C++ client library and tools for the memcached server (\fI\%http://memcached.org/\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
 system, generic in nature, but intended for use in speeding up dynamic web
-applications by alleviating database load." \fI\%http://danga.com/memcached/\fP
+applications by alleviating database load." \fI\%http://memcached.org/\fP
 .sp
 \fBlibmemcached\fP is a small, thread\-safe client library for the
 memcached protocol. The code has all been written to allow
@@ -93,7 +86,7 @@ recommended that you operate directly against the structure.
 .sp
 Nearly all functions return a \fBmemcached_return_t\fP value.
 This value can be translated to a printable string with
-\fBmemcached_strerror()\fP.
+\fBmemcached_strerror\fP.
 .sp
 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
@@ -122,46 +115,44 @@ A number of constants have been provided for in the library.
 .INDENT 0.0
 .TP
 .B MEMCACHED_DEFAULT_PORT
-.
 The default port used by memcached(3).
 .UNINDENT
 .INDENT 0.0
 .TP
 .B MEMCACHED_MAX_KEY
-.
 Default maximum size of a key (which includes the null pointer). Master keys
 have no limit, this only applies to keys used for storage.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B MEMCACHED_MAX_KEY
-.
 Default size of key (which includes the null pointer).
 .UNINDENT
 .INDENT 0.0
 .TP
 .B MEMCACHED_STRIDE
-.
 This is the "stride" used in the consistent hash used between replicas.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B MEMCACHED_MAX_HOST_LENGTH
-.
 Maximum allowed size of the hostname.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B LIBMEMCACHED_VERSION_STRING
-.
 String value of libmemcached version such as "1.23.4"
 .UNINDENT
 .INDENT 0.0
 .TP
 .B LIBMEMCACHED_VERSION_HEX
-.
 Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
 .UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_PREFIX_KEY_MAX_SIZE
+Maximum length allowed for namespacing of a key.
+.UNINDENT
 .SH THREADS AND PROCESSES
 .sp
 When using threads or forked processes it is important to keep one instance