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)
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
.. describe:: --BUFFER-REQUESTS
-Enable MEMCACHED_BEHAVIOR_BUFFER_REQUESTS.
+Please see :c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS`.
.. describe:: --CONFIGURE-FILE=
.. describe:: --CONNECT-TIMEOUT=
-Enable MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT.
+Please see :c:type:`MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT`.
.. describe:: --DISTRIBUTION=
.. 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=
------
-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.