Update docs.
[awesomized/libmemcached] / docs / man / memcapable.1
1 .TH "MEMCAPABLE" "1" "January 26, 2012" "1.0.4" "libmemcached"
2 .SH NAME
3 memcapable \- libmemcached Documentation
4 .
5 .nr rst2man-indent-level 0
6 .
7 .de1 rstReportMargin
8 \\$1 \\n[an-margin]
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
11 -
12 \\n[rst2man-indent0]
13 \\n[rst2man-indent1]
14 \\n[rst2man-indent2]
15 ..
16 .de1 INDENT
17 .\" .rstReportMargin pre:
18 . RS \\$1
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
22 ..
23 .de UNINDENT
24 . RE
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30 ..
31 .\" Man page generated from reStructeredText.
32 .
33 .SH SYNOPSIS
34 .sp
35 memcapable [options]
36 .SH DESCRIPTION
37 .sp
38 \fBmemcapable\fP connects to the specified memcached server and tries to
39 determine its capabilities by running the various commands and verifying
40 the response.
41 .SH LIMITATIONS
42 .sp
43 The current version of memcapable will only verify the binary protocol.
44 .SH OPTIONS
45 .INDENT 0.0
46 .TP
47 .B \-h hostname
48 .UNINDENT
49 .sp
50 Specify the hostname to connect to. The default is \fIlocalhost\fP
51 .INDENT 0.0
52 .TP
53 .B \-p port
54 .UNINDENT
55 .sp
56 Specify the port number to connect to. The default is \fI11211\fP
57 .INDENT 0.0
58 .TP
59 .B \-c
60 .UNINDENT
61 .sp
62 Generate a coredump when it detects an error from the server.
63 .INDENT 0.0
64 .TP
65 .B \-v
66 .UNINDENT
67 .sp
68 Print out the comparison when it detects an error from the server.
69 .INDENT 0.0
70 .TP
71 .B \-t n
72 .UNINDENT
73 .sp
74 Set the timeout from an IO operation to/from the server to \fIn\fP seconds.
75 .SH HOME
76 .sp
77 To find out more information please check:
78 \fI\%http://libmemcached.org/\fP
79 .SH AUTHOR
80 .sp
81 Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
82 .SH SEE ALSO
83 .sp
84 \fImemcached(1)\fP \fIlibmemcached(3)\fP
85 .SH AUTHOR
86 Brian Aker
87 .SH COPYRIGHT
88 2011, Brian Aker DataDifferential, http://datadifferential.com/
89 .\" Generated by docutils manpage writer.
90 .\"
91 .