X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcapable.rst;h=b9d2f5a80424363bd56e7f238be97e921a102163;hb=9cc3e725100e171481d7d694ab07f4e6b4288824;hp=619adc6a05e8742afe5f5bd3fa37b98eccaa2d4e;hpb=281c398ba3a10af677494c4453cd09d85ca921e0;p=awesomized%2Flibmemcached diff --git a/docs/memcapable.rst b/docs/memcapable.rst index 619adc6a..b9d2f5a8 100644 --- a/docs/memcapable.rst +++ b/docs/memcapable.rst @@ -1,70 +1,52 @@ -============================================================ -Checking you Memcached server capibilities and compatibility -============================================================ +======================================================================= +memcapable - Checking a Memcached server capibilities and compatibility +======================================================================= -Check memcached server capabilities +Check the server for compatibility and capabilities -------- SYNOPSIS -------- +:program:`memcapable` +.. program:: memcapable -.. 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 -******* - - -The following options are testsed: - - --h hostname +.. option:: -h hostname - Specify the hostname to connect to. The default is \ *localhost*\ - - +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. ----------- @@ -75,18 +57,18 @@ 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, @@ -96,6 +78,5 @@ Trond Norbye, SEE ALSO -------- - -memcached(1) libmemcached(3) +:manpage:`memcached(1)` :manpage:`libmemcached(3)`