Merge in fix for url to main libmemcached.org site.

[awesomized/libmemcached] / docs / memcached_dump.rst

diff --git a/docs/memcached_dump.rst b/docs/memcached_dump.rst
index c9c110fe6c6819ca5dcfd5f86b1e3f74f245e10f..9b6e887e1ced9b70055c075c48d8ea95c61e70ce 100644 (file)
--- a/docs/memcached_dump.rst
+++ b/docs/memcached_dump.rst
@@ -1,31 +1,28 @@
-.. highlight:: perl
+==========================
+Dumping data from a server
+==========================

 
 
 
 

-****
-NAME
-****
+Get a list of keys found on memcached servers

 
 
 
 

-memcached_dump - get a list of keys found on memcached servers
-
-
-*******
+-------

 LIBRARY
 LIBRARY

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

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

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

 SYNOPSIS
 SYNOPSIS

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

 
 
 
 .. code-block:: perl
 
 
 
 
 .. code-block:: perl
 

-   #include <memcached.h>
+   #include <libmemcached/memcached.h>

  
    memcached_return_t
      memcached_dump (memcached_st *ptr, 
  
    memcached_return_t
      memcached_dump (memcached_st *ptr, 


@@ -40,9 +37,9 @@ SYNOPSIS
 
 
 
 
 
 

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

 DESCRIPTION
 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  memcached(1) servers.


@@ -50,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.
 
 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
 RETURN

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

 
 
 A value of type \ ``memcached_return_t``\  is returned
 
 
 A value of type \ ``memcached_return_t``\  is returned


@@ -63,27 +60,26 @@ On success that value will be \ ``MEMCACHED_SUCCESS``\ .
 Use memcached_strerror() to translate this value to a printable string.
 
 
 Use 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

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

 
 

-memcached(1) libmemcached(3) memcached_strerror(3)

 
 

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