Merge branch 'docs' into v1.0
[awesomized/libmemcached] / docs / source / bin / memcat.rst
1 memcat
2 ======
3
4 SYNOPSIS
5 --------
6
7 .. program:: memcat
8
9 memcat [options] key [key...]
10
11 Read and output the value of one key or the values of a set of keys.
12
13 DESCRIPTION
14 -----------
15
16 :program:`memcat` reads and outputs the value of a single or a set of keys
17 stored in a :manpage:`memcached(1)` server.
18
19 If any key is not found an error is returned.
20
21 It is similar to the standard UNIX :manpage:`cat(1)` utility.
22
23 OPTIONS
24 -------
25
26 .. include:: options/all.rst
27 .. include:: options/common.rst
28 .. include:: options/hash.rst
29
30 .. option:: --flag
31
32 Display stored flags.
33
34 ENVIRONMENT
35 -----------
36
37 .. envvar:: MEMCACHED_SERVERS
38
39 Specify a list of servers.
40
41 SEE ALSO
42 --------
43
44 .. only:: man
45
46 :manpage:`memcached(1)`
47 :manpage:`libmemcached(3)`
48 :manpage:`libmemcached_configuration(3)`
49
50 .. only:: html
51
52 * :doc:`/libmemcached`
53 * :doc:`/libmemcached/configuration`