X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_dump.rst;h=3ef1c43c0ec97decceaf425563678e4b9d1ef165;hb=36dd2e646b1290791dfcd2e8d94ab02591f32904;hp=4e33d17ab698a69e3cf25e6596991bb715ec8a76;hpb=281c398ba3a10af677494c4453cd09d85ca921e0;p=m6w6%2Flibmemcached

diff --git a/docs/memcached_dump.rst b/docs/memcached_dump.rst
index 4e33d17a..3ef1c43c 100644
--- a/docs/memcached_dump.rst
+++ b/docs/memcached_dump.rst
@@ -1,19 +1,11 @@
-.. highlight:: perl
-
-
-memcached_dump
---------------
+==========================
+Dumping data from a server
+==========================
 
 
 Get a list of keys found on memcached servers
 
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
+.. index:: object: memcached_st
 
 
 --------
@@ -21,21 +13,13 @@ SYNOPSIS
 --------
 
 
+#include <libmemcached/memcached.h>
 
-.. code-block:: perl
-
-   #include <libmemcached/memcached.h>
+.. c:function:: memcached_return_t memcached_dump (memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks);
  
-   memcached_return_t
-     memcached_dump (memcached_st *ptr, 
-                     memcached_dump_fn *function, 
-                     void *context, 
-                     uint32_t number_of_callbacks);
- 
-   typedef memcached_return_t (*memcached_dump_fn)(memcached_st *ptr,  
-                                                   const char *key, 
-                                                   size_t key_length, 
-                                                   void *context);
+.. c:function::  typedef memcached_return_t (*memcached_dump_fn)(memcached_st *ptr,  const char *key, size_t key_length, void *context);
+
+Compile and link with -lmemcached
 
 
 
@@ -44,36 +28,37 @@ DESCRIPTION
 -----------
 
 
-memcached_dump() is used to get a list of keys found  memcached(1) servers.
-Because memcached(1) does not guarentee to dump all keys you can not assume
-you have fetched all keys from the server. The function takes an array
+:c:func:`memcached_dump()` is used to get a list of keys found in memcached(1) 
+servers. Because memcached(1) does not guarentee to dump all keys you can not 
+assume you have fetched all keys from the server. The function takes an array
 of callbacks that it will use to execute on keys as they are found.
 
-Currently the binar protocol is not testsed.
+Currently the binary protocol is not testsed.
 
 
-******
+------
 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>