Merge in new examples.

[m6w6/libmemcached] / docs / memcached_delete.rst

diff --git a/docs/memcached_delete.rst b/docs/memcached_delete.rst
index 9d9d77840ba019d0efc908aa37e32855a7ddecbb..6082094a23c43f88838f10df6dc2804b2e1beeec 100644 (file)
--- a/docs/memcached_delete.rst
+++ b/docs/memcached_delete.rst
@@ -1,47 +1,23 @@
-.. highlight:: perl
+===========================
+Deleting data from a server
+===========================

 
 

-
-memcached_delete
-****************
-
-
-Delete a key
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
-********
+--------

 SYNOPSIS
 SYNOPSIS

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

 
 

-.. code-block:: perl

 
 

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

  
  

-   memcached_return_t
-     memcached_delete (memcached_st *ptr,
-                       const char *key, size_t key_length,
-                       time_t expiration);
- 
-   memcached_return_t
-   memcached_delete_by_key (memcached_st *ptr,
-                            const char *master_key, size_t master_key_length,
-                            const char *key, size_t key_length,
-                            time_t expiration);
+.. c:function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration);

 
 

+.. c:function:: memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration);

 
 

+Compile and link with -lmemcached

 
 

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

 DESCRIPTION
 DESCRIPTION

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

 
 
 memcached_delete() is used to delete a particular key. 
 
 
 memcached_delete() is used to delete a particular key. 


@@ -53,13 +29,13 @@ it won't possible to retrieve it by the "get" command, but "add" and
 "replace" command with this key will also fail (the "set" command will 
 succeed, however). After the time passes, the item is finally deleted from server memory.
 
 "replace" command with this key will also fail (the "set" command will 
 succeed, however). After the time passes, the item is finally deleted from server memory.
 

-Please note the the Danga memcached server removed support for expiration in
+Please note the the Danga memcached server removed tests for expiration in

 the 1.4 version.
 
 
 the 1.4 version.
 
 

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

 RETURN
 RETURN

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

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


@@ -70,27 +46,25 @@ If you are using the non-blocking mode of the library, success only
 means that the message was queued for delivery.
 
 
 means that the message was queued for delivery.
 
 

-****
+----

 HOME
 HOME

-****
+----

 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 

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

 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)`