Merge working tree with build tree.
[m6w6/libmemcached] / docs / man / memcached_flush.3
index ff5948985309899e8d68e382e18be1bccb3836ef..62668ba896a1e1882344796bf50adcd6065057bb 100644 (file)
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_FLUSH" "3" "April 08, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_FLUSH" "3" "April 13, 2012" "1.0.6" "libmemcached"
 .SH NAME
 memcached_flush \- libmemcached Documentation
 .
@@ -31,38 +31,34 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" Man page generated from reStructeredText.
 .
 .sp
-memcached_flush
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-*
-.sp
 Wipe contents of memcached servers
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)
 .SH SYNOPSIS
 .sp
-.nf
-.ft C
 #include <libmemcached/memcached.h>
-
-memcached_return_t
-  memcached_flush (memcached_st *ptr,
-                   time_t expiration);
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_flush(memcached_st\fI\ *ptr\fP, time_t\fI\ expiration\fP)
+.UNINDENT
+.sp
+Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
-memcached_flush() is used to wipe clean the contents of memcached(1) servers.
+:c:func::\fImemcached_flush\fP is used to wipe clean the contents of \fBmemcached\fP servers.
 It will either do this immediately or expire the content based on the
 expiration time passed to the method (a value of zero causes an immediate
 flush). The operation is not atomic to multiple servers, just atomic to a
 single server. That is, it will flush the servers in the order that they were
 added.
+.SH RETURN
 .sp
 A value of type \fBmemcached_return_t\fP is returned
 On success that value will be \fBMEMCACHED_SUCCESS\fP.
-Use memcached_strerror() to translate this value to a printable string.
+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
@@ -71,7 +67,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP>
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
 .\" Generated by docutils manpage writer.
 .\" 
 .