X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_delete_by_key.3;h=0766783d7d5659ad2466f3b7e8ed9972ab103d83;hb=556d9cca3738f2dcecbe0cda93ba9dd89d1a7a31;hp=69b742fccee01c781b32b795a86b2d9392bc319f;hpb=f8620692e077bfeca1b6d51e1543ffa0f3e344fd;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_delete_by_key.3 b/docs/man/memcached_delete_by_key.3 index 69b742fc..0766783d 100644 --- 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" "April 09, 2012" "1.0.6" "libmemcached" .SH NAME memcached_delete_by_key \- libmemcached Documentation . @@ -30,64 +30,55 @@ 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 - -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\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\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 support for expiration in +Please note the the Danga memcached server removed tests for expiration in the 1.4 version. .SH RETURN .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> .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 -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" .