Merge in stats fix for lp:794717

[awesomized/libmemcached] / docs / man / memcached_delete_by_key.3

diff --git a/docs/man/memcached_delete_by_key.3 b/docs/man/memcached_delete_by_key.3
index 387ee5b65c3015da04b09c6153ac6340b4fde2cd..afe0239d7fb5134c4d6ec8351983af472eaebc7f 100644 (file)
--- a/docs/man/memcached_delete_by_key.3
+++ b/docs/man/memcached_delete_by_key.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_DELETE_BY_KEY" "3" "April 08, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_DELETE_BY_KEY" "3" "May 23, 2011" "0.47" "libmemcached"
 .SH NAME
 memcached_delete_by_key \- libmemcached Documentation
 .
@@ -30,22 +30,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 ..
 .\" Man page generated from reStructeredText.
 .
-.sp
-Delete a key
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)
 .SH SYNOPSIS
 .sp
-.nf
-.ft C
 #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);
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B 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);
+.UNINDENT
+.sp
+Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
 memcached_delete() is used to delete a particular key.
@@ -53,8 +50,8 @@ memcached_delete_by_key() works the same, but it takes a master key to
 find the given value.
 .sp
 Expiration works by placing the item into a delete queue, which means that
-it won\(aqt possible to retrieve it by the "get" command, but "add" and
-"replace" command with this key will also fail (the "set" command will
+it won\(aqt be possible to retrieve it by the "get" command. The "add" and
+"replace" commands with this key will also fail (the "set" command will
 succeed, however). After the time passes, the item is finally deleted from server memory.
 .sp
 Please note the the Danga memcached server removed tests for expiration in
@@ -70,7 +67,7 @@ means that the message was queued for delivery.
 .SH HOME
 .sp
 To find out more information please check:
-\fI\%https://launchpad.net/libmemcached\fP
+\fI\%http://libmemcached.org/\fP
 .SH AUTHOR
 .sp
 Brian Aker, <\fI\%brian@tangent.org\fP>