Fix for mkdir rpm directories.
[m6w6/libmemcached] / docs / memcached_flush_buffers.rst
index 2d8a5b7f9119e1a7bd87aafba52acc1190d682d1..888c9254420ed6d1072d4a3faa095e9e87311229 100644 (file)
@@ -1,34 +1,21 @@
-.. highlight:: perl
+=======================
+Flushing client buffers
+=======================
 
 
-memcached_flush_buffers
-----------------------*
-
-
-Flush buffers and send buffered commands
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
+.. index:: object: memcached_st
 
+Flush and senf buffered commands
 
 --------
 SYNOPSIS
 --------
 
-
-
-.. code-block:: perl
-
-   #include <libmemcached/memcached.h>
+#include <libmemcached/memcached.h>
  
-   memcached_return_t
-     memcached_flush_buffers (memcached_st *ptr);
+.. c:function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr)
 
+Compile and link with -lmemcached
 
 
 -----------
@@ -36,34 +23,36 @@ DESCRIPTION
 -----------
 
 
-memcached_flush_buffers() is used in conjunction with 
-MEMCACHED_BEHAVIOR_BUFFER_REQUESTS (see memcached_behavior(3)) to flush
-all buffers by sending the buffered commands to the server for processing.
+:c:func:`memcached_flush_buffers` is used in conjunction with 
+:c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing.
 
 
-******
+------
 RETURN
-******
+------
 
 
-A value of type \ ``memcached_return_t``\  is returned
-On success that value will be \ ``MEMCACHED_SUCCESS``\ .
-Use memcached_strerror() to translate this value to a printable string.
+A value of type :c:type:`memcached_return_t` is returned
+On success that value will be :c:type:`MEMCACHED_SUCCESS`.
+Use :c:func:`memcached_strerror` to translate this value to a printable 
+string.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-******
+------
 AUTHOR
-******
+------
+
 
+Brian Aker, <brian@tangent.org>
 
 Trond Norbye, <trond.norbye@gmail.com>