X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Flibmemcached_configuration.rst;h=8cd48ce2ed061fc2078ac4bb311c15fa2bfa041b;hb=ec18b17736a6e0ce98994daf5a6576e9658e4a1d;hp=abbdad0a67173e95201434b47eb31627d0e35936;hpb=41543e45ff7aca5456c9279bc0403ecdc35f7b6e;p=m6w6%2Flibmemcached diff --git a/docs/libmemcached_configuration.rst b/docs/libmemcached_configuration.rst index abbdad0a..8cd48ce2 100644 --- a/docs/libmemcached_configuration.rst +++ b/docs/libmemcached_configuration.rst @@ -2,32 +2,37 @@ Configuring Libmemcached ======================== +.. highlightlang:: c + -------- SYNOPSIS -------- +#include .. 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=:/? 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. @@ -184,7 +189,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.