Replace pod docs with sphinx docs.

[awesomized/libmemcached] / docs / memcached_flush.rst

diff --git a/docs/memcached_flush.rst b/docs/memcached_flush.rst
new file mode 100644 (file)
index 0000000..0c6538b
--- /dev/null
+++ b/docs/memcached_flush.rst
@@ -0,0 +1,82 @@
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+memcached_flush - wipe contents of memcached servers
+
+
+*******
+LIBRARY
+*******
+
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+
+********
+SYNOPSIS
+********
+
+
+
+.. code-block:: perl
+
+   #include <memcached.h>
+ 
+   memcached_return_t
+     memcached_flush (memcached_st *ptr,
+                      time_t expiration);
+
+
+
+***********
+DESCRIPTION
+***********
+
+
+memcached_flush() is used to wipe clean the contents of memcached(1) servers.
+It will either do this immediately or expire the content based on the
+expiration time passed to the method (a value of zero causes an immediate
+flush). The operation is not atomic to multiple servers, just atomic to a
+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
+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 <https://launchpad.net/libmemcached>`_
+
+
+******
+AUTHOR
+******
+
+
+Brian Aker, <brian@tangent.org>
+
+
+********
+SEE ALSO
+********
+
+
+memcached(1) libmemcached(3) memcached_strerror(3)
+