Remove a simple issue that trips up peope providing patches (just allow the class...

[m6w6/libmemcached] / docs / libmemcached_configuration.rst

diff --git a/docs/libmemcached_configuration.rst b/docs/libmemcached_configuration.rst
index 74902aab7663d987a00aa95d6fdf4e05b3c1028b..2f3da9d44b991ae3e5a4035afd7776940bbf9815 100644 (file)
--- a/docs/libmemcached_configuration.rst
+++ b/docs/libmemcached_configuration.rst
@@ -2,13 +2,15 @@
 Configuring Libmemcached
 ========================
 
-.. index:: object: memcached_st
+.. highlightlang:: c
 
 -------- 
 SYNOPSIS 
 --------
 
-#include <libmemcached/memcached.h>
+#include <libmemcached-1.0/memcached.h>
+
+.. envvar:: LIBMEMCACHED
 
 .. c:function:: memcached_st *memcached(const char *string, size_t string_length)
 
@@ -17,19 +19,22 @@ SYNOPSIS
 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.
@@ -186,7 +191,7 @@ RETURN
 ------
 
 
-memcached() 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.