X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fman%2Fmemcached_version.3;h=8aa7162968c913707921e22832932365e73055e0;hb=e9c7a25491f4cf9265a926b7d9848bd70acaf7aa;hp=64d744e4a3c45a6542f936d5e0a415b409d2b47c;hpb=86be0943416087ba738c28ddbde8cdcbd62ad777;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_version.3 b/docs/man/memcached_version.3 index 64d744e4..a5ff6556 100644 --- a/docs/man/memcached_version.3 +++ b/docs/man/memcached_version.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_VERSION" "3" "April 13, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_VERSION" "3" "May 31, 2012" "1.0.8" "libmemcached" .SH NAME memcached_version \- libmemcached Documentation . @@ -30,52 +30,43 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . +.SH SYNOPSIS .sp -Get library version -.SH LIBRARY -.sp -C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS -.sp -.nf -.ft C #include - -const char * - memcached_lib_version (void) - - -memcached_return_t - memcached_version (memcached_st *ptr) -.ft P -.fi -.SS DESCRIPTION +.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 -memcached_lib_version() is used to return a simple version string representing -the libmemcached version (version of the client library, not server) +Compile and link with \-lmemcached +.SH DESCRIPTION .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_lib_version()\fP is used to return a simple version string representing the libmemcached version (client library version, not server version) +.sp +\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\%http://libmemcached.org/\fP -.SH AUTHOR -.sp -Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.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