Merging bzr://gaz.tangent.org/libmemcached/build/ to Build branch

[m6w6/libmemcached] / docs / man / memcached_version.3

diff --git a/docs/man/memcached_version.3 b/docs/man/memcached_version.3
index f1c37883fd2054618cd1c4f4ab8a4495c49cdf96..c94ecf061671c770ff29aa1c1826159e9a364642 100644 (file)
--- a/docs/man/memcached_version.3
+++ b/docs/man/memcached_version.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_VERSION" "3" "April 07, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_VERSION" "3" "April 08, 2012" "1.0.6" "libmemcached"
 .SH NAME
 memcached_version \- libmemcached Documentation
 .
@@ -30,56 +30,47 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 ..
 .\" Man page generated from reStructeredText.
 .
-.sp
-Get library version
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)
 .SH SYNOPSIS
 .sp
-.nf
-.ft C
 #include <libmemcached/memcached.h>
-
-const char *
-  memcached_lib_version (void)
-
-
-memcached_return_t
-  memcached_version (memcached_st *ptr)
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B const char * memcached_lib_version(void)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_version(memcached_st\fI\ *ptr\fP)
+.UNINDENT
+.sp
+Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
-memcached_lib_version() is used to return a simple version string representing
-the libmemcached version (version of the client library, not server)
+\fI\%memcached_lib_version()\fP is used to return a simple version string representing the libmemcached version (client library version, not server version)
 .sp
-memcached_version() is used to set the major, minor, and micro versions of each
-memcached server being used by the memcached_st connection structure. It returns the
-memcached server return code.
+\fI\%memcached_version()\fP is used to set the major, minor, and micro versions of each memcached server being used by the memcached_st connection structure. It returns the memcached server return code.
 .SH RETURN
 .sp
-A string with the version of libmemcached driver is returned from
-memcached_lib_version()
+\fI\%memcached_lib_version()\fP returns a string with the version of the libmemcached driver.
+.sp
+A value of \fBmemcached_return_t\fP is returned from :c:func:\(aqmemcached_version\(aq
 .sp
-A value of type \fBmemcached_return_t\fP is returned from memcached_version()
-On success that value will be \fBMEMCACHED_SUCCESS\fP. If called with the
-\fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set, the value \fBMEMCACHED_NOT_SUPPORTED\fPwill be returned. Use memcached_strerror() to translate this value to
+On success that value will be \fBMEMCACHED_SUCCESS\fP.
+.sp
+If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP()\fP behavior set, the value \fBMEMCACHED_NOT_SUPPORTED\fP will be returned.
+.sp
+Use \fBmemcached_strerror()\fP to translate this value to
 a printable string.
 .SH HOME
 .sp
 To find out more information please check:
-\fI\%https://launchpad.net/libmemcached\fP
-.SH AUTHOR
-.sp
-Brian Aker, <\fI\%brian@tangent.org\fP>
+\fI\%http://libmemcached.org/\fP
 .SH SEE ALSO
 .sp
-memcached(1) libmemcached(3) memcached_strerror(3)
+\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
 .\" Generated by docutils manpage writer.
 .\" 
 .