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