X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Fbin%2Fmemcat.rst;h=aa6cc540053f48401eaf17925fa2a5c9a56ebe5b;hb=85f5404daca70a8bc772c5e0670b22f68ad9d76d;hp=c3a6b65e16a596c65ff7763d6a836d1c713cd26b;hpb=bdf3398dac90a54d82aed65099290d51e92d4601;p=awesomized%2Flibmemcached diff --git a/docs/source/bin/memcat.rst b/docs/source/bin/memcat.rst index c3a6b65e..aa6cc540 100644 --- a/docs/source/bin/memcat.rst +++ b/docs/source/bin/memcat.rst @@ -1,43 +1,53 @@ -================================= -memcat - "cat" data from a server -================================= +memcat +====== SYNOPSIS -------- -memcat [options] key +.. program:: memcat -Copy a set of keys to stdout +memcat [options] key [key...] -.. program:: memcat +Read and output the value of one key or the values of a set of keys. DESCRIPTION ----------- -:program:`memcat` outputs to stdout the value a single or multiple set of keys -stored in a memcached(1) server. If any key is not found an error is returned. +:program:`memcat` reads and outputs the value of a single or a set of keys +stored in a :manpage:`memcached(1)` server. + +If any key is not found an error is returned. -It is similar to the standard UNIX cat(1) utility. +It is similar to the standard UNIX :manpage:`cat(1)` utility. OPTIONS ------- -You can specify servers via the option: +.. include:: options/all.rst +.. include:: options/common.rst +.. include:: options/hash.rst -.. option:: --servers +.. option:: --flag -or via the environment variable: + Display stored flags. -.. envvar:: `MEMCACHED_SERVERS` +ENVIRONMENT +----------- -For a full list of operations run the tool with the option: +.. envvar:: MEMCACHED_SERVERS -.. option:: --help + Specify a list of servers. SEE ALSO -------- .. only:: man - :manpage:`memcached(1)` :manpage:`libmemcached(3)` + :manpage:`memcached(1)` + :manpage:`libmemcached(3)` + :manpage:`libmemcached_configuration(3)` + +.. only:: html + * :doc:`/libmemcached` + * :doc:`/libmemcached/configuration`