projects / awesomized / libmemcached / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree | github
raw | inline | side by side
Simplify the calling structure for creating a memcached_st.
[awesomized/libmemcached] / docs / man / memcached_cas_by_key.3
diff --git a/docs/man/memcached_cas_by_key.3 b/docs/man/memcached_cas_by_key.3
index 7bbdcf4aefca1761682b146432029313726af0bb..5ae0e364fab83679696f9a74e6993c32fee9c994 100644 (file)
--- a/docs/man/memcached_cas_by_key.3
+++ b/docs/man/memcached_cas_by_key.3
@@ -1,6 +1,6 @@
-.TH "MEMCACHED_CAS_BY_KEY" "3" "April 08, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_CAS_BY_KEY" "3" "April 13, 2011" "0.47" "libmemcached"
 .SH NAME
-memcached_cas_by_key \- libmemcached Documentation
+memcached_cas_by_key \- Storing and Replacing Data
 .
 .nr rst2man-indent-level 0
 .
@@ -32,107 +32,59 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .
 .sp
 Store value on server
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)
 .SH SYNOPSIS
 .sp
-.nf
-.ft C
 #include <libmemcached/memcached.h>
-
-memcached_return_t
-  memcached_set (memcached_st *ptr,
-                 const char *key, size_t key_length,
-                 const char *value, size_t value_length,
-                 time_t expiration,
-                 uint32_t flags);
-
-memcached_return_t
-  memcached_add (memcached_st *ptr,
-                 const char *key, size_t key_length,
-                 const char *value, size_t value_length,
-                 time_t expiration,
-                 uint32_t flags);
-
-memcached_return_t
-  memcached_replace (memcached_st *ptr,
-                     const char *key, size_t key_length,
-                     const char *value, size_t value_length,
-                     time_t expiration,
-                     uint32_t flags);
-
-memcached_return_t
-  memcached_prepend(memcached_st *ptr,
-                    const char *key, size_t key_length,
-                    const char *value, size_t value_length,
-                    time_t expiration,
-                    uint32_t flags)
-
-memcached_return_t
-  memcached_append(memcached_st *ptr,
-                   const char *key, size_t key_length,
-                    const char *value, size_t value_length,
-                    time_t expiration,
-                    uint32_t flags)
-memcached_return_t
-  memcached_cas(memcached_st *ptr,
-                const char *key, size_t key_length,
-                const char *value, size_t value_length,
-                time_t expiration,
-                uint32_t flags,
-                uint64_t cas);
-
-memcached_return_t
-  memcached_set_by_key(memcached_st *ptr,
-                       const char *master_key, size_t master_key_length,
-                       const char *key, size_t key_length,
-                       const char *value, size_t value_length,
-                       time_t expiration,
-                       uint32_t flags);
-
-memcached_return_t
-  memcached_add_by_key(memcached_st *ptr,
-                       const char *master_key, size_t master_key_length,
-                       const char *key, size_t key_length,
-                       const char *value, size_t value_length,
-                       time_t expiration,
-                       uint32_t flags);
-
-memcached_return_t
-  memcached_replace_by_key(memcached_st *ptr,
-                           const char *master_key, size_t master_key_length,
-                           const char *key, size_t key_length,
-                           const char *value, size_t value_length,
-                           time_t expiration,
-                           uint32_t flags);
-
-memcached_return_t
-  memcached_prepend_by_key(memcached_st *ptr,
-                           const char *master_key, size_t master_key_length,
-                           const char *key, size_t key_length,
-                           const char *value, size_t value_length,
-                           time_t expiration,
-                           uint32_t flags);
-
-memcached_return_t
-  memcached_append_by_key(memcached_st *ptr,
-                          const char *master_key, size_t master_key_length,
-                          const char *key, size_t key_length,
-                          const char *value, size_t value_length,
-                          time_t expiration,
-                          uint32_t flags);
-
-memcached_return_t
-  memcached_cas_by_key(memcached_st *ptr,
-                       const char *master_key, size_t master_key_length,
-                       const char *key, size_t key_length,
-                       const char *value, size_t value_length,
-                       time_t expiration,
-                       uint32_t flags,
-                       uint64_t cas);
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_set (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_add (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_replace (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_prepend(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_append(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_cas(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_set_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_add_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_replace_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_prepend_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_append_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_cas_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas);
+.UNINDENT
+.sp
+Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
 memcached_set(), memcached_add(), and memcached_replace() are all used to
@@ -169,7 +121,7 @@ information on how to do this.
 memcached_set_by_key(), memcached_add_by_key(), memcached_replace_by_key(),
 memcached_prepend_by_key(), memcached_append_by_key_by_key(),
 memcached_cas_by_key() methods all behave in a similar method as the non key
-methods. The difference is that they use their master_key parameter to map
+methods. The difference is that they use their group_key parameter to map
 objects to particular servers.
 .sp
 If you are looking for performance, memcached_set() with non\-blocking IO is
@@ -207,7 +159,7 @@ memcached(1) libmemached(3) memcached_strerror(3)
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
 .\" Generated by docutils manpage writer.
 .\" 
 .
Resurrection of libmemcached