Crank up alarm value.

[awesomized/libmemcached] / docs / libmemcached_configuration.rst

diff --git a/docs/libmemcached_configuration.rst b/docs/libmemcached_configuration.rst
index 05b2af8ea0df0773c08407679f4c9b5f755bccfc..e0f51b12f432665801912fc7c93bb42d9dd14f0f 100644 (file)
--- a/docs/libmemcached_configuration.rst
+++ b/docs/libmemcached_configuration.rst
@@ -2,39 +2,46 @@
 Configuring Libmemcached
 ========================
 
+.. highlightlang:: c
+
 -------- 
 SYNOPSIS 
 --------
 
+#include <libmemcached-1.0/memcached.h>
 
-.. c:function:: memcached_st *memcached_create_with_options(const char *string, size_t string_length)
+.. envvar:: LIBMEMCACHED
 
+.. c:function:: memcached_st *memcached(const char *string, size_t string_length)
 
 .. c:function:: memcached_return_t libmemcached_check_configuration(const char *option_string, size_t length, char *error_buffer, size_t error_buffer_size)
 
 Compile and link with -lmemcached
 
 
-
 -----------
 DESCRIPTION
 -----------
 
 Libmemcached implements a custom language for configuring and modifying
-servers. By passing in an option string you can generate a memcached_st object
+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.
 
+.. describe:: --SOCKET=\"<filepath>/?<optional_weight>\"
+
+Provide a filepath to a UNIX socket file. 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:: --REMOVE_FAILED_SERVERS
 
-Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS.
+Enable the behavior :c:type:`MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS`.
 
 .. describe:: --BINARY-PROTOCOL
 
@@ -42,7 +49,7 @@ Force all connections to use the binary protocol.
 
 .. describe:: --BUFFER-REQUESTS
 
-Enable MEMCACHED_BEHAVIOR_BUFFER_REQUESTS.
+Please see :c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS`.
 
 .. describe:: --CONFIGURE-FILE=
 
@@ -50,7 +57,7 @@ Provide a configuration file to be used to load requests. Beware that by using a
 
 .. describe:: --CONNECT-TIMEOUT=
 
-Enable MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT. 
+Please see :c:type:`MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT`. 
 
 .. describe:: --DISTRIBUTION=
 
@@ -84,11 +91,11 @@ When adding new servers always calculate their distribution based on sorted nami
 
 .. describe:: --SUPPORT-CAS
 
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SUPPORT_CAS
+See :manpage:`memcached_behavior_set(3)` for :c:type:`MEMCACHED_BEHAVIOR_SUPPORT_CAS`
 
 .. describe:: --USE-UDP
 
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_USE_UDP
+See :manpage:`memcached_behavior_set(3)` for :c:type:`MEMCACHED_BEHAVIOR_USE_UDP`
 
 .. describe:: --NAMESPACE=
 
@@ -184,7 +191,7 @@ RETURN
 ------
 
 
-memcached_create_with_options() returns a pointer to the memcached_st that was
+:c:func:`memcached()` returns a pointer to the memcached_st that was
 created (or initialized).  On an allocation failure, it returns NULL.
 
 
@@ -197,7 +204,7 @@ EXAMPLE
 .. code-block:: c
 
    const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"
-   memcached_st *memc= memcached_create_with_options(config_string, strlen(config_string);
+   memcached_st *memc= memcached(config_string, strlen(config_string);
    {
     ...
    }
@@ -211,7 +218,7 @@ HOME
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_