Update docs.
[m6w6/libmemcached] / docs / man / memcached_flush_buffers.3
1 .TH "MEMCACHED_FLUSH_BUFFERS" "3" "April 08, 2011" "0.47" "libmemcached"
2 .SH NAME
3 memcached_flush_buffers \- libmemcached Documentation
4 .
5 .nr rst2man-indent-level 0
6 .
7 .de1 rstReportMargin
8 \\$1 \\n[an-margin]
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
11 -
12 \\n[rst2man-indent0]
13 \\n[rst2man-indent1]
14 \\n[rst2man-indent2]
15 ..
16 .de1 INDENT
17 .\" .rstReportMargin pre:
18 . RS \\$1
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
22 ..
23 .de UNINDENT
24 . RE
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30 ..
31 .\" Man page generated from reStructeredText.
32 .
33 .sp
34 Flush buffers and send buffered commands
35 .SH LIBRARY
36 .sp
37 C Client Library for memcached (libmemcached, \-lmemcached)
38 .SH SYNOPSIS
39 .sp
40 .nf
41 .ft C
42 #include <libmemcached/memcached.h>
43
44 memcached_return_t
45 memcached_flush_buffers (memcached_st *ptr);
46 .ft P
47 .fi
48 .SH DESCRIPTION
49 .sp
50 memcached_flush_buffers() is used in conjunction with
51 MEMCACHED_BEHAVIOR_BUFFER_REQUESTS (see memcached_behavior(3)) to flush
52 all buffers by sending the buffered commands to the server for processing.
53 .SH RETURN
54 .sp
55 A value of type \fBmemcached_return_t\fP is returned
56 On success that value will be \fBMEMCACHED_SUCCESS\fP.
57 Use memcached_strerror() to translate this value to a printable string.
58 .SH HOME
59 .sp
60 To find out more information please check:
61 \fI\%https://launchpad.net/libmemcached\fP
62 .SH AUTHOR
63 .sp
64 Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
65 .SH SEE ALSO
66 .sp
67 memcached(1) libmemcached(3) memcached_strerror(3) memcached_behavior(3)
68 .SH AUTHOR
69 Brian Aker
70 .SH COPYRIGHT
71 2011, Brian Aker
72 .\" Generated by docutils manpage writer.
73 .\"
74 .