Commit update for release.
[m6w6/libmemcached] / docs / memcapable.rst
index b9d2f5a80424363bd56e7f238be97e921a102163..28988046301bf36fc1a1323a0a85339180d0128c 100644 (file)
@@ -2,6 +2,7 @@
 memcapable - Checking a Memcached server capibilities and compatibility
 =======================================================================
 
+.. index:: object: memcached_st
 
 Check the server for compatibility and capabilities
 
@@ -14,6 +15,28 @@ SYNOPSIS
 
 .. 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.
+
+
+-----------
+LIMITATIONS
+-----------
+
+
+The current version of memcapable will only verify the binary protocol.
+
+
+-------
+OPTIONS
+-------
+
+
 .. option:: -h hostname
  
 Specify the hostname to connect to. The default is \ *localhost*\ 
@@ -22,40 +45,18 @@ Specify the hostname to connect to. The default is \ *localhost*\
  
 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.
  
------------
-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