Merging bzr://gaz.tangent.org/libmemcached/build/ to Build branch
[m6w6/libmemcached] / docs / man / memcached_flush.3
index 9ef4144ff230426e12bcda067995f6e1bfb6250e..de76c39b7e13c2100231314b754f5fb97031a95e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_FLUSH" "3" "April 07, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_FLUSH" "3" "April 09, 2012" "1.0.6" "libmemcached"
 .SH NAME
 memcached_flush \- libmemcached Documentation
 .
@@ -32,23 +32,18 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .
 .sp
 Wipe contents of memcached servers
-.SH LIBRARY
-.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
@@ -58,21 +53,21 @@ added.
 .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
 .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.
 .\" 
 .