Merge in more documentation.
[awesomized/libmemcached] / docs / man / memcached_append.3
index 9411d1278680d8bd44ea3406d12d69f7cd58b2f4..4da04b80d9146ad3b6dcdcac5238346f881adb6e 100644 (file)
@@ -1,6 +1,6 @@
 .TH "MEMCACHED_APPEND" "3" "April 09, 2011" "0.47" "libmemcached"
 .SH NAME
-memcached_append \- libmemcached Documentation
+memcached_append \- 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 *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);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B 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);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B 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);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B 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);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B 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);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B 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);
+.UNINDENT
+.sp
+Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
 memcached_set(), memcached_add(), and memcached_replace() are all used to