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