Commit update for release.

[m6w6/libmemcached] / docs / memcapable.rst

diff --git a/docs/memcapable.rst b/docs/memcapable.rst
index 619adc6a05e8742afe5f5bd3fa37b98eccaa2d4e..28988046301bf36fc1a1323a0a85339180d0128c 100644 (file)
--- a/docs/memcapable.rst
+++ b/docs/memcapable.rst
@@ -1,92 +1,75 @@
-============================================================
-Checking you Memcached server capibilities and compatibility
-============================================================
+=======================================================================
+memcapable - Checking a Memcached server capibilities and compatibility
+=======================================================================
 
+.. index:: object: memcached_st
 
-Check memcached server capabilities
+Check the server for compatibility and capabilities
 
 
 --------
 SYNOPSIS
 --------
 
+:program:`memcapable`
 
-
-.. code-block:: perl
-
-   memcat [-h hostname] [-p port] [-c] [-v] [-t n]
-
-
+.. program:: memcapable
 
 -----------
 DESCRIPTION
 -----------
 
-
-\ **memcapable**\  connects to the specified memcached server and tries to
+:program:`memcapable` connects to the specified memcached server and tries to
 determine its capabilities by running the various commands and verifying
 the response.
 
 
-*******
-OPTIONS
-*******
+-----------
+LIMITATIONS
+-----------
 
 
-The following options are testsed:
+The current version of memcapable will only verify the binary protocol.
 
 
--h hostname
- 
- Specify the hostname to connect to. The default is \ *localhost*\ 
- 
+-------
+OPTIONS
+-------
 
 
--p port
- 
- Specify the port number to connect to. The default is \ *11211*\ 
+.. option:: -h hostname
  
+Specify the hostname to connect to. The default is \ *localhost*\ 
 
-
--c
+.. option:: -p port
  
- Generate a coredump when it detects an error from the server.
+Specify the port number to connect to. The default is \ *11211*\ 
  
-
-
--v
+.. option:: -c
  
- Print out the comparison when it detects an error from the server.
+Generate a coredump when it detects an error from the server.
  
-
-
--t n
+.. option:: -v
  
- Set the timeout from an IO operation to/from the server to \ *n*\  seconds.
+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.
  
 
-
-
------------
-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>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-******
+------
 AUTHOR
-******
+------
 
 
 Trond Norbye, <trond.norbye@gmail.com>
@@ -96,6 +79,5 @@ Trond Norbye, <trond.norbye@gmail.com>
 SEE ALSO
 --------
 
-
-memcached(1) libmemcached(3)
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`