Additional doc updates.
[m6w6/libmemcached] / docs / memcapable.rst
index 1583cc4c5a1fe1d3e68aa01d20f016b2b07d7864..97dbc066b656d87a47d348b95657f9c86fcd3cf9 100644 (file)
-.. highlight:: perl
+=======================================================================
+memcapable - Checking a Memcached server capibilities and compatibility
+=======================================================================
 
 
-****
-NAME
-****
+Check the server for compatibility and capabilities
 
 
-memcapable - Check memcached server capabilities
-
-
-********
+--------
 SYNOPSIS
-********
-
-
-
-.. 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
-*******
+--------
 
+.. program:: memcat
 
-The following options are supported:
-
-
--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.
 
 
-***********
+-----------
 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>
 
 
-********
+--------
 SEE ALSO
-********
-
+--------
 
-memcached(1) libmemcached(3)
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`