fix #131: add build time option: CLIENT_PREFIX
[awesomized/libmemcached] / docs / source / bin / memcapable.rst
1 memcapable
2 ==========
3
4 SYNOPSIS
5 --------
6
7 .. program:: memcapable
8
9 |client_prefix|\capable [options]
10
11 Check a memcached server's capabilities and compatibility.
12
13 DESCRIPTION
14 -----------
15
16 :program:`memcapable` connects to the specified memcached server and tries to
17 determine its capabilities by running various commands and verifying the response.
18
19 OPTIONS
20 -------
21
22 .. option:: -h hostname
23
24 Specify the hostname to connect to. The default is \ *localhost*\ .
25
26 .. option:: -p port
27
28 Specify the port number to connect to. The default is \ *11211*\ .
29
30 .. option:: -c
31
32 :manpage:`abort(3)` when detecting an error from the server.
33
34 .. option:: -v
35
36 Print out the comparison when it detects an error from the server.
37
38 .. option:: -t n
39
40 Set the timeout for an IO operation to/from the server to \ *n*\ seconds.
41
42
43 NOTES
44 -----
45
46 .. include:: common/note_program_prefix.rst
47 .. include:: common/note_contrib_options.rst
48
49
50 SEE ALSO
51 --------
52
53 .. only:: man
54
55 :manpage:`memcached(1)`
56 :manpage:`libmemcached(3)`
57
58 .. only:: html
59
60 * :doc:`/libmemcached`