Merging lp:~brianaker/libmemcached/rpm-mkdir-fix to Build branch
[m6w6/libmemcached] / docs / man / memcached_quit.3
index 3f35379918e63425969cac5e642a01fe51edcb02..7b11d68f6f7ffc27eccb2c69e70e3c9f3f9b6621 100644 (file)
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_QUIT" "3" "June 02, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_QUIT" "3" "May 31, 2012" "1.0.8" "libmemcached"
 .SH NAME
 memcached_quit \- libmemcached Documentation
 .
@@ -35,26 +35,25 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 #include <libmemcached/memcached.h>
 .INDENT 0.0
 .TP
-.B void memcached_quit (memcached_st *ptr);
+.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: