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

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

diff --git a/docs/man/memcached_quit.3 b/docs/man/memcached_quit.3
index 719858cf630a77552dac1e13672ad09db1a2ff6f..405d010a816420bf54fffe9512275933adbb8f9e 100644 (file)
--- a/docs/man/memcached_quit.3
+++ b/docs/man/memcached_quit.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_QUIT" "3" "April 07, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_QUIT" "3" "April 09, 2012" "1.0.6" "libmemcached"
 .SH NAME
 memcached_quit \- libmemcached Documentation
 .
@@ -30,50 +30,44 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 ..
 .\" Man page generated from reStructeredText.
 .
-.sp
-Disconnect from all servers
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)
 .SH SYNOPSIS
 .sp
-.nf
-.ft C
 #include <libmemcached/memcached.h>
-
-void memcached_quit (memcached_st *ptr);
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B void memcached_quit(memcached_st\fI\ *ptr\fP)
+.UNINDENT
+.sp
+Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
-memcached_quit() will disconnect you from all currently connected servers.
-It will also reset the state of the connection (ie, any memcached_fetch() you
-are in the middle of will be terminated). This function is called
-automatically when you call memcached_free() on the \fBmemcached_st\fP structure.
+\fI\%memcached_quit()\fP will disconnect you from all currently connected
+servers. It will also reset the state of the connection (ie, any \fBmemcached_fetch()\fP you are in the middle of will be terminated). This function is
+called automatically when you call \fBmemcached_free()\fP on the \fBmemcached_st\fP structure.
 .sp
 You do not need to call this on your own. All operations to change server
 hashes and parameters will handle connections to the server for you. This
 function is provided mainly so that you can timeout your connections or
-reset connections during the middle of a memcached_fetch().
+reset connections during the middle of a \fBmemcached_fetch()\fP.
 .SH RETURN
 .sp
-A value of type \fBmemcached_return\fP is returned
-On success that value will be \fBMEMCACHED_SUCCESS\fP.
-Use memcached_strerror() to translate this value to a printable string.
+A value of type \fBmemcached_return_t\fP is returned On success that value
+will be \fBMEMCACHED_SUCCESS\fP.  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
+\fI\%http://libmemcached.org/\fP
 .SH AUTHOR
 .sp
 Brian Aker, <\fI\%brian@tangent.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.
 .\" 
 .