X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_flush.rst;h=c38ad499896b7087c2249322a04c84af30132eb9;hb=8d6fea01b19bd27ae85d9981ac7d3a40b8d83987;hp=0c6538b029f6f5eb52c16c833d77fa0325251eb8;hpb=c4dbc7e56b01545e25bc95ba122c79d4a2631a99;p=m6w6%2Flibmemcached diff --git a/docs/memcached_flush.rst b/docs/memcached_flush.rst index 0c6538b0..c38ad499 100644 --- a/docs/memcached_flush.rst +++ b/docs/memcached_flush.rst @@ -1,41 +1,27 @@ -.. highlight:: perl +===================================== +Wiping clean the contents of a server +===================================== +.. index:: object: memcached_st -**** -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 +32,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 +42,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 `_ +`http://libmemcached.org/ `_ -****** +------ AUTHOR -****** +------ Brian Aker, -******** +-------- SEE ALSO -******** - - -memcached(1) libmemcached(3) memcached_strerror(3) +-------- +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`