X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_dump.3;h=4a0f41e8c0ae086cbe0d4a545434a8e8bb261b2c;hb=625e84ebfc422790372bc2984f504bdcb4da779c;hp=a93a5c432ad4e442c24d56e82d34795f36b4857c;hpb=2e5705daa52faa457f104864a27cfbba98ed568e;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_dump.3 b/docs/man/memcached_dump.3 index a93a5c43..4a0f41e8 100644 --- a/docs/man/memcached_dump.3 +++ b/docs/man/memcached_dump.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_DUMP" "3" "April 10, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_DUMP" "3" "June 17, 2011" "0.49" "libmemcached" .SH NAME memcached_dump \- libmemcached Documentation . @@ -32,35 +32,27 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] . .sp Get a list of keys found on memcached servers -.SH LIBRARY -.sp -C Client Library for memcached (libmemcached, \-lmemcached) .SH SYNOPSIS .sp -.nf -.ft C #include - -memcached_return_t - memcached_dump (memcached_st *ptr, - memcached_dump_fn *function, - void *context, - uint32_t number_of_callbacks); - -typedef memcached_return_t (*memcached_dump_fn)(memcached_st *ptr, - const char *key, - size_t key_length, - void *context); -.ft P -.fi +.INDENT 0.0 +.TP +.B memcached_return_t memcached_dump (memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks); +.UNINDENT +.INDENT 0.0 +.TP +.B typedef memcached_return_t (*memcached_dump_fn)(memcached_st *ptr, const char *key, size_t key_length, void *context); +.UNINDENT +.sp +Compile and link with \-lmemcached .SH DESCRIPTION .sp -memcached_dump() is used to get a list of keys found memcached(1) servers. +memcached_dump() is used to get a list of keys found in memcached(1) servers. Because memcached(1) does not guarentee to dump all keys you can not assume you have fetched all keys from the server. The function takes an array of callbacks that it will use to execute on keys as they are found. .sp -Currently the binar protocol is not testsed. +Currently the binary protocol is not testsed. .SH RETURN .sp A value of type \fBmemcached_return_t\fP is returned @@ -69,7 +61,7 @@ Use memcached_strerror() to translate this value to a printable string. .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>