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