Update for version release.

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

diff --git a/docs/man/libmemcached.3 b/docs/man/libmemcached.3
index e0334668e8c318449227d852ab26d3770088e3aa..809bf56b02a8f7a07b78a1cb003d632a1eb21906 100644 (file)
--- a/docs/man/libmemcached.3
+++ b/docs/man/libmemcached.3
@@ -1,4 +1,4 @@
-.TH "LIBMEMCACHED" "3" "June 17, 2011" "0.49" "libmemcached"
+.TH "LIBMEMCACHED" "3" "May 22, 2012" "1.0.8" "libmemcached"

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


@@ -35,38 +35,38 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 #include <libmemcached/memcached.h>
 .sp
 Compile and link with \-lmemcached
 #include <libmemcached/memcached.h>
 .sp
 Compile and link with \-lmemcached

+

 .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.
+.ce
+----
+
+.ce 0
+.sp
+.sp
+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
 .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
 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
 .sp
 "Memcached is a high\-performance, distributed memory object caching
 system, generic in nature, but intended for use in speeding up dynamic web
 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
 .sp
 \fBlibmemcached\fP is a small, thread\-safe client library for the
 memcached protocol. The code has all been written to allow


@@ -76,16 +76,17 @@ 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
 a modular and consistent method of object distribution.
 .sp
 There are multiple implemented routing and hashing methods. See the

-memcached_behavior_set() manpage for more information.
+\fBmemcached_behavior_set()\fP manpage for more information.

 .sp
 All operations are performed against a \fBmemcached_st\fP structure.
 These structures can either be dynamically allocated or statically
 .sp
 All operations are performed against a \fBmemcached_st\fP structure.
 These structures can either be dynamically allocated or statically

-allocated and then initialized by memcached_create(). Functions have been
-written in order to encapsulate the \fBmemcached_st\fP. It is not
+allocated and then initialized by \fBmemcached_create()\fP. Functions have
+been written in order to encapsulate the \fBmemcached_st\fP. It is not

 recommended that you operate directly against the structure.
 .sp
 Nearly all functions return a \fBmemcached_return_t\fP value.
 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 memcached_strerror(3).
+This value can be translated to a printable string with
+\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


@@ -105,7 +106,7 @@ PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
 AC_SUBST(DEPS_CFLAGS)
 AC_SUBST(DEPS_LIBS)
 .sp
 AC_SUBST(DEPS_CFLAGS)
 AC_SUBST(DEPS_LIBS)
 .sp

-Some features of the library must be enabled through memcached_behavior_set().
+Some features of the library must be enabled through \fBmemcached_behavior_set()\fP.

 .sp
 Hope you enjoy it!
 .SH CONSTANTS
 .sp
 Hope you enjoy it!
 .SH CONSTANTS


@@ -114,53 +115,50 @@ 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

-of \fBmemcached_st\fP per process or thread. Without creating your own locking
-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.
+of \fBmemcached_st\fP per process or thread. Without creating your own
+locking structures you can not share a single \fBmemcached_st\fP. However,
+you can call \fBmemcached_quit()\fP on a \fBmemcached_st\fP and then use the resulting cloned structure.

 .SH HOME
 .sp
 To find out more information please check:
 .SH HOME
 .sp
 To find out more information please check: