X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Flibmemcached_configuration.rst;h=8cd48ce2ed061fc2078ac4bb311c15fa2bfa041b;hb=7253c10fe79f6a72b0aec419560823a16ad55a0a;hp=74902aab7663d987a00aa95d6fdf4e05b3c1028b;hpb=a6c3e3a3d04f379b1480c8c88a8eae17e54b1449;p=m6w6%2Flibmemcached diff --git a/docs/libmemcached_configuration.rst b/docs/libmemcached_configuration.rst index 74902aab..8cd48ce2 100644 --- a/docs/libmemcached_configuration.rst +++ b/docs/libmemcached_configuration.rst @@ -2,7 +2,7 @@ Configuring Libmemcached ======================== -.. index:: object: memcached_st +.. highlightlang:: c -------- SYNOPSIS @@ -17,19 +17,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=:/? 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. @@ -186,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.