fix #134: docs: update client options
[awesomized/libmemcached] / docs / source / bin / memstat.rst
index 3b440de91a28ad4a5c60f26509e347bc7ac0f0b9..7c2b96251bd6dd8c44a294a134a4fc98e55d8a3d 100644 (file)
@@ -4,7 +4,7 @@ memstat
 SYNOPSIS
 --------
 
-memstat [options]
+memstat [options] [stat args] 
 
 .. program:: memstat
 
@@ -19,25 +19,36 @@ It prints all data to stdout.
 OPTIONS
 -------
 
-.. include:: options/all.rst
-.. include:: options/common.rst
-.. include:: options/sasl.rst
+.. include:: options/common_get.rst
 
-.. option:: --analyze
+.. option:: -A|--args <stat>
 
-    Analyze and print differences of a server cluster. A memory and uptime comparison is performed by default.
+    Stat args.
 
-    Available additional modes:
+    **DEPRECATED:** use positional arguments.
 
-    --analyze=latency
-        Network latency comparison
+.. option:: -a|--analyze [<arg>]
+
+    Analyze and print differences of a server cluster.
+    A memory and uptime comparison is performed by default.
 
+    Options:
+    
+    --analyze[=default]
+        Memory and uptime comparison.
 
+    --analyze=latency
+        Network latency comparison.
 
-.. option:: --server-version
+.. option:: -S|-server-version
 
     Obtain and print server version(s) only.
 
+.. option:: --iterations
+
+    Iteration count of GETs sent by the latency test (default: 1000).
+
+
 ENVIRONMENT
 -----------