MEMCACHED_BEHAVIOR_RETRY_TIMEOUT added for timeout

[awesomized/libmemcached] / docs / memcached_delete.pod

diff --git a/docs/memcached_delete.pod b/docs/memcached_delete.pod
index 562bdce78317a6b1244ec36089f353e60f8717b9..18fec84b4cb80c754577a1528e236abe122e1e44 100755 (executable)
--- a/docs/memcached_delete.pod
+++ b/docs/memcached_delete.pod
@@ -8,29 +8,43 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
 =head1 SYNOPSIS
 
-#include <memcached.h>
+  #include <memcached.h>
 
-memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length,
-                                  time_t expiration);
+  memcached_return
+    memcached_delete (memcached_st *ptr,
+                      char *key, size_t key_length,
+                      time_t expiration);
+
+  memcached_return
+  memcached_delete_by_key (memcached_st *ptr,
+                           char *master_key, size_t master_key_length,
+                           char *key, size_t key_length,
+                           time_t expiration);
 
 =head1 DESCRIPTION
 
 memcached_delete() is used to delete a particular key. An expiration value
-can be applied so that the key is deleted after a set number of seconds.
+can be applied so that the key is deleted after that many seconds.
+memcached_delete_by_key() works the same, but it takes a master key to 
+find the given value.
 
 =head1 RETURN
 
-memcached_delete() returns memcached_return. The value on success will be MEMCACHED_SUCCESS. For all errors check with memcached_strerror().
-If you are using the non-blocking mode of the library, success only means
-that the message was queued for delivery. 
+A value of type C<memcached_return> is returned
+On success that value will be C<MEMCACHED_SUCCESS>.
+Use memcached_strerror() to translate this value to a printable string.
+
+If you are using the non-blocking mode of the library, success only
+means that the message was queued for delivery.
 
 =head1 HOME
 
-To find out more information please check: http://tangent.org/552/libmemcached.html
+To find out more information please check:
+L<http://tangent.org/552/libmemcached.html>
 
 =head1 AUTHOR
 
-Brian Aker, brian@tangent.org
+Brian Aker, E<lt>brian@tangent.orgE<gt>
 
 =head1 SEE ALSO