X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_flush.rst;h=a18866609054b47085e7d42897d31d59628be842;hb=1a237369acc2140ec76f46202dfde37047ef140d;hp=0c6538b029f6f5eb52c16c833d77fa0325251eb8;hpb=49fc1e5ea4ea006f4a2ac71428833760f6fac030;p=awesomized%2Flibmemcached diff --git a/docs/memcached_flush.rst b/docs/memcached_flush.rst index 0c6538b0..a1886660 100644 --- a/docs/memcached_flush.rst +++ b/docs/memcached_flush.rst @@ -1,41 +1,26 @@ -.. highlight:: perl +===================================== +Wiping clean the contents of a server +===================================== -**** -NAME -**** +Wipe contents of memcached servers -memcached_flush - wipe contents of memcached servers - - -******* -LIBRARY -******* - - -C Client Library for memcached (libmemcached, -lmemcached) - - -******** +-------- SYNOPSIS -******** - - +-------- -.. code-block:: perl - #include +#include - memcached_return_t - memcached_flush (memcached_st *ptr, - time_t expiration); +.. c:function:: memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration); +Compile and link with -lmemcached -*********** +----------- DESCRIPTION -*********** +----------- memcached_flush() is used to wipe clean the contents of memcached(1) servers. @@ -46,9 +31,9 @@ single server. That is, it will flush the servers in the order that they were added. -****** +------ RETURN -****** +------ A value of type \ ``memcached_return_t``\ is returned @@ -56,27 +41,25 @@ On success that value will be \ ``MEMCACHED_SUCCESS``\ . Use memcached_strerror() to translate this value to a printable string. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** +------ AUTHOR -****** +------ Brian Aker, -******** +-------- SEE ALSO -******** - - -memcached(1) libmemcached(3) memcached_strerror(3) +-------- +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`