Merge bzr://10.0.3.21 Build: jenkins-Libmemcached-469

[awesomized/libmemcached] / docs / memcached_dump.rst

diff --git a/docs/memcached_dump.rst b/docs/memcached_dump.rst
index 1a28091a7e7dd1164ff5376d4f26cf789cd0ae41..988410fc40fbdac1b57505962a75a2009845a3ab 100644 (file)
--- a/docs/memcached_dump.rst
+++ b/docs/memcached_dump.rst
@@ -1,87 +1,72 @@
-.. highlight:: perl
-
-
-memcached_dump
-**************
+==========================
+Dumping data from a server
+==========================

 
 
 Get a list of keys found on memcached servers
 
 
 
 Get a list of keys found on memcached servers
 

+.. index:: object: memcached_st

 
 

-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)

 
 

-
-********
+--------

 SYNOPSIS
 SYNOPSIS

-********
-
+--------

 
 
 
 

-.. code-block:: perl
+#include <libmemcached/memcached.h>

 
 

-   #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:type:: memcached_return_t (*memcached_dump_fn)(memcached_st *ptr,  const char *key, size_t key_length, void *context)
+
+Compile and link with -lmemcached

 
 
 
 
 
 

-***********
+-----------

 DESCRIPTION
 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.
 
 of callbacks that it will use to execute on keys as they are found.
 

-Currently the binar protocol is not supported.
+Currently the binary protocol is not testsed.

 
 
 
 

-******
+------

 RETURN
 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
 HOME

-****
+----

 
 
 To find out more information please check:
 
 
 To find out more information please check:

-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_

 
 
 
 

-******
+------

 AUTHOR
 AUTHOR

-******
+------

 
 
 Brian Aker, <brian@tangent.org>
 
 
 
 
 Brian Aker, <brian@tangent.org>
 
 

-********
+--------

 SEE ALSO
 SEE ALSO

-********
+--------

 
 
 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
 
 
 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`