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