X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Flibmemcached_configuration.rst;h=2f3da9d44b991ae3e5a4035afd7776940bbf9815;hb=43032586b9809c2e0bbc115cd901754544ea845b;hp=4cfec4a820ef715e5b7c223861233249b87b21ff;hpb=ecc7382f48857cb22e74ffa9496f9a31e956bde3;p=m6w6%2Flibmemcached diff --git a/docs/libmemcached_configuration.rst b/docs/libmemcached_configuration.rst index 4cfec4a8..2f3da9d4 100644 --- a/docs/libmemcached_configuration.rst +++ b/docs/libmemcached_configuration.rst @@ -8,7 +8,9 @@ Configuring Libmemcached SYNOPSIS -------- -#include +#include + +.. envvar:: LIBMEMCACHED .. c:function:: memcached_st *memcached(const char *string, size_t string_length) @@ -29,6 +31,10 @@ that you can use in your application directly. 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=\"/?\" + +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. @@ -185,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.