Merge in updates to all docs/etc.

[m6w6/libmemcached] / docs / libmemcached_configuration.rst

diff --git a/docs/libmemcached_configuration.rst b/docs/libmemcached_configuration.rst
index 10103f5034ea24515c4a883782f487e899e3e693..05b2af8ea0df0773c08407679f4c9b5f755bccfc 100644 (file)
--- a/docs/libmemcached_configuration.rst
+++ b/docs/libmemcached_configuration.rst
@@ -24,7 +24,6 @@ Libmemcached implements a custom language for configuring and modifying
 servers. By passing in an option string you can generate a memcached_st object
 that you can use in your application directly.
 
-
 .. describe:: --SERVER=<servername>:<optional_port>/?<optional_weight>
 
 Provide a servername to be used by the client. Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1.
@@ -61,27 +60,66 @@ Set the distribution model used by the client.  See :manpage:`` for more details
 
 Set the hashing alogrthm used for placing keys on servers.
 
-.. describe:: --HASH-WITH-PREFIX_KEY
-
-.. describe:: --IO-BYTES-WATERMARK=
+.. describe:: --HASH-WITH-NAMESPACE
 
-.. describe:: --IO-KEY-PREFETCH=
-
-.. describe:: --IO-MSG-WATERMARK=
+When enabled the prefix key will be added to the key when determining which
+server to store the data in.
 
 .. describe:: --NOREPLY
 
+Enable "no reply" for all calls that support this. It is highly recommended
+that you use this option with the binary protocol only.
+
 .. describe:: --NUMBER-OF-REPLICAS=
 
 Set the nummber of servers that keys will be replicated to.
 
-.. describe:: --POLL-TIMEOUT=
-
 .. describe:: --RANDOMIZE-REPLICA-READ
 
 Select randomly the server within the replication pool to read from.
 
-.. describe:: --RCV-TIMEOUT=
+.. describe:: --SORT-HOSTS
+
+When adding new servers always calculate their distribution based on sorted naming order.
+
+.. describe:: --SUPPORT-CAS
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SUPPORT_CAS
+
+.. describe:: --USE-UDP
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_USE_UDP
+
+.. describe:: --NAMESPACE=
+
+A namespace is a container that provides context for keys, only other
+requests that know the namespace can access these values. This is
+accomplished by prepending the namespace value to all keys.
+
+
+********************** 
+Mecached Pool Options: 
+**********************
+
+.. describe:: --POOL-MIN
+
+Initial size of pool.
+
+.. describe:: --POOL-MAX
+
+Maximize size of the pool.
+
+************
+I/O Options:
+************
+
+.. describe:: --TCP-NODELAY
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_NODELAY
+
+.. describe:: --TCP-KEEPALIVE
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
 
 .. describe:: --RETRY-TIMEOUT=
 
@@ -103,29 +141,26 @@ See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
 
 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
 
-.. describe:: --SORT-HOSTS
-
-When adding new servers always calculate their distribution based on sorted naming order.
+.. describe:: --POLL-TIMEOUT=
 
-.. describe:: --SUPPORT-CAS
+That sets the value of the timeout used by :manpage: `poll()`.
 
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SUPPORT_CAS
+.. describe:: --IO-BYTES-WATERMARK=
 
-.. describe:: --TCP-NODELAY
+.. describe:: --IO-KEY-PREFETCH=
 
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_NODELAY
+.. describe:: --IO-MSG-WATERMARK=
 
-.. describe:: --TCP-KEEPALIVE
+.. describe:: --TCP-KEEPIDLE
 
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
+.. describe:: --RCV-TIMEOUT=
 
-.. describe:: --TCP-KEEPIDLE
 
-.. describe:: --USE-UDP
 
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_USE_UDP
+******
+Other:
+******
 
-.. describe:: --PREFIX-KEY=
 
 .. describe:: INCLUDE