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

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

diff --git a/docs/man/memcached_dump.3 b/docs/man/memcached_dump.3
index 5f076301915120a9b71d2960d85a7cf2f937c838..ba8b15f34df002c59ba1af005cdb60d87b10ce9f 100644 (file)
--- a/docs/man/memcached_dump.3
+++ b/docs/man/memcached_dump.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_DUMP" "3" "April 12, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_DUMP" "3" "May 03, 2012" "1.0.7" "libmemcached"
 .SH NAME
 memcached_dump \- libmemcached Documentation
 .
@@ -32,44 +32,37 @@ 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 <libmemcached/memcached.h>
-
-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\fI\ *ptr\fP, \fI\%memcached_dump_fn\fP\fI\ *function\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t (*memcached_dump_fn)(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, void\fI\ *context\fP)
+.UNINDENT
+.sp
+Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
-memcached_dump() is used to get a list of keys found  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
+\fI\%memcached_dump()\fP 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
 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.
 .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>