X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcapable.rst;h=63e878456ea0fdbecd6d4bb348204305a4002186;hb=c3723b53b87471782076765f0fff656d07de74e0;hp=1583cc4c5a1fe1d3e68aa01d20f016b2b07d7864;hpb=c4dbc7e56b01545e25bc95ba122c79d4a2631a99;p=m6w6%2Flibmemcached diff --git a/docs/memcapable.rst b/docs/memcapable.rst index 1583cc4c..63e87845 100644 --- a/docs/memcapable.rst +++ b/docs/memcapable.rst @@ -1,104 +1,83 @@ -.. 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 - - memcat [-h hostname] [-p port] [-c] [-v] [-t n] - +-------- +:program:`memcapable` -*********** -DESCRIPTION -*********** - - -\ **memcapable**\ connects to the specified memcached server and tries to -determine its capabilities by running the various commands and verifying -the response. +.. program:: memcapable - -******* -OPTIONS -******* - - -The following options are supported: - - --h hostname - - Specify the hostname to connect to. The default is \ *localhost*\ +.. 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*\ +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. +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. +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 `_ +`http://libmemcached.org/ `_ -****** +------ AUTHOR -****** +------ Trond Norbye, -******** +-------- SEE ALSO -******** - +-------- -memcached(1) libmemcached(3) +:manpage:`memcached(1)` :manpage:`libmemcached(3)`