Cleanup API documentation.
[m6w6/libmemcached] / docs / man / memcapable.1
index 965a9f6a005954da836f9004fb85c898b116d7ae..6659f88f4e2c78e436489344de1e1e16bdaab0eb 100644 (file)
@@ -1,4 +1,4 @@
-.TH "MEMCAPABLE" "1" "April 08, 2011" "0.47" "libmemcached"
+.TH "MEMCAPABLE" "1" "April 09, 2011" "0.47" "libmemcached"
 .SH NAME
 memcapable \- libmemcached Documentation
 .
@@ -31,44 +31,43 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" Man page generated from reStructeredText.
 .
 .sp
-Check memcached server capabilities
+Check the server for compatibility and capabilities
 .SH SYNOPSIS
-.sp
-.nf
-.ft C
-memcat [\-h hostname] [\-p port] [\-c] [\-v] [\-t n]
-.ft P
-.fi
-.SH DESCRIPTION
-.sp
-\fBmemcapable\fP connects to the specified memcached server and tries to
-determine its capabilities by running the various commands and verifying
-the response.
-.SH OPTIONS
-.sp
-The following options are supported:
 .INDENT 0.0
 .TP
-.BI \-h \ hostname
-.
+.B \-h hostname
+.sp
 Specify the hostname to connect to. The default is \fIlocalhost\fP
+.UNINDENT
+.INDENT 0.0
 .TP
-.BI \-p \ port
-.
+.B \-p port
+.sp
 Specify the port number to connect to. The default is \fI11211\fP
+.UNINDENT
+.INDENT 0.0
 .TP
 .B \-c
 .
 Generate a coredump when it detects an error from the server.
+.UNINDENT
+.INDENT 0.0
 .TP
 .B \-v
 .
 Print out the comparison when it detects an error from the server.
+.UNINDENT
+.INDENT 0.0
 .TP
-.BI \-t \ n
-.
+.B \-t n
+.sp
 Set the timeout from an IO operation to/from the server to \fIn\fP seconds.
 .UNINDENT
+.SH DESCRIPTION
+.sp
+\fBmemcapable\fP connects to the specified memcached server and tries to
+determine its capabilities by running the various commands and verifying
+the response.
 .SH LIMITATIONS
 .sp
 The current version of memcapable will only verify the binary protocol.
@@ -81,11 +80,11 @@ To find out more information please check:
 Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
 .SH SEE ALSO
 .sp
-memcached(1) libmemcached(3)
+\fImemcached(1)\fP \fIlibmemcached(3)\fP
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
 .\" Generated by docutils manpage writer.
 .\" 
 .