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