Merge in update such that trunk tree no longer commits manpages.

[m6w6/libmemcached] / docs / memcached_dump.rst

diff --git a/docs/memcached_dump.rst b/docs/memcached_dump.rst
index c9c110fe6c6819ca5dcfd5f86b1e3f74f245e10f..08c21c464d50f8434aa206bb0eb603ea3a5c6ae1 100644 (file)
--- a/docs/memcached_dump.rst
+++ b/docs/memcached_dump.rst
@@ -1,61 +1,44 @@
-.. highlight:: perl
+==========================
+Dumping data from a server
+==========================
 
 
-****
-NAME
-****
+Get a list of keys found on memcached servers
 
+.. index:: object: memcached_st
 
-memcached_dump - get a list of keys found on memcached servers
 
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
-********
+--------
 SYNOPSIS
-********
+--------
 
 
+#include <libmemcached/memcached.h>
 
-.. code-block:: perl
-
-   #include <memcached.h>
- 
-   memcached_return_t
-     memcached_dump (memcached_st *ptr, 
-                     memcached_dump_fn *function, 
-                     void *context, 
-                     uint32_t number_of_callbacks);
+.. c:function:: 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
 
 
-***********
+
+-----------
 DESCRIPTION
-***********
+-----------
 
 
-memcached_dump() is used to get a list of keys found  memcached(1) servers.
+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 supported.
+Currently the binary protocol is not testsed.
 
 
-******
+------
 RETURN
-******
+------
 
 
 A value of type \ ``memcached_return_t``\  is returned
@@ -63,27 +46,26 @@ On success that value will be \ ``MEMCACHED_SUCCESS``\ .
 Use 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>
 
 
-********
+--------
 SEE ALSO
-********
-
+--------
 
-memcached(1) libmemcached(3) memcached_strerror(3)
 
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`