tests: be more elaborate about what was expected
[awesomized/libmemcached] / docs / source / bin / memcapable.rst
index 0e4f33e36dc6668c17e6fbe3ef2b2728183235bf..ed93bd1d659e8d87f751c2ed61c7eb1b86fec292 100644 (file)
@@ -1,78 +1,60 @@
-=======================================================================
-memcapable - Checking a Memcached server capibilities and compatibility
-=======================================================================
+memcapable
+==========
 
---------
 SYNOPSIS
 --------
 
-memcapable [options]
-
 .. program:: memcapable
 
------------
-DESCRIPTION
------------
-
-:program:`memcapable` connects to the specified memcached server and tries to
-determine its capabilities by running the various commands and verifying
-the response.
+|client_prefix|\capable [options]
 
+Check a memcached server's capabilities and compatibility.
 
+DESCRIPTION
 -----------
-LIMITATIONS
------------
-
-
-The current version of memcapable will only verify the binary protocol.
 
+:program:`memcapable` connects to the specified memcached server and tries to
+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.
-.. option:: -v
-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.
 
-----
-HOME
-----
+    :manpage:`abort(3)` when detecting an error from the server.
 
+.. option:: -v
 
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
+    Print out the comparison when it detects an error from the server.
 
+.. option:: -t n
 
-------
-AUTHOR
-------
+    Set the timeout for an IO operation to/from the server to \ *n*\  seconds.
 
 
-Trond Norbye, <trond.norbye@gmail.com>
+NOTES
+-----
+
+.. include:: common/note_program_prefix.rst
+.. include:: common/note_contrib_options.rst
 
 
---------
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+.. only:: man
+
+  :manpage:`memcached(1)`
+  :manpage:`libmemcached(3)`
+
+.. only:: html
 
+  * :doc:`/libmemcached`