tests: be more elaborate about what was expected
[awesomized/libmemcached] / docs / source / bin / memcapable.rst
index f8290333109f2b0daede4f6291b51de3aa9eea55..ed93bd1d659e8d87f751c2ed61c7eb1b86fec292 100644 (file)
@@ -1,53 +1,60 @@
-=======================================================================
-memcapable - Checking a Memcached server capabilities and compatibility
-=======================================================================
+memcapable
+==========
 
 SYNOPSIS
 --------
 
-memcapable [options]
-
 .. program:: memcapable
 
-DESCRIPTION
------------
+|client_prefix|\capable [options]
 
-:program:`memcapable` connects to the specified memcached server and tries to
-determine its capabilities by running the various commands and verifying
-the response.
+Check a memcached server's capabilities and compatibility.
 
-LIMITATIONS
+DESCRIPTION
 -----------
 
-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.
+    :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.
+
+
+NOTES
+-----
+
+.. include:: common/note_program_prefix.rst
+.. include:: common/note_contrib_options.rst
+
 
 SEE ALSO
 --------
 
 .. only:: man
 
-  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
+  :manpage:`memcached(1)`
+  :manpage:`libmemcached(3)`
+
+.. only:: html
 
+  * :doc:`/libmemcached`