docs: bin/

diff --git a/.gitignore b/.gitignore
index 6e4a3f49fb7a3eb8a28a9537b83a0e1281f3b1e5..ffe575ca57525173a7134a42d3217a30d19ea346 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -42,6 +42,7 @@ src/bin/memslap
 src/bin/memstat
 src/bin/memtouch
 cmake-build-*/
+ccmake-*/
 example/memcached_light
 example/t/memcached_light
 tags

diff --git a/docs/source/bin/index.rst b/docs/source/bin/index.rst
index 67dc61cb4705b30b744299e033ea4854c90f72bf..6385e8ef03a3c8ecf2a8a187da0a579af383562a 100644 (file)
--- a/docs/source/bin/index.rst
+++ b/docs/source/bin/index.rst
@@ -1,20 +1,37 @@
 Client Applications
 ===================
 
+Data Manipulation
+-----------------
+
 .. toctree::
     :titlesonly:
-    
-    memcapable
-    memcat
-    memcp
-    memdump
-    memerror
-    memflush
-    memrm
-    memslap
+
+    memexist — Check for the existence of a key <memexist>
+    memcat — "cat" data from a server <memcat>
+    memcp — "cp" files to a server <memcp>
+    memtouch — "touch" a key <memtouch>
+    memrm – "rm" a key <memrm>
+
+Tests and Analysis
+------------------
+
+.. toctree::
+    :titlesonly:
+
     memaslap
-    memstat
-    memexist
-    memparse
-    memping
-    memtouch
+    memslap
+    memping – Ping a server <memping>
+    memstat – Gather statistics from a server <memstat>
+    memerror — Translate libmemcached error codes <memerror>
+    memparse — Parse and validate an option string <memparse>
+    memcapable — Check a server's capabilities and compatibility <memcapable>
+
+Server Administration
+---------------------
+
+.. toctree::
+    :titlesonly:
+
+    memdump — Dump a server's data <memdump>
+    memflush — Flush a server (erase all cached data) <memflush>

diff --git a/docs/source/bin/memcapable.rst b/docs/source/bin/memcapable.rst
index f8290333109f2b0daede4f6291b51de3aa9eea55..d1a4f7a4d60adbb059cbc497d4facc1deeee1d76 100644 (file)
--- a/docs/source/bin/memcapable.rst
+++ b/docs/source/bin/memcapable.rst
@@ -1,53 +1,52 @@
-=======================================================================
-memcapable - Checking a Memcached server capabilities and compatibility
-=======================================================================
+memcapable
+==========
 
 SYNOPSIS
 --------
 
+.. program:: memcapable
+
 memcapable [options]
 
-.. program:: memcapable
+Check a memcached server's capabilities and compatibility.
 
 DESCRIPTION
 -----------
 
 :program:`memcapable` connects to the specified memcached server and tries to
-determine its capabilities by running the various commands and verifying
-the response.
-
-LIMITATIONS
------------
-
-The current version of memcapable will only verify the binary protocol.
+determine its capabilities by running various commands and verifying the response.
 
 OPTIONS
 -------
 
 .. option:: -h hostname
 
-Specify the hostname to connect to. The default is \ *localhost*\ 
+    Specify the hostname to connect to. The default is \ *localhost*\ .
 
 .. option:: -p port
 
-Specify the port number to connect to. The default is \ *11211*\ 
+    Specify the port number to connect to. The default is \ *11211*\ .
 
 .. option:: -c
 
-Generate a coredump when it detects an error from the server.
+    :manpage:`abort(3)` when detecting an error from the server.
 
 .. option:: -v
 
-Print out the comparison when it detects an error from the server.
+    Print out the comparison when it detects an error from the server.
 
 .. option:: -t n
 
-Set the timeout from an IO operation to/from the server to \ *n*\  seconds.
+    Set the timeout for an IO operation to/from the server to \ *n*\  seconds.
 
 SEE ALSO
 --------
 
 .. only:: man
 
-  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
+  :manpage:`memcached(1)`
+  :manpage:`libmemcached(3)`
+
+.. only:: html
 
+  * :doc:`/libmemcached`

diff --git a/docs/source/bin/memcat.rst b/docs/source/bin/memcat.rst
index c3a6b65e16a596c65ff7763d6a836d1c713cd26b..aa6cc540053f48401eaf17925fa2a5c9a56ebe5b 100644 (file)
--- a/docs/source/bin/memcat.rst
+++ b/docs/source/bin/memcat.rst
@@ -1,43 +1,53 @@
-=================================
-memcat - "cat" data from a server
-=================================
+memcat
+======
 
 SYNOPSIS
 --------
 
-memcat [options] key
+.. program:: memcat
 
-Copy a set of keys to stdout
+memcat [options] key [key...]
 
-.. program:: memcat
+Read and output the value of one key or the values of a set of keys.
 
 DESCRIPTION
 -----------
 
-:program:`memcat` outputs to stdout the value a single or multiple set of keys
-stored in a memcached(1) server. If any key is not found an error is returned.
+:program:`memcat` reads and outputs the value of a single or a set of keys
+stored in a :manpage:`memcached(1)` server.
+
+If any key is not found an error is returned.
 
-It is similar to the standard UNIX cat(1) utility.
+It is similar to the standard UNIX :manpage:`cat(1)` utility.
 
 OPTIONS
 -------
 
-You can specify servers via the option:
+.. include:: options/all.rst
+.. include:: options/common.rst
+.. include:: options/hash.rst
 
-.. option:: --servers
+.. option:: --flag
 
-or via the environment variable:
+    Display stored flags.
 
-.. envvar:: `MEMCACHED_SERVERS`
+ENVIRONMENT
+-----------
 
-For a full list of operations run the tool with the option:
+.. envvar:: MEMCACHED_SERVERS
 
-.. option:: --help
+    Specify a list of servers.
 
 SEE ALSO
 --------
 
 .. only:: man
 
-  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
+  :manpage:`memcached(1)`
+  :manpage:`libmemcached(3)`
+  :manpage:`libmemcached_configuration(3)`
+
+.. only:: html
 
+  * :doc:`/libmemcached`
+  * :doc:`/libmemcached/configuration`

diff --git a/docs/source/bin/memcp.rst b/docs/source/bin/memcp.rst
index e67cd28e42cf2d1b87c81045aad3022692b3b3a6..deea12a77d1cd3af9e866570325f6c23e8e43762 100644 (file)
--- a/docs/source/bin/memcp.rst
+++ b/docs/source/bin/memcp.rst
@@ -1,46 +1,69 @@
-=============================
-memcp - Copy data to a server
-=============================
-
-Copies files to a collection of memcached servers
+memcp
+=====
 
 SYNOPSIS
 --------
 
-memcp [options] [file] [server]
-
 .. program:: memcp
 
+memcp [options] \-\-servers <hostname[:port]...> <file...>
+
+Copy files to a collection of memcached servers.
+
 DESCRIPTION
 -----------
 
-:program:`memcp` copies one or more files into memcached(1) servers.
-It is similar to the standard UNIX cp(1) command.
+:program:`memcp` copies one or more files into :manpage:`memcached(1)` servers.
+It is similar to the standard UNIX :manpage:`cp(1)` command.
 
-The key names will be the names of the files,
-without any directory path.
+The key names will be the names of the files, without any directory path.
 
 OPTIONS
 -------
 
-You can specify servers via the option:
+.. 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/udp.rst
+
+.. option:: --buffer
+
+    Enable internal buffering of commands.
 
-.. option:: --servers
+.. option:: --set
 
-or via the environment variable:
+    Issue *SET* command(s). This is the default mode.
+    See also :option:`--add` and :option:`--replace`.
 
-.. envvar:: `MEMCACHED_SERVERS`
+.. option:: --add
 
-If you do not specify either these, the final value in the command line list is the name of a server(s).
+    Issue *ADD* command(s).
 
-For a full list of operations run the tool with the option:
+.. option:: --replace
 
-.. option:: --help
+    Issue *REPLACE* command(s).
+
+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)`
+    :manpage:`memcached_behavior(3)`
+
+.. only:: html
 
+    * :doc:`/libmemcached`
+    * :doc:`/libmemcached/configuration`
+    * :doc:`/libmemcached/memcached_behavior`

diff --git a/docs/source/bin/memdump.rst b/docs/source/bin/memdump.rst
index ed3c80044fe2a56617bb42e06a9e21074b0b2a5f..07eb2fff38469b8cb5cc1cd522fc03b9b504f604 100644 (file)
--- a/docs/source/bin/memdump.rst
+++ b/docs/source/bin/memdump.rst
@@ -1,15 +1,14 @@
-=============================
-memdump - Dumping your server
-=============================
-
-Dump a list of keys from a server.
+memdump
+=======
 
 SYNOPSIS
 --------
 
+.. program:: memdump
+
 memdump [options]
 
-.. program:: memdump
+Dump a list of keys from a server.
 
 DESCRIPTION
 -----------
@@ -21,13 +20,27 @@ provide all keys it is not possible to get a complete "dump".
 OPTIONS
 -------
 
-For a full list of operations run the tool with option:
+.. include:: options/all.rst
+.. include:: options/common.rst
+.. include:: options/hash.rst
+.. include:: options/sasl.rst
 
-.. option:: --help
+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_dump`

diff --git a/docs/source/bin/memerror.rst b/docs/source/bin/memerror.rst
index d67c08f167b1738c9c941b693a7b0b277b3ed8f4..525aaf63022c6462ad5601459221de87a065e861 100644 (file)
--- a/docs/source/bin/memerror.rst
+++ b/docs/source/bin/memerror.rst
@@ -1,32 +1,42 @@
-==============================================
-memerror - translate an error code to a string
-==============================================
-
-Translates a memcached error code into a string
+memerror
+========
 
 SYNOPSIS
 --------
 
-memerror [options] [error code]
-
 .. program:: memerror
 
+memerror [options] <error code>
+
+Translate a memcached error code into a string.
+
 DESCRIPTION
 -----------
 
-:program:`memerror` translates an error code from libmemcached(3) into a human
+:program:`memerror` translates an error code from `libmemcached` into a human
 readable string.
 
 OPTIONS
 -------
 
-For a full list of operations run the tool with option:
+.. include:: options/all.rst
 
-.. option:: --help
+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/index_errors`

diff --git a/docs/source/bin/memexist.rst b/docs/source/bin/memexist.rst
index c8542ac8f87bca67859f2ff767c4bf1931f0ac77..1859c83880b8ee73308e270a0485e62274095ec2 100644 (file)
--- a/docs/source/bin/memexist.rst
+++ b/docs/source/bin/memexist.rst
@@ -1,40 +1,44 @@
-===========================================
-memexist - Check for the existence of a key
-===========================================
+memexist
+========
 
 SYNOPSIS
 --------
 
-memexist [options] [key]
-
 .. program:: memexist
 
+memexist [options] <key>
+
+Check for the existence of a key.
+
 DESCRIPTION
 -----------
 
-:program:`memexist` checks for the existance of a key within a cluster.
+:program:`memexist` checks for the existence of a key within a cluster.
 
 OPTIONS
 -------
 
-You can specify servers via the option:
-
-.. option:: --servers
+.. include:: options/all.rst
+.. include:: options/common.rst
+.. include:: options/hash.rst
+.. include:: options/sasl.rst
 
-or via the environment variable:
-
-.. envvar:: `MEMCACHED_SERVERS`
-
-If you do not specify either these, the final value in the command line list is the name of a server(s).
+ENVIRONMENT
+-----------
 
-For a full list of operations run the tool with the option:
+.. envvar:: MEMCACHED_SERVERS
 
-.. option:: --help
+    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_exist`

diff --git a/docs/source/bin/memflush.rst b/docs/source/bin/memflush.rst
index 461ef85ffcbcf6a567b561e81f6996d1b1c591cd..ed84d9a9f7e318551cdf840fa11ee0bc796bf7b4 100644 (file)
--- a/docs/source/bin/memflush.rst
+++ b/docs/source/bin/memflush.rst
@@ -1,8 +1,5 @@
-=======================================
-memflush - flush all data from a server
-=======================================
-
-Reset a server or list of servers
+memflush
+========
 
 SYNOPSIS
 --------
@@ -11,30 +8,67 @@ memflush [options]
 
 .. program:: memflush
 
+Reset a server or list of servers
+
 DESCRIPTION
 -----------
 
-:program:`memflush`  resets the contents of memcached(1) servers.
-This means that all data in the specified servers will be deleted.
+:program:`memflush`  resets the contents of :manpage:`memcached(1)` servers.
+
+.. warning::
+
+    This means that all data in the specified servers will be deleted.
 
 OPTIONS
 -------
 
-You can specify servers via the option:
+.. include:: options/all.rst
+.. include:: options/common.rst
+.. include:: options/sasl.rst
+.. include:: options/expire.rst
+
+.. note::
 
-.. option:: --servers
+    Using an expiration time (period), all keys, which have not bean updated until expiration will cease to exist.
 
-or via the environment variable:
+    Quoting the `memcached protocol documentation`_, it states:
 
-.. envvar:: `MEMCACHED_SERVERS`
+        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).
 
-For a full list of operations run the tool with option:
+        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.
 
-.. option:: --help
+        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).
+
+.. _memcached protocol documentation: https://github.com/memcached/memcached/blob/master/doc/protocol.txt
+
+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_flush`

diff --git a/docs/source/bin/memparse.rst b/docs/source/bin/memparse.rst
index 4ad1b7547209b2f1f1bb843d6fc70b9338cc15b6..4a6f41358323525a5615357811cdef1794cb82d6 100644 (file)
--- a/docs/source/bin/memparse.rst
+++ b/docs/source/bin/memparse.rst
@@ -1,16 +1,15 @@
-=================================
-memparse - Parse an option string
-=================================
-
-Used to validate an option string
+memparse
+========
 
 SYNOPSIS
 --------
 
-memparse [options] "option string"
-
 .. program:: memparse
 
+memparse <option string>
+
+Parse and validate an option string.
+
 DESCRIPTION
 -----------
 
@@ -19,14 +18,19 @@ DESCRIPTION
 OPTIONS
 -------
 
-For a full list of operations run the tool with the option:
-
-.. option:: --help
+None.
 
 SEE ALSO
 --------
 
 .. only:: man
 
-  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
+    :manpage:`memcached(1)`
+    :manpage:`libmemcached(3)`
+    :manpage:`libmemcached_configuration(3)`
+
+.. only:: html
+
+    * :doc:`/libmemcached`
+    * :doc:`/libmemcached/configuration`
 

diff --git a/docs/source/bin/memping.rst b/docs/source/bin/memping.rst
index 1239042e30a5502c0ab987631da33196f12fba50..fff7db223e9d8f0c55d9d3b379e3cd508e68ad20 100644 (file)
--- a/docs/source/bin/memping.rst
+++ b/docs/source/bin/memping.rst
@@ -1,6 +1,5 @@
-===============================================
-memping - Test to see if a server is available.
-===============================================
+memping
+=======
 
 SYNOPSIS
 --------
@@ -9,31 +8,35 @@ memping [options] [server]
 
 .. program:: memping
 
+Test for availability of a server
+
 DESCRIPTION
 -----------
 
-:program:`memping` can be used to ping a memcached server to see if it is taking connections.
+:program:`memping` can be used to ping a memcached server to see if it is accepting connections.
 
 OPTIONS
 -------
 
-You can specify servers via the option:
-
-.. option:: --servers
-
-or via the environment variable:
-
-.. envvar:: `MEMCACHED_SERVERS`
+.. include:: options/all.rst
+.. include:: options/common.rst
+.. include:: options/sasl.rst
 
-If you do not specify either these, the final value in the command line list is the name of a server(s).
+ENVIRONMENT
+-----------
 
-For a full list of operations run the tool with the option:
+.. envvar:: MEMCACHED_SERVERS
 
-.. option:: --help
+    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`

diff --git a/docs/source/bin/memrm.rst b/docs/source/bin/memrm.rst
index d76aa347d212ec208884db4e24c97532073b0a34..e3edd3190f3048d2d5719d39d0b591ef337dd4e9 100644 (file)
--- a/docs/source/bin/memrm.rst
+++ b/docs/source/bin/memrm.rst
@@ -1,40 +1,44 @@
-=================================
-memrm - Remove data from a server
-=================================
-
-memrm - Remove a key(s) from a collection of memcached servers
+memrm
+=====
 
 SYNOPSIS
 --------
 
-memrm [options] [key]
+memrm [options] <key ...>
 
 .. program:: memrm
 
+Remove key(s) from a collection of memcached servers
+
 DESCRIPTION
 -----------
 
-:program:`memrm`  removes items, specified by key, from memcached(1) servers.
+:program:`memrm` removes items, specified by key, from :manpage:`memcached(1)` servers.
 
 OPTIONS
 -------
 
-You can specify servers via the option:
-
-.. option:: --servers
+.. include:: options/all.rst
+.. include:: options/common.rst
+.. include:: options/hash.rst
+.. include:: options/sasl.rst
 
-or via the environment variable:
-
-.. envvar:: `MEMCACHED_SERVERS`
+ENVIRONMENT
+-----------
 
-For a full list of operations run the tool with the
+.. envvar:: MEMCACHED_SERVERS
 
-.. option:: --help
+    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_delete`

diff --git a/docs/source/bin/memslap.rst b/docs/source/bin/memslap.rst
index f0520062237754a70e443ec111435b897572aaec..9315c2de184ed42abc10658d4d257dcfa6b5e12a 100644 (file)
--- a/docs/source/bin/memslap.rst
+++ b/docs/source/bin/memslap.rst
@@ -1,6 +1,5 @@
-=================================================
-memslap - Load testing  and benchmarking a server
-=================================================
+memslap
+=======
 
 SYNOPSIS
 --------
@@ -9,30 +8,37 @@ memslap [options]
 
 .. program::  memslap
 
+Load testing  and benchmarking a server
+
 DESCRIPTION
 -----------
 
-:program:`memslap` is a load generation and benchmark tool for memcached(1)
-servers. It generates configurable workload such as threads, concurrencies, connections, run time, overwrite, miss rate, key size, value size, get/set proportion, expected throughput, and so on. 
+:program:`memslap` is a load generation and benchmark tool for :manpage:`memcached(1)`
+servers. It generates configurable workload such as threads, concurrencies, connections,
+run time, overwrite, miss rate, key size, value size, get/set proportion, expected
+throughput, and so on.
 
 OPTIONS
 -------
 
-You can specify servers via the option:
-
-.. option:: --servers
-
-or via the environment variable:
+.. include:: options/all.rst
+.. include:: options/common.rst
 
-.. envvar:: `MEMCACHED_SERVERS`
+ENVIRONMENT
+-----------
 
-For a full list of operations run the tool with:
+.. envvar:: MEMCACHED_SERVERS
 
-.. option:: --help
+    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`

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`

diff --git a/docs/source/bin/memtouch.rst b/docs/source/bin/memtouch.rst
index c06d42e93b89ed43dbc539b7f6f185ae140cfde3..4e55ab15963d07fc1fb3bf373dbbb842f02b25f5 100644 (file)
--- a/docs/source/bin/memtouch.rst
+++ b/docs/source/bin/memtouch.rst
@@ -1,14 +1,13 @@
-=========================
-memtouch - Touches a key.
-=========================
+memtouch
+========
 
 SYNOPSIS
 --------
 
-memtouch [options] key
-
 .. program:: memtouch
 
+memtouch [options] <key>
+
 DESCRIPTION
 -----------
 
@@ -17,24 +16,21 @@ DESCRIPTION
 OPTIONS
 -------
 
-You can specify servers via the option:
-
-.. option:: --servers
-
-or via the environment variable:
-
-.. envvar:: `MEMCACHED_SERVERS`
-
-If you do not specify either these, the final value in the command line list is the name of a server(s).
-
-For a full list of operations run the tool with the option:
-
-.. option:: --help
+.. include:: options/all.rst
+.. include:: options/common.rst
+.. include:: options/expire.rst
+.. include:: options/hash.rst
+.. include:: options/sasl.rst
 
 SEE ALSO
 --------
 
 .. only:: man
 
-  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
+    :manpage:`memcached(1)`
+    :manpage:`libmemcached(3)`
+
+.. only:: html
 
+* :doc:`/libmemcached`
+* :doc:`/libmemcached/memcached_touch`

diff --git a/docs/source/bin/options/all.rst b/docs/source/bin/options/all.rst
new file mode 100644 (file)
index 0000000..5955282
--- /dev/null
+++ b/docs/source/bin/options/all.rst
@@ -0,0 +1,8 @@
+.. option:: --help
+
+    Display help.
+
+.. option:: --version
+
+    Display version.
+

diff --git a/docs/source/bin/options/common.rst b/docs/source/bin/options/common.rst
new file mode 100644 (file)
index 0000000..9acb684
--- /dev/null
+++ b/docs/source/bin/options/common.rst
@@ -0,0 +1,20 @@
+.. option:: --quiet
+
+    Operate quietly.
+
+.. option:: --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.
+

diff --git a/docs/source/bin/options/expire.rst b/docs/source/bin/options/expire.rst
new file mode 100644 (file)
index 0000000..2f60935
--- /dev/null
+++ b/docs/source/bin/options/expire.rst
@@ -0,0 +1,4 @@
+.. option:: --expire <expiration>
+
+    Use *expiration* seconds (or a UNIX timestamp).
+

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

diff --git a/docs/source/bin/options/hash.rst b/docs/source/bin/options/hash.rst
new file mode 100644 (file)
index 0000000..78d84de
--- /dev/null
+++ b/docs/source/bin/options/hash.rst
@@ -0,0 +1,5 @@
+.. option:: --hash <algorithm>
+
+    Use *algorithm* as key hash algo.
+    See :enumerator:`memcached_behavior_t::MEMCACHED_BEHAVIOR_HASH`.
+

diff --git a/docs/source/bin/options/sasl.rst b/docs/source/bin/options/sasl.rst
new file mode 100644 (file)
index 0000000..8d664c3
--- /dev/null
+++ b/docs/source/bin/options/sasl.rst
@@ -0,0 +1,8 @@
+.. option:: --username <username>
+
+    Use *username* for SASL authentication.
+
+.. option:: --password <password>
+
+    Use *password* for SASL authentication.
+

diff --git a/docs/source/bin/options/udp.rst b/docs/source/bin/options/udp.rst
new file mode 100644 (file)
index 0000000..ae486b3
--- /dev/null
+++ b/docs/source/bin/options/udp.rst
@@ -0,0 +1,4 @@
+.. option:: --udp
+
+    Enable UDP operation mode.
+

diff --git a/docs/source/conf.py.in b/docs/source/conf.py.in
index 0751b2619c057e5a9b075f5c1946e994712970c4..5dba3f3b30ca376ec7cf6835f72b6dfafad13152 100644 (file)
--- a/docs/source/conf.py.in
+++ b/docs/source/conf.py.in
@@ -24,6 +24,7 @@ project = u'libmemcached'
 version = '@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@'
 release = '@PROJECT_VERSION@'
 
+smartquotes = False
 
 # -- Options for HTML output ---------------------------------------------------
 
@@ -32,8 +33,8 @@ html_theme_options = {@SPHINX_THEME_OPTIONS@}
 html_domain_indices = False
 html_show_sourcelink = False
 html_copy_source = False
-manpages_url = 'http://man7.org/linux/man-pages/man{section}/{page}.{section}.html'
-
+#manpages_url = 'http://man7.org/linux/man-pages/man{section}/{page}.{section}.html'
+manpages_url = 'https://linux.die.net/man/{section}/{page}'
 
 # -- Options for manual page output --------------------------------------------
 

diff --git a/docs/source/libmemcached.rst b/docs/source/libmemcached.rst
index 5ad21dfce91573cbc707b55f47f51a7a7c180a3b..dba0058322baeb836aab7eca99c9d8425e77c090 100644 (file)
--- a/docs/source/libmemcached.rst
+++ b/docs/source/libmemcached.rst
@@ -88,7 +88,6 @@ CLIENT PROGRAMS
 
 .. only:: man
 
-    :manpage:`memcached(1)`
     :manpage:`memaslap(1)`
     :manpage:`memcapable(1)`
     :manpage:`memcat(1)`

diff --git a/docs/source/libmemcached/memcached_analyze.rst b/docs/source/libmemcached/memcached_analyze.rst
index 7843e4e8f934de7b28a44ae57152a69d22f05e5f..312b42f06cf3097af85b8510b1cda10848dc06b5 100644 (file)
--- a/docs/source/libmemcached/memcached_analyze.rst
+++ b/docs/source/libmemcached/memcached_analyze.rst
@@ -26,6 +26,7 @@ must be freed by the calling application.
 .. seealso:: :option:`memstat --analyze`
     A command line tool to analyze a memcached server.
 
+
 RETURN VALUE
 ------------
 

diff --git a/docs/source/libmemcached/memcached_return_t.rst b/docs/source/libmemcached/memcached_return_t.rst
index 08a05849decd9ab6f04b9554a8d6e5185492b72a..3b34fa0019a63e77133a2ec2eabd82e9d93dedba 100644 (file)
--- a/docs/source/libmemcached/memcached_return_t.rst
+++ b/docs/source/libmemcached/memcached_return_t.rst
@@ -15,7 +15,7 @@ SYNOPSIS
 
 .. function:: bool memcached_fatal(memcached_return_t)
 
-.. c:type:: typedef enum memcached_return_t memcached_return_t
+.. c:type:: enum memcached_return_t memcached_return_t
 
 .. enum:: memcached_return_t
 
@@ -57,7 +57,8 @@ SYNOPSIS
 
         .. deprecated:: <0.30
 
-        An error has occurred while trying to connect to a server. It is likely that either the number of file descriptors need to be increased or you are out of memory.
+        An error has occurred while trying to connect to a server.
+        It is likely that either the number of file descriptors need to be increased or you are out of memory.
 
     .. enumerator:: MEMCACHED_DATA_DOES_NOT_EXIST
 
@@ -111,7 +112,8 @@ SYNOPSIS
 
     .. enumerator:: MEMCACHED_INVALID_HOST_PROTOCOL
 
-        The server you are connecting too has an invalid protocol. Most likely you are connecting to an older server that does not speak the binary protocol.
+        The server you are connecting too has an invalid protocol.
+        Most likely you are connecting to an older server that does not speak the binary protocol.
 
     .. enumerator:: MEMCACHED_ITEM
 
@@ -154,7 +156,8 @@ SYNOPSIS
 
     .. enumerator:: MEMCACHED_PARSE_ERROR
 
-        An error has occurred while trying to parse the configuration string. You should use memparse to determine what the error was.
+        An error has occurred while trying to parse the configuration string.
+        You should use memparse to determine what the error was.
 
     .. enumerator:: MEMCACHED_PARSE_USER_ERROR
 
@@ -202,7 +205,8 @@ SYNOPSIS
 
     .. enumerator:: MEMCACHED_UNKNOWN_READ_FAILURE
 
-        An unknown read failure only occurs when either there is a bug in the server, or in rare cases where an ethernet nic is reporting dubious information.
+        An unknown read failure only occurs when either there is a bug in the server,
+        or in rare cases where an ethernet nic is reporting dubious information.
 
     .. enumerator:: MEMCACHED_UNKNOWN_STAT_KEY
 

diff --git a/src/bin/memcp.cc b/src/bin/memcp.cc
index cf8d273c98d4f7893ff95b9082b0a571fffd43f8..918ddac93dc245f3686d1c9cefb5760a0f62a767 100644 (file)
--- a/src/bin/memcp.cc
+++ b/src/bin/memcp.cc
@@ -16,7 +16,6 @@
 #include <climits>
 #include <cstdio>
 #include <cstdlib>
-#include <cstdlib>
 #include <cstring>
 #include <fcntl.h>
 #include <getopt.h>
@@ -26,8 +25,6 @@
 #endif
 #include <sys/stat.h>
 #include <sys/types.h>
-#include <sys/types.h>
-#include <sys/types.h>
 #include <unistd.h>