Merge

[m6w6/libmemcached] / docs / man / memcached_delete.3

diff --git a/docs/man/memcached_delete.3 b/docs/man/memcached_delete.3
index 30c79c5617a0e8c3c63596472e08706726916c49..55dac7daec80bb95c1b4025949dcedddc0830c0e 100644 (file)
--- a/docs/man/memcached_delete.3
+++ b/docs/man/memcached_delete.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_DELETE" "3" "April 09, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_DELETE" "3" "September 26, 2011" "0.53" "libmemcached"
 .SH NAME
 memcached_delete \- libmemcached Documentation
 .
@@ -30,31 +30,28 @@ 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.
-memcached_delete_by_key() works the same, but it takes a master key to
-find the given value.
+\fBmemcached_delete()\fP is used to delete a particular key.
+\fBmemcached_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
@@ -63,14 +60,15 @@ 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.
 .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>