X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Flibmemcached_configuration.rst;h=e0f51b12f432665801912fc7c93bb42d9dd14f0f;hb=220ac91be6530bd992a7d2bde4310bb523075143;hp=71a2c5bb061b456ed2b74a97c606bfab3d255896;hpb=04b8554c3724eae57fbd75dc6b3e69dca8b58187;p=awesomized%2Flibmemcached diff --git a/docs/libmemcached_configuration.rst b/docs/libmemcached_configuration.rst index 71a2c5bb..e0f51b12 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,7 +31,7 @@ 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=/? +.. 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. @@ -39,7 +41,7 @@ Verify that keys that are being used fit within the design of the protocol being .. 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 @@ -47,7 +49,7 @@ Force all connections to use the binary protocol. .. describe:: --BUFFER-REQUESTS -Enable MEMCACHED_BEHAVIOR_BUFFER_REQUESTS. +Please see :c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS`. .. describe:: --CONFIGURE-FILE= @@ -55,7 +57,7 @@ Provide a configuration file to be used to load requests. Beware that by using a .. describe:: --CONNECT-TIMEOUT= -Enable MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT. +Please see :c:type:`MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT`. .. describe:: --DISTRIBUTION= @@ -89,11 +91,11 @@ When adding new servers always calculate their distribution based on sorted nami .. 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=