Merging bzr://gaz.tangent.org/libmemcached/build/ to Build branch

[m6w6/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 ae99f61e0f10ed01271d8557ee7b27f900b20e1d..17becf4beef8bb6dcf892cf22c9de08045e99934 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 13, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_DELETE_BY_KEY" "3" "April 13, 2012" "1.0.6" "libmemcached"
 .SH NAME
 memcached_delete_by_key \- libmemcached Documentation
 .
@@ -35,23 +35,23 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 #include <libmemcached/memcached.h>
 .INDENT 0.0
 .TP
-.B memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration);
+.B memcached_return_t memcached_delete(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, time_t\fI\ expiration\fP)
 .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);
+.B memcached_return_t memcached_delete_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, time_t\fI\ expiration\fP)
 .UNINDENT
 .sp
 Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
-memcached_delete() is used to delete a particular key.
-memcached_delete_by_key() works the same, but it takes a master key to
-find the given value.
+\fI\%memcached_delete()\fP is used to delete a particular key.
+\fI\%memcached_delete_by_key()\fP 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
@@ -60,7 +60,8 @@ the 1.4 version.
 .sp
 A value of type \fBmemcached_return_t\fP is returned
 On success that value will be \fBMEMCACHED_SUCCESS\fP.
-Use memcached_strerror() to translate this value to a printable string.
+Use \fBmemcached_strerror()\fP to translate this value to a printable
+string.
 .sp
 If you are using the non\-blocking mode of the library, success only
 means that the message was queued for delivery.