Merge Trunk

[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 e2bf84711ef33eac4b3afdb857d3452657a40435..705922a7698df40ca97aa47f883e0454d0e72b6d 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 07, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_DELETE_BY_KEY" "3" "June 17, 2011" "0.49" "libmemcached"

 .SH NAME
 memcached_delete_by_key \- libmemcached Documentation
 .
 .SH NAME
 memcached_delete_by_key \- libmemcached Documentation
 .


@@ -30,29 +30,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 ..
 .\" Man page generated from reStructeredText.
 .
 ..
 .\" Man page generated from reStructeredText.
 .

-.sp
-Delete a key
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)

 .SH SYNOPSIS
 .sp
 .SH SYNOPSIS
 .sp

-.nf
-.ft C

 #include <libmemcached/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);
-.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.
 .SH DESCRIPTION
 .sp
 memcached_delete() is used to delete a particular key.


@@ -60,11 +50,11 @@ 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
 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
 succeed, however). After the time passes, the item is finally deleted from server memory.
 .sp

-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.
 .SH RETURN
 .sp
 the 1.4 version.
 .SH RETURN
 .sp


@@ -77,17 +67,17 @@ means that the message was queued for delivery.
 .SH HOME
 .sp
 To find out more information please check:
 .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>
 .SH SEE ALSO
 .sp
 .SH AUTHOR
 .sp
 Brian Aker, <\fI\%brian@tangent.org\fP>
 .SH SEE ALSO
 .sp

-memcached(1) libmemcached(3) memcached_strerror(3)
+\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP

 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT

-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/

 .\" Generated by docutils manpage writer.
 .\" 
 .
 .\" Generated by docutils manpage writer.
 .\" 
 .