Merge in fixes
[m6w6/libmemcached] / docs / memcapable.rst
index 619adc6a05e8742afe5f5bd3fa37b98eccaa2d4e..97dbc066b656d87a47d348b95657f9c86fcd3cf9 100644 (file)
@@ -1,70 +1,50 @@
-============================================================
-Checking you Memcached server capibilities and compatibility
-============================================================
+=======================================================================
+memcapable - Checking a Memcached server capibilities and compatibility
+=======================================================================
 
 
-Check memcached server capabilities
+Check the server for compatibility and capabilities
 
 
 --------
 SYNOPSIS
 --------
 
+.. program:: memcat
 
-
-.. code-block:: perl
-
-   memcat [-h hostname] [-p port] [-c] [-v] [-t n]
-
-
-
------------
-DESCRIPTION
------------
-
-
-\ **memcapable**\  connects to the specified memcached server and tries to
-determine its capabilities by running the various commands and verifying
-the response.
-
-
-*******
-OPTIONS
-*******
-
-
-The following options are testsed:
-
-
--h hostname
+.. option:: -h hostname
  
  Specify the hostname to connect to. The default is \ *localhost*\ 
-
 
--p port
+.. option:: -p port
  
  Specify the port number to connect to. The default is \ *11211*\ 
  
 
 
--c
+.. option:: -c
  
  Generate a coredump when it detects an error from the server.
  
 
 
--v
+.. 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.
  
 
 
--t n
+.. option:: -t n
  
  Set the timeout from an IO operation to/from the server to \ *n*\  seconds.
  
+-----------
+DESCRIPTION
+-----------
 
+\ **memcapable**\  connects to the specified memcached server and tries to
+determine its capabilities by running the various commands and verifying
+the response.
 
 
 -----------
@@ -75,18 +55,18 @@ LIMITATIONS
 The current version of memcapable will only verify the binary protocol.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 
-******
+------
 AUTHOR
-******
+------
 
 
 Trond Norbye, <trond.norbye@gmail.com>
@@ -96,6 +76,5 @@ Trond Norbye, <trond.norbye@gmail.com>
 SEE ALSO
 --------
 
-
-memcached(1) libmemcached(3)
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`