Merge in man page updates.
[m6w6/libmemcached] / docs / man / memcapable.1
1 .TH "MEMCAPABLE" "1" "April 14, 2011" "0.47" "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 .sp
34 Check the server for compatibility and capabilities
35 .SH SYNOPSIS
36 .sp
37 \fBmemcapable\fP
38 .INDENT 0.0
39 .TP
40 .B \-h hostname
41 .sp
42 Specify the hostname to connect to. The default is \fIlocalhost\fP
43 .UNINDENT
44 .INDENT 0.0
45 .TP
46 .B \-p port
47 .sp
48 Specify the port number to connect to. The default is \fI11211\fP
49 .UNINDENT
50 .INDENT 0.0
51 .TP
52 .B \-c
53 .
54 Generate a coredump when it detects an error from the server.
55 .UNINDENT
56 .INDENT 0.0
57 .TP
58 .B \-v
59 .
60 Print out the comparison when it detects an error from the server.
61 .UNINDENT
62 .INDENT 0.0
63 .TP
64 .B \-t n
65 .sp
66 Set the timeout from an IO operation to/from the server to \fIn\fP seconds.
67 .UNINDENT
68 .SH DESCRIPTION
69 .sp
70 \fBmemcapable\fP connects to the specified memcached server and tries to
71 determine its capabilities by running the various commands and verifying
72 the response.
73 .SH LIMITATIONS
74 .sp
75 The current version of memcapable will only verify the binary protocol.
76 .SH HOME
77 .sp
78 To find out more information please check:
79 \fI\%http://libmemcached.org/\fP
80 .SH AUTHOR
81 .sp
82 Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
83 .SH SEE ALSO
84 .sp
85 \fImemcached(1)\fP \fIlibmemcached(3)\fP
86 .SH AUTHOR
87 Brian Aker
88 .SH COPYRIGHT
89 2011, Brian Aker DataDifferential, http://datadifferential.com/
90 .\" Generated by docutils manpage writer.
91 .\"
92 .