fix #134: docs: update client options

diff --git a/ChangeLog-1.1.md b/ChangeLog-1.1.md
index b6ecaa77718d929148c668405bd6c4acc94f8fd2..851c730b94c6c87658459bb27c15125efff87ddf 100644 (file)
--- a/ChangeLog-1.1.md
+++ b/ChangeLog-1.1.md
@@ -4,10 +4,12 @@
 
 > released TBA
 
-* Fix [gh #132](https://github.com/awesomized/libmemcached/issues/132):
+* Fix [gh #107](https://github.com/awesomized/libmemcached/issues/107):
   macOS: deprecated sasl API (improve detection of `libsasl2`).
 * Fix [gh #132](https://github.com/awesomized/libmemcached/issues/132):
   Add build of static library (with `cmake -DBUILD_SHARED_LIBS=OFF`).
+* Fix [gh #134](https://github.com/awesomized/libmemcached/issues/134):
+  Update client option documentation.
 * Fix [gh #136](https://github.com/awesomized/libmemcached/issues/136):
   `libmemcachedutil` is underlinked (link against libmemcached).
 

diff --git a/docs/source/ChangeLog-1.1.rst b/docs/source/ChangeLog-1.1.rst
index e79cad3e283fb546d125bd97e3afd89ff822c79c..1582019a480febc38b4eb7b43591e45852f09787 100644 (file)
--- a/docs/source/ChangeLog-1.1.rst
+++ b/docs/source/ChangeLog-1.1.rst
@@ -14,10 +14,12 @@ v1.1.4
 
 
 
-* Fix `gh #132 <https://github.com/awesomized/libmemcached/issues/132>`_\ :
+* Fix `gh #107 <https://github.com/awesomized/libmemcached/issues/107>`_\ :
   macOS: deprecated sasl API (improve detection of ``libsasl2``\ ).
 * Fix `gh #132 <https://github.com/awesomized/libmemcached/issues/132>`_\ :
   Add build of static library (with ``cmake -DBUILD_SHARED_LIBS=OFF``\ ).
+* Fix `gh #134 <https://github.com/awesomized/libmemcached/issues/134>`_\ :
+  Update client option documentation.
 * Fix `gh #136 <https://github.com/awesomized/libmemcached/issues/136>`_\ :
   ``libmemcachedutil`` is underlinked (link against libmemcached).
 

diff --git a/docs/source/bin/memaslap.rst b/docs/source/bin/memaslap.rst
index 240c9281e3d6ec0bf57a41dac1723f72e8d72ecd..ab311d7398e0cdb8c8b494779660145c27c062cb 100644 (file)
--- a/docs/source/bin/memaslap.rst
+++ b/docs/source/bin/memaslap.rst
@@ -10,6 +10,7 @@ memaslap [options]
 .. program:: memaslap
 
 .. option:: --help
+.. option:: --servers
 
 .. envvar:: MEMCACHED_SERVERS
 
@@ -29,7 +30,7 @@ the threads don't communicate with each other, and there are several socket
 connections in each thread. Each connection keeps key size distribution,
 value size distribution, and command distribution by itself.
 
-You can specify servers via the :option:`memslap --servers` option or via the
+You can specify servers via the :option:`memaslap --servers` option or via the
 environment variable :envvar:`MEMCACHED_SERVERS`.
 
 FEATURES
@@ -999,6 +1000,14 @@ memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m
 
 memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2
 
+NOTE
+----
+
+This is a contributed program.
+
+This program doesn't follow the standard flag/option scheme.
+
+
 SEE ALSO
 --------
 

diff --git a/docs/source/bin/memcapable.rst b/docs/source/bin/memcapable.rst
index d1a4f7a4d60adbb059cbc497d4facc1deeee1d76..374c9c335e98b6a4d6b5a8788c03bfaffe88b31e 100644 (file)
--- a/docs/source/bin/memcapable.rst
+++ b/docs/source/bin/memcapable.rst
@@ -39,6 +39,12 @@ OPTIONS
 
     Set the timeout for an IO operation to/from the server to \ *n*\  seconds.
 
+NOTE
+----
+
+This program doesn't follow the standard flag/option scheme.
+
+
 SEE ALSO
 --------
 

diff --git a/docs/source/bin/memcat.rst b/docs/source/bin/memcat.rst
index aa6cc540053f48401eaf17925fa2a5c9a56ebe5b..36f6a6bb2ef97c305a50c141e8310df7b1766d02 100644 (file)
--- a/docs/source/bin/memcat.rst
+++ b/docs/source/bin/memcat.rst
@@ -23,13 +23,10 @@ It is similar to the standard UNIX :manpage:`cat(1)` utility.
 OPTIONS
 -------
 
-.. include:: options/all.rst
-.. include:: options/common.rst
+.. include:: options/common_get.rst
+.. include:: options/flags_noarg.rst
 .. include:: options/hash.rst
-
-.. option:: --flag
-
-    Display stored flags.
+.. include:: options/file_out.rst
 
 ENVIRONMENT
 -----------

diff --git a/docs/source/bin/memcp.rst b/docs/source/bin/memcp.rst
index deea12a77d1cd3af9e866570325f6c23e8e43762..7d82a59090c3c0126502ca18e90506fed81f6835 100644 (file)
--- a/docs/source/bin/memcp.rst
+++ b/docs/source/bin/memcp.rst
@@ -21,31 +21,36 @@ The key names will be the names of the files, without any directory path.
 OPTIONS
 -------
 
-.. include:: options/all.rst
-.. include:: options/common.rst
-.. include:: options/expire.rst
-.. include:: options/flag.rst
-.. include:: options/hash.rst
-.. include:: options/sasl.rst
+.. include:: options/common_set.rst
+.. include:: /bin/options/flags_reqarg.rst
 .. include:: options/udp.rst
 
-.. option:: --buffer
-
-    Enable internal buffering of commands.
-
-.. option:: --set
+.. option:: -S|--set
 
     Issue *SET* command(s). This is the default mode.
-    See also :option:`--add` and :option:`--replace`.
+    See also :option:`-A|--add` and :option:`-R|--replace`.
 
-.. option:: --add
+.. option:: -A|--add
 
     Issue *ADD* command(s).
 
-.. option:: --replace
+.. option:: -R|--replace
 
     Issue *REPLACE* command(s).
 
+.. option:: -.|--basename
+
+    Use basename of path as key (default).
+    
+.. option:: -+|--relative
+
+    Use relative path (as passed), instead of basename only.
+    
+.. option:: -/|--absolute
+
+    Use absolute path (real path), instead of basename only.
+    
+    
 ENVIRONMENT
 -----------
 

diff --git a/docs/source/bin/memdump.rst b/docs/source/bin/memdump.rst
index 07eb2fff38469b8cb5cc1cd522fc03b9b504f604..a24e40854a3af60b6eb33ea41c3b6672806bcc8c 100644 (file)
--- a/docs/source/bin/memdump.rst
+++ b/docs/source/bin/memdump.rst
@@ -20,11 +20,9 @@ provide all keys it is not possible to get a complete "dump".
 OPTIONS
 -------
 
-.. include:: options/all.rst
-.. include:: options/common.rst
-.. include:: options/hash.rst
-.. include:: options/sasl.rst
-
+.. include:: options/common_get.rst
+.. include:: options/file_out.rst
+ 
 ENVIRONMENT
 -----------
 

diff --git a/docs/source/bin/memerror.rst b/docs/source/bin/memerror.rst
index 525aaf63022c6462ad5601459221de87a065e861..caa6b497657d719f14cc6f39758598f472aafbb7 100644 (file)
--- a/docs/source/bin/memerror.rst
+++ b/docs/source/bin/memerror.rst
@@ -20,6 +20,7 @@ OPTIONS
 -------
 
 .. include:: options/all.rst
+.. include:: options/common.rst
 
 ENVIRONMENT
 -----------

diff --git a/docs/source/bin/memexist.rst b/docs/source/bin/memexist.rst
index 1859c83880b8ee73308e270a0485e62274095ec2..52832b16149abab2b3c1aeecb93dd349ef55b0ec 100644 (file)
--- a/docs/source/bin/memexist.rst
+++ b/docs/source/bin/memexist.rst
@@ -18,10 +18,8 @@ DESCRIPTION
 OPTIONS
 -------
 
-.. include:: options/all.rst
-.. include:: options/common.rst
+.. include:: options/common_get.rst
 .. include:: options/hash.rst
-.. include:: options/sasl.rst
 
 ENVIRONMENT
 -----------

diff --git a/docs/source/bin/memflush.rst b/docs/source/bin/memflush.rst
index ed84d9a9f7e318551cdf840fa11ee0bc796bf7b4..b752b6eb8861613e8706229ee578d837019b6f17 100644 (file)
--- a/docs/source/bin/memflush.rst
+++ b/docs/source/bin/memflush.rst
@@ -22,9 +22,7 @@ DESCRIPTION
 OPTIONS
 -------
 
-.. include:: options/all.rst
-.. include:: options/common.rst
-.. include:: options/sasl.rst
+.. include:: options/common_get.rst
 .. include:: options/expire.rst
 
 .. note::

diff --git a/docs/source/bin/memping.rst b/docs/source/bin/memping.rst
index fff7db223e9d8f0c55d9d3b379e3cd508e68ad20..aaae7a7a09410345c2089b6f39fd7b0d1db45166 100644 (file)
--- a/docs/source/bin/memping.rst
+++ b/docs/source/bin/memping.rst
@@ -22,6 +22,11 @@ OPTIONS
 .. include:: options/common.rst
 .. include:: options/sasl.rst
 
+.. option:: -s|--servers <list of servers>
+
+    Specify the list of servers as *hostname[:port][,hostname[:port]...]*.
+
+
 ENVIRONMENT
 -----------
 

diff --git a/docs/source/bin/memrm.rst b/docs/source/bin/memrm.rst
index e3edd3190f3048d2d5719d39d0b591ef337dd4e9..94da5a7be47ee7729ff62e89b72d6a6eaae1549d 100644 (file)
--- a/docs/source/bin/memrm.rst
+++ b/docs/source/bin/memrm.rst
@@ -18,10 +18,7 @@ DESCRIPTION
 OPTIONS
 -------
 
-.. include:: options/all.rst
-.. include:: options/common.rst
-.. include:: options/hash.rst
-.. include:: options/sasl.rst
+.. include:: options/common_set.rst
 
 ENVIRONMENT
 -----------

diff --git a/docs/source/bin/memslap.rst b/docs/source/bin/memslap.rst
index 1abf45f611b6e0fce469b92fcf5196f39e099354..bd99ab4975d8c7b61141ed6a96ec6c5d16e70752 100644 (file)
--- a/docs/source/bin/memslap.rst
+++ b/docs/source/bin/memslap.rst
@@ -21,8 +21,34 @@ throughput, and so on.
 OPTIONS
 -------
 
-.. include:: options/all.rst
-.. include:: options/common.rst
+.. include:: options/common_get.rst
+.. include:: options/hash.rst
+.. include:: options/udp.rst
+
+.. option:: -R|--noreply
+
+    Enable the NOREPLY behavior for storage commands.
+
+.. option:: -F|--flush
+
+    Flush all servers prior test.
+
+.. option:: -t|--test <arg>
+
+    Test to perform (options: get, mget, set; default: get).
+
+.. option:: -c|--concurrency <num>
+
+    Concurrency (number of threads to start; default: 1).
+
+.. option:: -e|--execute-number <num>
+
+    Number of times to execute the tests (default: 10000).
+
+.. option:: -l|--initial-load <num>
+
+    Number of keys to load before executing tests (default: 10000).
+
 
 ENVIRONMENT
 -----------

diff --git a/docs/source/bin/memstat.rst b/docs/source/bin/memstat.rst
index 3b440de91a28ad4a5c60f26509e347bc7ac0f0b9..7c2b96251bd6dd8c44a294a134a4fc98e55d8a3d 100644 (file)
--- a/docs/source/bin/memstat.rst
+++ b/docs/source/bin/memstat.rst
@@ -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
 -----------
 

diff --git a/docs/source/bin/memtouch.rst b/docs/source/bin/memtouch.rst
index 4e55ab15963d07fc1fb3bf373dbbb842f02b25f5..c9e03406916178086d7d9b8e3a79e183cf67d16d 100644 (file)
--- a/docs/source/bin/memtouch.rst
+++ b/docs/source/bin/memtouch.rst
@@ -16,11 +16,9 @@ DESCRIPTION
 OPTIONS
 -------
 
-.. include:: options/all.rst
-.. include:: options/common.rst
-.. include:: options/expire.rst
+.. include:: options/common_get.rst
 .. include:: options/hash.rst
-.. include:: options/sasl.rst
+.. include:: options/expire.rst
 
 SEE ALSO
 --------

diff --git a/docs/source/bin/options/all.rst b/docs/source/bin/options/all.rst
index 5955282dc854e463d6c7a1ff8ab176e7737b1de9..951b2ee1e4b1519adf7a47ad00a802a72999fb50 100644 (file)
--- a/docs/source/bin/options/all.rst
+++ b/docs/source/bin/options/all.rst
@@ -1,8 +1,8 @@
-.. option:: --help
+.. option:: -h|--help
 
     Display help.
 
-.. option:: --version
+.. option:: -V|--version
 
     Display version.
 

diff --git a/docs/source/bin/options/common.rst b/docs/source/bin/options/common.rst
index 9acb684dc3a47c9f986682f020182bef2266afd8..04802b75f8483169dac1bd7732524ffd61f496f5 100644 (file)
--- a/docs/source/bin/options/common.rst
+++ b/docs/source/bin/options/common.rst
@@ -1,20 +1,11 @@
-.. option:: --quiet
+.. option:: -q|--quiet
 
     Operate quietly.
 
-.. option:: --verbose
+.. option:: -v|--verbose
 
     Operate more verbosely.
 
-.. option:: --debug
-
-    See :option:`--verbose`.
-
-.. option:: --servers <list of servers>
-
-    Specify the list of servers as *hostname[:port][,hostname[:port]...]*.
-
-.. option:: --binary
-
-    Enable binary protocol.
+.. option:: -d|--debug
 
+    See :option:`-v\|--verbose`.

diff --git a/docs/source/bin/options/common_get.rst b/docs/source/bin/options/common_get.rst
new file mode 100644 (file)
index 0000000..7416930
--- /dev/null
+++ b/docs/source/bin/options/common_get.rst
@@ -0,0 +1,6 @@
+
+.. include:: /bin/options/all.rst
+.. include:: /bin/options/common.rst
+.. include:: /bin/options/net.rst
+.. include:: /bin/options/proto.rst
+.. include:: /bin/options/sasl.rst

diff --git a/docs/source/bin/options/common_set.rst b/docs/source/bin/options/common_set.rst
new file mode 100644 (file)
index 0000000..e4cf8f0
--- /dev/null
+++ b/docs/source/bin/options/common_set.rst
@@ -0,0 +1,8 @@
+
+.. include:: /bin/options/all.rst
+.. include:: /bin/options/common.rst
+.. include:: /bin/options/expire.rst
+.. include:: /bin/options/hash.rst
+.. include:: /bin/options/net.rst
+.. include:: /bin/options/proto.rst
+.. include:: /bin/options/sasl.rst

diff --git a/docs/source/bin/options/expire.rst b/docs/source/bin/options/expire.rst
index 2f6093561d8cb0650548ef79a44bf6c250ed62fd..9fcd170d922229b9a73ee10efb607500d59807d5 100644 (file)
--- a/docs/source/bin/options/expire.rst
+++ b/docs/source/bin/options/expire.rst
@@ -1,4 +1,4 @@
-.. option:: --expire <expiration>
+.. option:: -e|--expire <expiration>
 
     Use *expiration* seconds (or a UNIX timestamp).
 

diff --git a/docs/source/bin/options/file_out.rst b/docs/source/bin/options/file_out.rst
new file mode 100644 (file)
index 0000000..21de316
--- /dev/null
+++ b/docs/source/bin/options/file_out.rst
@@ -0,0 +1,6 @@
+
+.. option:: -f|--file [<file>]
+
+    Output to file instead of standard output.
+    
+    *NOTE:* defaults to <key> if no argument was provided.

diff --git a/docs/source/bin/options/flag.rst b/docs/source/bin/options/flag.rst
deleted file mode 100644 (file)
index f6d2618..0000000
--- a/docs/source/bin/options/flag.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-.. option:: --flag <number>
-
-    Use *number* as flag.
-

diff --git a/docs/source/bin/options/flags_noarg.rst b/docs/source/bin/options/flags_noarg.rst
new file mode 100644 (file)
index 0000000..f080163
--- /dev/null
+++ b/docs/source/bin/options/flags_noarg.rst
@@ -0,0 +1,4 @@
+.. option:: -F|--flags
+
+    Display key's flags.
+

diff --git a/docs/source/bin/options/flags_reqarg.rst b/docs/source/bin/options/flags_reqarg.rst
new file mode 100644 (file)
index 0000000..999329c
--- /dev/null
+++ b/docs/source/bin/options/flags_reqarg.rst
@@ -0,0 +1,4 @@
+.. option:: -F|--flags <number>
+
+    Use *number* as key's flags.
+

diff --git a/docs/source/bin/options/hash.rst b/docs/source/bin/options/hash.rst
index 78d84deeae190fe33d55335a46f9d7f3d849f269..00c3df5cc03b1872a3fadad3a4bf85277e70802e 100644 (file)
--- a/docs/source/bin/options/hash.rst
+++ b/docs/source/bin/options/hash.rst
@@ -1,4 +1,4 @@
-.. option:: --hash <algorithm>
+.. option:: -H|--hash <algorithm>
 
     Use *algorithm* as key hash algo.
     See :enumerator:`memcached_behavior_t::MEMCACHED_BEHAVIOR_HASH`.

diff --git a/docs/source/bin/options/net.rst b/docs/source/bin/options/net.rst
new file mode 100644 (file)
index 0000000..3c2bf70
--- /dev/null
+++ b/docs/source/bin/options/net.rst
@@ -0,0 +1,12 @@
+
+.. option:: -s|--servers <list of servers>
+
+    Specify the list of servers as *hostname[:port][,hostname[:port]...]*.
+
+.. option:: -n|--non-blocking
+
+    Enable non-blocking operations.
+
+.. option:: -N|--tcp-nodelay
+
+    Disable Nagle's algorithm.

diff --git a/docs/source/bin/options/proto.rst b/docs/source/bin/options/proto.rst
new file mode 100644 (file)
index 0000000..97d015b
--- /dev/null
+++ b/docs/source/bin/options/proto.rst
@@ -0,0 +1,8 @@
+
+.. option:: -b|--binary
+
+    Enable binary protocol.
+
+.. option:: -B|--buffer
+
+    Buffer requests.

diff --git a/docs/source/bin/options/sasl.rst b/docs/source/bin/options/sasl.rst
index 8d664c34711c472c2aa8cffbab3fe273f0cdc786..33feee7aa1d1949265cc35c8446879936d930826 100644 (file)
--- a/docs/source/bin/options/sasl.rst
+++ b/docs/source/bin/options/sasl.rst
@@ -1,8 +1,8 @@
-.. option:: --username <username>
+.. option:: -u|--username <username>
 
     Use *username* for SASL authentication.
 
-.. option:: --password <password>
+.. option:: -p|--password <password>
 
     Use *password* for SASL authentication.
 

diff --git a/docs/source/bin/options/udp.rst b/docs/source/bin/options/udp.rst
index ae486b3ea28d4ab8e0a170fb6156588df6fc8ac2..4c5e8d134d3b74a65e4f046b3017c90628d53076 100644 (file)
--- a/docs/source/bin/options/udp.rst
+++ b/docs/source/bin/options/udp.rst
@@ -1,4 +1,4 @@
-.. option:: --udp
+.. option:: -U|--udp
 
     Enable UDP operation mode.