Merge in main doc trunk.

[m6w6/libmemcached] / docs / memcached_dump.rst

diff --git a/docs/memcached_dump.rst b/docs/memcached_dump.rst
index ab63c7ef51b4a2e46ac4359616c78c3c25c12581..2e119684cd106242e582f3f89b0eaa3e34e333ef 100644 (file)
--- a/docs/memcached_dump.rst
+++ b/docs/memcached_dump.rst
@@ -1,30 +1,28 @@
-.. 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)
 
 
-********
+--------
 SYNOPSIS
-********
+--------
 
 
 
 .. code-block:: perl
 
-   #include <memcached.h>
+   #include <libmemcached/memcached.h>
  
    memcached_return_t
      memcached_dump (memcached_st *ptr, 
@@ -39,9 +37,9 @@ SYNOPSIS
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 memcached_dump() is used to get a list of keys found  memcached(1) servers.
@@ -49,12 +47,12 @@ 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 binar protocol is not testsed.
 
 
-******
+------
 RETURN
-******
+------
 
 
 A value of type \ ``memcached_return_t``\  is returned
@@ -62,27 +60,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>`_
 
 
-******
+------
 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)`