Final bits for 1.0.9

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

diff --git a/docs/man/libmemcached.3 b/docs/man/libmemcached.3
index 9160fb70ac3c8250bed1b5a49efdb45eaf10ac55..2841a28da054bd98a6168d07c72b33a68a50678e 100644 (file)
--- a/docs/man/libmemcached.3
+++ b/docs/man/libmemcached.3
@@ -1,4 +1,4 @@
-.TH "LIBMEMCACHED" "3" "October 18, 2011" "1.01" "libmemcached"
+.TH "LIBMEMCACHED" "3" "July 05, 2012" "1.0.9" "libmemcached"

 .SH NAME
 libmemcached \- Introducing the C Client Library for memcached
 .
 .SH NAME
 libmemcached \- Introducing the C Client Library for memcached
 .


@@ -48,25 +48,18 @@ libMemcached is an open source C/C++ client library and tools for the memcached
 libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided:
 .INDENT 0.0
 .IP 1. 3
 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
 Asynchronous and Synchronous Transport Support.
 .IP 2. 3

-.

 Consistent Hashing and Distribution.
 .IP 3. 3
 Consistent Hashing and Distribution.
 .IP 3. 3

-.

 Tunable Hashing algorithm to match keys.
 .IP 4. 3
 Tunable Hashing algorithm to match keys.
 .IP 4. 3

-.

 Access to large object support.
 .IP 5. 3
 Access to large object support.
 .IP 5. 3

-.

 Local replication.
 .IP 6. 3
 Local replication.
 .IP 6. 3

-.

 A complete reference guide and documentation to the API.
 .IP 7. 3
 A complete reference guide and documentation to the API.
 .IP 7. 3

-.

 Tools to Manage your Memcached networks.
 .UNINDENT
 .SH DESCRIPTION
 Tools to Manage your Memcached networks.
 .UNINDENT
 .SH DESCRIPTION


@@ -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
 .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
 .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
 .INDENT 0.0
 .TP
 .B MEMCACHED_DEFAULT_PORT

-.

 The default port used by memcached(3).
 .UNINDENT
 .INDENT 0.0
 .TP
 .B MEMCACHED_MAX_KEY
 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 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
 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
 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
 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
 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
 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
 .SH THREADS AND PROCESSES
 .sp
 When using threads or forked processes it is important to keep one instance