Merge in updates (including removal of some depcrated bits from the examples).
[awesomized/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:`memcapable`
14
15 .. program:: memcapable
16
17 .. option:: -h hostname
18
19 Specify the hostname to connect to. The default is \ *localhost*\
20
21 .. option:: -p port
22
23 Specify the port number to connect to. The default is \ *11211*\
24
25
26
27 .. option:: -c
28
29 Generate a coredump when it detects an error from the server.
30
31
32
33 .. option:: -v
34
35 Print out the comparison when it detects an error from the server.
36
37
38
39 .. option:: -t n
40
41 Set the timeout from an IO operation to/from the server to \ *n*\ seconds.
42
43 -----------
44 DESCRIPTION
45 -----------
46
47 \ **memcapable**\ connects to the specified memcached server and tries to
48 determine its capabilities by running the various commands and verifying
49 the response.
50
51
52 -----------
53 LIMITATIONS
54 -----------
55
56
57 The current version of memcapable will only verify the binary protocol.
58
59
60 ----
61 HOME
62 ----
63
64
65 To find out more information please check:
66 `http://libmemcached.org/ <http://libmemcached.org/>`_
67
68
69 ------
70 AUTHOR
71 ------
72
73
74 Trond Norbye, <trond.norbye@gmail.com>
75
76
77 --------
78 SEE ALSO
79 --------
80
81 :manpage:`memcached(1)` :manpage:`libmemcached(3)`
82