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