projects
/
awesomized
/
libmemcached
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
|
github
raw
|
inline
| side by side
Merge of all doc fixes.
[awesomized/libmemcached]
/
docs
/
memcached_flush.rst
diff --git
a/docs/memcached_flush.rst
b/docs/memcached_flush.rst
index 0c6538b029f6f5eb52c16c833d77fa0325251eb8..a18866609054b47085e7d42897d31d59628be842 100644
(file)
--- 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
SYNOPSIS
-********
-
-
+--------
-.. code-block:: perl
-
#include <
memcached.h>
+
#include <libmemcached/
memcached.h>
- 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
DESCRIPTION
-***********
+-----------
memcached_flush() is used to wipe clean the contents of memcached(1) servers.
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.
added.
-******
+------
RETURN
RETURN
-******
+------
A value of type \ ``memcached_return_t``\ is returned
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.
Use memcached_strerror() to translate this value to a printable string.
-****
+----
HOME
HOME
-****
+----
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-******
+------
AUTHOR
AUTHOR
-******
+------
Brian Aker, <brian@tangent.org>
Brian Aker, <brian@tangent.org>
-********
+--------
SEE ALSO
SEE ALSO
-********
-
-
-memcached(1) libmemcached(3) memcached_strerror(3)
+--------
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`