Merge in more documentation.

[awesomized/libmemcached] / docs / libmemcached_configuration.rst

diff --git a/docs/libmemcached_configuration.rst b/docs/libmemcached_configuration.rst
index 86b7cbe9febcbc01a02b0e7eb2d2220ec90303ce..5cb353746090f0be1cb5675428770349915b3e65 100644 (file)
--- a/docs/libmemcached_configuration.rst
+++ b/docs/libmemcached_configuration.rst
@@ -3,3 +3,121 @@ Configuring Libmemcached
 ========================
 
 Libmemcached implements a custom language for configuring and modifying servers.
+
+.. 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.
+
+.. describe:: --VERIFY-KEY
+
+Verify that keys that are being used fit within the design of the protocol being used.
+
+.. describe:: --AUTO-EJECT_HOSTS
+
+Enable the behavior MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS.
+
+.. describe:: --BINARY-PROTOCOL
+
+Force all connections to use the binary protocol.
+
+.. describe:: --BUFFER-REQUESTS
+
+Enable MEMCACHED_BEHAVIOR_BUFFER_REQUESTS.
+
+.. describe:: --CONFIGURE-FILE=
+
+Provide a configuration file to be used to load requests. Beware that by using a configuration file libmemcached will reset memcached_st based on information only contained in the file.
+
+.. describe:: --CONNECT-TIMEOUT=
+
+Enable MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT. 
+
+.. describe:: --DISTRIBUTION=
+
+Set the distribution model used by the client.  See :manpage:`` for more details.
+
+.. describe:: --HASH=
+
+Set the hashing alogrthm used for placing keys on servers.
+
+.. describe:: --HASH-WITH-PREFIX_KEY
+
+.. describe:: --IO-BYTES-WATERMARK=
+
+.. describe:: --IO-KEY-PREFETCH=
+
+.. describe:: --IO-MSG-WATERMARK=
+
+.. describe:: --NOREPLY
+
+.. 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:: --RETRY-TIMEOUT=
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
+
+.. describe:: --SERVER-FAILURE-LIMIT=
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
+
+.. describe:: --SND-TIMEOUT=
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SND_TIMEOUT
+
+.. describe:: --SOCKET-RECV-SIZE=
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
+
+.. describe:: --SOCKET-SEND-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:: --SUPPORT-CAS
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SUPPORT_CAS
+
+.. 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:: --TCP-KEEPIDLE
+
+.. describe:: --USE-UDP
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_USE_UDP
+
+.. describe:: --PREFIX-KEY=
+
+.. describe:: INCLUDE
+
+Include a file in configuration. Unlike --CONFIGURE-FILE= this will not reset memcached_st
+
+.. describe:: RESET
+
+Reset memcached_st and continue to process.
+
+.. describe:: END
+
+End configutation processing.
+
+.. describe:: ERROR
+
+End configutation processing and throw an error.