Merge in documentation updates.
[awesomized/libmemcached] / docs / memcached_dump.rst
index c9c110fe6c6819ca5dcfd5f86b1e3f74f245e10f..4e33d17ab698a69e3cf25e6596991bb715ec8a76 100644 (file)
@@ -1,12 +1,11 @@
 .. highlight:: perl
 
 
-****
-NAME
-****
+memcached_dump
+--------------
 
 
-memcached_dump - get a list of keys found on memcached servers
+Get a list of keys found on memcached servers
 
 
 *******
@@ -17,15 +16,15 @@ 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, 
@@ -40,9 +39,9 @@ SYNOPSIS
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 memcached_dump() is used to get a list of keys found  memcached(1) servers.
@@ -50,7 +49,7 @@ 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.
 
 
 ******
@@ -80,10 +79,9 @@ 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)`