docs: bin/

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

diff --git a/docs/source/bin/memstat.rst b/docs/source/bin/memstat.rst
index a6cc4ba9fc5acb3fd561d5d3b7711789a2be6fe5..3b440de91a28ad4a5c60f26509e347bc7ac0f0b9 100644 (file)
--- a/docs/source/bin/memstat.rst
+++ b/docs/source/bin/memstat.rst
@@ -1,8 +1,5 @@
-=========================================
-memstat - Gather statistics from a server
-=========================================
-
-memstat - Display the operating status of a single or group of memcached servers
+memstat
+=======
 
 SYNOPSIS
 --------
@@ -11,35 +8,52 @@ memstat [options]
 
 .. program:: memstat
 
+Gather statistics from a server
+
 DESCRIPTION
 -----------
 
-:program:`memstat`  dumps the state of memcached(1) servers.
-It displays all data to stdout.
+:program:`memstat`  dumps the state of :manpage:`memcached(1)` servers.
+It prints all data to stdout.
 
 OPTIONS
 -------
 
-You can specify servers via the option:
+.. include:: options/all.rst
+.. include:: options/common.rst
+.. include:: options/sasl.rst
 
-.. option:: --servers
+.. option:: --analyze
 
-or via the environment variable:
+    Analyze and print differences of a server cluster. A memory and uptime comparison is performed by default.
 
-.. envvar:: 'MEMCACHED_SERVERS, --args'
+    Available additional modes:
 
-which can be used to specify the "argument" sent to the stats command (ie slab, size, items, etc..).
+    --analyze=latency
+        Network latency comparison
 
-For a full list of operations run the tool with:
 
-.. option:: --help
 
-.. option:: --analyze
+.. option:: --server-version
+
+    Obtain and print server version(s) only.
+
+ENVIRONMENT
+-----------
+
+.. envvar:: MEMCACHED_SERVERS
+
+    Specify the list of servers.
 
 SEE ALSO
 --------
 
 .. only:: man
 
-  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
+  :manpage:`memcached(1)`
+  :manpage:`libmemcached(3)`
+
+.. only:: html
 
+* :doc:`/libmemcached`
+* :doc:`/libmemcached/memcached_stats`