Commit update for release.
[awesomized/libmemcached] / docs / memcapable.rst
index 1583cc4c5a1fe1d3e68aa01d20f016b2b07d7864..28988046301bf36fc1a1323a0a85339180d0128c 100644 (file)
-.. highlight:: perl
+=======================================================================
+memcapable - Checking a Memcached server capibilities and compatibility
+=======================================================================
 
+.. index:: object: memcached_st
 
-****
-NAME
-****
+Check the server for compatibility and capabilities
 
 
-memcapable - Check memcached server capabilities
-
-
-********
+--------
 SYNOPSIS
-********
-
-
+--------
 
-.. code-block:: perl
+:program:`memcapable`
 
-   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 supported:
+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>
 
 
-********
+--------
 SEE ALSO
-********
-
+--------
 
-memcached(1) libmemcached(3)
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`