Merge pull request #140 from hussainnaqvee/patch-1

[awesomized/libmemcached] / docs / source / bin / memflush.rst

diff --git a/docs/source/bin/memflush.rst b/docs/source/bin/memflush.rst
index a2b9894d6e72ac236fee0ef688e71382993d1866..dc04ca630854d422da44788ab32923238af3efa4 100644 (file)
--- a/docs/source/bin/memflush.rst
+++ b/docs/source/bin/memflush.rst
@@ -1,67 +1,73 @@
-=======================================
-memflush - flush all data from a server
-=======================================
+memflush
+========
 
-
-Reset a server or list of servers
-
-
---------
 SYNOPSIS
 --------
 
-memflush [options]
+|client_prefix|\flush [options]
 
 .. program:: memflush
 
------------
+Reset a server or list of servers
+
 DESCRIPTION
 -----------
 
+:program:`memflush`  resets the contents of :manpage:`memcached(1)` servers.
 
-:program:`memflush`  resets the contents of memcached(1) servers.
-This means that all data in the specified servers will be deleted.
+.. warning::
 
+    This means that all data in the specified servers will be deleted.
 
--------
 OPTIONS
 -------
 
+.. include:: options/common_get.rst
+.. include:: options/expire.rst
 
-You can specify servers via the option:
-
-.. option:: --servers
+.. note::
 
-or via the environment variable:
+    Using an expiration time (period), all keys, which have not bean updated until expiration will cease to exist.
 
-.. envvar:: `MEMCACHED_SERVERS`
+    Quoting the `memcached protocol documentation`_, it states:
 
-For a full list of operations run the tool with option:
+        Its effect is to invalidate all
+        existing items immediately (by default) or after the expiration
+        specified.  After invalidation none of the items will be returned in
+        response to a retrieval command (unless it's stored again under the
+        same key *after* flush_all has invalidated the items).
 
-.. option:: --help
+        The most precise
+        definition of what flush_all does is the following: it causes all
+        items whose update time is earlier than the time at which flush_all
+        was set to be executed to be ignored for retrieval purposes.
 
+        The intent of flush_all with a delay, was that in a setting where you
+        have a pool of memcached servers, and you need to flush all content,
+        you have the option of not resetting all memcached servers at the
+        same time (which could e.g. cause a spike in database load with all
+        clients suddenly needing to recreate content that would otherwise
+        have been found in the memcached daemon).
 
-----
-HOME
-----
+.. _memcached protocol documentation: https://github.com/memcached/memcached/blob/master/doc/protocol.txt
 
 
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
+.. include:: common/env.rst
 
+NOTES
+-----
 
-------
-AUTHOR
-------
+.. include:: common/note_program_prefix.rst
 
+SEE ALSO
+--------
 
-Brian Aker, <brian@tangent.org>
-
-Mark Atwood <mark@fallenpegasus.com>
+.. only:: man
 
+  :manpage:`memcached(1)`
+  :manpage:`libmemcached(3)`
 
---------
-SEE ALSO
---------
+.. only:: html
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+* :doc:`/libmemcached`
+* :doc:`/libmemcached/memcached_flush`