Merge of all doc fixes.

[awesomized/libmemcached] / docs / libmemcached_configuration.rst

diff --git a/docs/libmemcached_configuration.rst b/docs/libmemcached_configuration.rst
index 5cb353746090f0be1cb5675428770349915b3e65..10103f5034ea24515c4a883782f487e899e3e693 100644 (file)
--- a/docs/libmemcached_configuration.rst
+++ b/docs/libmemcached_configuration.rst
@@ -2,7 +2,28 @@
 Configuring Libmemcached
 ========================
 
 Configuring Libmemcached
 ========================
 

-Libmemcached implements a custom language for configuring and modifying servers.
+-------- 
+SYNOPSIS 
+--------
+
+
+.. c:function:: memcached_st *memcached_create_with_options(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
+that you can use in your application directly.
+

 
 .. describe:: --SERVER=<servername>:<optional_port>/?<optional_weight>
 
 
 .. describe:: --SERVER=<servername>:<optional_port>/?<optional_weight>
 


@@ -12,9 +33,9 @@ Provide a servername to be used by the client. Providing a weight will cause wei
 
 Verify that keys that are being used fit within the design of the protocol being used.
 
 
 Verify that keys that are being used fit within the design of the protocol being used.
 

-.. describe:: --AUTO-EJECT_HOSTS
+.. describe:: --REMOVE_FAILED_SERVERS

 
 

-Enable the behavior MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS.
+Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS.

 
 .. describe:: --BINARY-PROTOCOL
 
 
 .. describe:: --BINARY-PROTOCOL
 


@@ -121,3 +142,47 @@ End configutation processing.
 .. describe:: ERROR
 
 End configutation processing and throw an error.
 .. describe:: ERROR
 
 End configutation processing and throw an error.

+
+
+------
+RETURN
+------
+
+
+memcached_create_with_options() returns a pointer to the memcached_st that was
+created (or initialized).  On an allocation failure, it returns NULL.
+
+
+
+------- 
+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_free(memc);
+
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`