X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Fbin%2Fmemcat.rst;h=aa6cc540053f48401eaf17925fa2a5c9a56ebe5b;hb=25c4609a8973f6d14bcba4546ecb8137a29be823;hp=00773ee0629beab22f5ed516bda16e1945cf5b5f;hpb=9d8ad7151bed36742138f7422307d19d0d64373c;p=awesomized%2Flibmemcached diff --git a/docs/source/bin/memcat.rst b/docs/source/bin/memcat.rst index 00773ee0..aa6cc540 100644 --- a/docs/source/bin/memcat.rst +++ b/docs/source/bin/memcat.rst @@ -1,55 +1,53 @@ -================================= -memcat - "cat" data from a server -================================= +memcat +====== - - --------- SYNOPSIS -------- -memcat [options] key - -Copy a set of keys to stdout - - .. program:: memcat +memcat [options] key [key...] + +Read and output the value of one key or the values of a set of keys. ------------ DESCRIPTION ----------- +:program:`memcat` reads and outputs the value of a single or a set of keys +stored in a :manpage:`memcached(1)` server. -: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. +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 ------- +.. include:: options/all.rst +.. include:: options/common.rst +.. include:: options/hash.rst -You can specify servers via the option: - -.. option:: --servers - -or via the environment variable: +.. option:: --flag -.. envvar:: `MEMCACHED_SERVERS` + Display stored flags. -For a full list of operations run the tool with the option: +ENVIRONMENT +----------- -.. option:: --help +.. envvar:: MEMCACHED_SERVERS + 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`