Merge in docs.
[m6w6/libmemcached] / docs / memcapable.rst
1 .. highlight:: perl
2
3
4 memcapable
5 **********
6
7
8 Check memcached server capabilities
9
10
11 ********
12 SYNOPSIS
13 ********
14
15
16
17 .. code-block:: perl
18
19 memcat [-h hostname] [-p port] [-c] [-v] [-t n]
20
21
22
23 ***********
24 DESCRIPTION
25 ***********
26
27
28 \ **memcapable**\ connects to the specified memcached server and tries to
29 determine its capabilities by running the various commands and verifying
30 the response.
31
32
33 *******
34 OPTIONS
35 *******
36
37
38 The following options are supported:
39
40
41 -h hostname
42
43 Specify the hostname to connect to. The default is \ *localhost*\
44
45
46
47 -p port
48
49 Specify the port number to connect to. The default is \ *11211*\
50
51
52
53 -c
54
55 Generate a coredump when it detects an error from the server.
56
57
58
59 -v
60
61 Print out the comparison when it detects an error from the server.
62
63
64
65 -t n
66
67 Set the timeout from an IO operation to/from the server to \ *n*\ seconds.
68
69
70
71
72 ***********
73 LIMITATIONS
74 ***********
75
76
77 The current version of memcapable will only verify the binary protocol.
78
79
80 ****
81 HOME
82 ****
83
84
85 To find out more information please check:
86 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
87
88
89 ******
90 AUTHOR
91 ******
92
93
94 Trond Norbye, <trond.norbye@gmail.com>
95
96
97 ********
98 SEE ALSO
99 ********
100
101
102 memcached(1) libmemcached(3)
103