Update docs, and syncronize libtest.
[awesomized/libmemcached] / docs / libmemcached_configuration.rst
index 05b2af8ea0df0773c08407679f4c9b5f755bccfc..4cfec4a820ef715e5b7c223861233249b87b21ff 100644 (file)
@@ -2,26 +2,27 @@
 Configuring Libmemcached
 ========================
 
+.. highlightlang:: c
+
 -------- 
 SYNOPSIS 
 --------
 
+#include <libmemcached/memcached.h>
 
-.. c:function:: memcached_st *memcached_create_with_options(const char *string, size_t string_length)
-
+.. 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>
@@ -184,7 +185,7 @@ RETURN
 ------
 
 
-memcached_create_with_options() returns a pointer to the memcached_st that was
+memcached() returns a pointer to the memcached_st that was
 created (or initialized).  On an allocation failure, it returns NULL.
 
 
@@ -197,7 +198,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 +212,7 @@ HOME
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_