X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Fbin%2Fmemcapable.rst;h=d1a4f7a4d60adbb059cbc497d4facc1deeee1d76;hb=efeacc93d17bfaad48e9b7422aebd35e4968c00c;hp=f8290333109f2b0daede4f6291b51de3aa9eea55;hpb=bdf3398dac90a54d82aed65099290d51e92d4601;p=awesomized%2Flibmemcached diff --git a/docs/source/bin/memcapable.rst b/docs/source/bin/memcapable.rst index f8290333..d1a4f7a4 100644 --- a/docs/source/bin/memcapable.rst +++ b/docs/source/bin/memcapable.rst @@ -1,53 +1,52 @@ -======================================================================= -memcapable - Checking a Memcached server capabilities and compatibility -======================================================================= +memcapable +========== SYNOPSIS -------- +.. program:: memcapable + memcapable [options] -.. program:: memcapable +Check a memcached server's capabilities and compatibility. 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. +determine its capabilities by running various commands and verifying the response. OPTIONS ------- .. option:: -h hostname -Specify the hostname to connect to. The default is \ *localhost*\ + Specify the hostname to connect to. The default is \ *localhost*\ . .. 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*\ . .. option:: -c -Generate a coredump when it detects an error from the server. + :manpage:`abort(3)` when detecting an error from the server. .. 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. .. option:: -t n -Set the timeout from an IO operation to/from the server to \ *n*\ seconds. + Set the timeout for an IO operation to/from the server to \ *n*\ seconds. SEE ALSO -------- .. only:: man - :manpage:`memcached(1)` :manpage:`libmemcached(3)` + :manpage:`memcached(1)` + :manpage:`libmemcached(3)` + +.. only:: html + * :doc:`/libmemcached`