Merge in updates to all docs/etc.
[m6w6/libmemcached] / docs / man / memcached_mget_by_key.3
index cb5b4587d1f16e6613431f46125003e0761341e6..131ec38b854cf7713f228d1672d0a99fb48c3d63 100644 (file)
@@ -1,6 +1,6 @@
-.TH "MEMCACHED_MGET_BY_KEY" "3" "April 07, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_MGET_BY_KEY" "3" "April 12, 2011" "0.47" "libmemcached"
 .SH NAME
-memcached_mget_by_key \- libmemcached Documentation
+memcached_mget_by_key \- Retrieving data from the server
 .
 .nr rst2man-indent-level 0
 .
@@ -30,84 +30,47 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 ..
 .\" Man page generated from reStructeredText.
 .
-.sp
-Get a value
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)
 .SH SYNOPSIS
 .sp
-.nf
-.ft C
 #include <libmemcached/memcached.h>
-
-memcached_result_st *
-  memcached_fetch_result (memcached_st *ptr,
-                          memcached_result_st *result,
-                          memcached_return_t *error);
-
-char *
-  memcached_get (memcached_st *ptr,
-                 const char *key, size_t key_length,
-                 size_t *value_length,
-                 uint32_t *flags,
-                 memcached_return_t *error);
-
-memcached_return_t
-  memcached_mget (memcached_st *ptr,
-                const char * const *keys,
-                const size_t *key_length,
-                size_t number_of_keys);
-char *
-  memcached_get_by_key (memcached_st *ptr,
-                        const char *master_key, size_t master_key_length,
-                        const char *key, size_t key_length,
-                        size_t *value_length,
-                        uint32_t *flags,
-                        memcached_return_t *error);
-
-memcached_return_t
-  memcached_mget_by_key (memcached_st *ptr,
-                         const char *master_key, size_t master_key_length,
-                         const char * const *keys,
-                         const size_t *key_length,
-                         size_t number_of_keys);
-
-char *
-  memcached_fetch (memcached_st *ptr,
-                   char *key, size_t *key_length,
-                   size_t *value_length,
-                   uint32_t *flags,
-                   memcached_return_t *error);
-
-memcached_return_t
-  memcached_fetch_execute (memcached_st *ptr,
-                           memcached_execute_fn *callback,
-                           void *context,
-                           uint32_t number_of_callbacks);
-
-
-memcached_return_t
-  memcached_mget_execute (memcached_st *ptr,
-                          const char * const *keys,
-                          const size_t *key_length,
-                          size_t number_of_keys,
-                          memcached_execute_fn *callback,
-                          void *context,
-                          uint32_t number_of_callbacks);
-
-memcached_return_t
-  memcached_mget_execute_by_key (memcached_st *ptr,
-                                 const char *master_key,
-                                 size_t master_key_length,
-                                 const char * const *keys,
-                                 const size_t *key_length,
-                                 size_t number_of_keys,
-                                 memcached_execute_fn *callback,
-                                 void *context,
-                                 uint32_t number_of_callbacks);
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B memcached_result_st * memcached_fetch_result (memcached_st *ptr, memcached_result_st *result, memcached_return_t *error);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B char * memcached_get (memcached_st *ptr, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_mget (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B char * memcached_get_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_mget_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B char * memcached_fetch (memcached_st *ptr, char *key, size_t *key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_fetch_execute (memcached_st *ptr, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_mget_execute (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_mget_execute_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks);
+.UNINDENT
+.sp
+Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
 memcached_get() is used to fetch an individual value from the server. You
@@ -174,7 +137,7 @@ as memcached_get() and memcached_mget(). The difference is that they take
 a master key that is used for determining which server an object was stored
 if key partitioning was used for storage.
 .sp
-All of the above functions are not supported when the \fBMEMCACHED_BEHAVIOR_USE_UDP\fPhas been set. Executing any of these functions with this behavior on will result in
+All of the above functions are not testsed when the \fBMEMCACHED_BEHAVIOR_USE_UDP\fPhas been set. Executing any of these functions with this behavior on will result in
 \fBMEMCACHED_NOT_SUPPORTED\fP being returned or, for those functions which do not return
 a \fBmemcached_return_t\fP, the error function parameter will be set to
 \fBMEMCACHED_NOT_SUPPORTED\fP.
@@ -191,16 +154,13 @@ key allowed for the original memcached ascii server.
 .sp
 To find out more information please check:
 \fI\%https://launchpad.net/libmemcached\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.
 .\" 
 .