Merge of trunk

[awesomized/libmemcached] / docs / man / memcached_auto.3

diff --git a/docs/man/memcached_auto.3 b/docs/man/memcached_auto.3
index 9228ccd2a8a8fe8b089c146c63fdbb2badc36a05..bb07567d7bf850ddcecc3494e96f344f3b3d4bcf 100644 (file)
--- a/docs/man/memcached_auto.3
+++ b/docs/man/memcached_auto.3
@@ -1,6 +1,6 @@
-.TH "MEMCACHED_AUTO" "3" "April 09, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_AUTO" "3" "September 18, 2011" "0.52" "libmemcached"

 .SH NAME
 .SH NAME

-memcached_auto \- libmemcached Documentation
+memcached_auto \- Incrementing and Decrementing Values

 .
 .nr rst2man-indent-level 0
 .
 .
 .nr rst2man-indent-level 0
 .


@@ -30,87 +30,46 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 ..
 .\" Man page generated from reStructeredText.
 .
 ..
 .\" Man page generated from reStructeredText.
 .

+.SH SYNOPSIS

 .sp
 .sp

-Manipulate counters
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)
-.SS SYNOPSIS
-.sp
-.nf
-.ft C

 #include <libmemcached/memcached.h>
 #include <libmemcached/memcached.h>

-
-memcached_return_t
-  memcached_increment (memcached_st *ptr,
-                       const char *key, size_t key_length,
-                       unsigned int offset,
-                       uint64_t *value);
-
-memcached_return_t
-  memcached_decrement (memcached_st *ptr,
-                       const char *key, size_t key_length,
-                       unsigned int offset,
-                       uint64_t *value);
-
-memcached_return_t
-  memcached_increment_with_initial (memcached_st *ptr,
-                                    const char *key,
-                                    size_t key_length,
-                                    uint64_t offset,
-                                    uint64_t initial,
-                                    time_t expiration,
-                                    uint64_t *value);
-
-memcached_return_t
-  memcached_decrement_with_initial (memcached_st *ptr,
-                                    const char *key,
-                                    size_t key_length,
-                                    uint64_t offset,
-                                    uint64_t initial,
-                                    time_t expiration,
-                                    uint64_t *value);
-
-memcached_return_t
-  memcached_increment_by_key (memcached_st *ptr,
-                              const char *master_key, size_t master_key_length,
-                              const char *key, size_t key_length,
-                              unsigned int offset,
-                              uint64_t *value);
-
-memcached_return_t
-  memcached_decrement_by_key (memcached_st *ptr,
-                              const char *master_key, size_t master_key_length,
-                              const char *key, size_t key_length,
-                              unsigned int offset,
-                              uint64_t *value);
-
-memcached_return_t
-  memcached_increment_with_initial_by_key (memcached_st *ptr,
-                                           const char *master_key,
-                                           size_t master_key_length,
-                                           const char *key,
-                                           size_t key_length,
-                                           uint64_t offset,
-                                           uint64_t initial,
-                                           time_t expiration,
-                                           uint64_t *value);
-
-memcached_return_t
-  memcached_decrement_with_initial_by_key (memcached_st *ptr,
-                                           const char *master_key,
-                                           size_t master_key_length,
-                                           const char *key,
-                                           size_t key_length,
-                                           uint64_t offset,
-                                           uint64_t initial,
-                                           time_t expiration,
-                                           uint64_t *value);
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_increment_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_decrement_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_increment_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_decrement_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_increment_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_decrement_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.UNINDENT
+.sp
+Compile and link with \-lmemcached
+.SH DESCRIPTION

 .sp
 .sp

-memcached(1) servers have the ability to increment and decrement keys
+\fImemcached(1)\fP servers have the ability to increment and decrement keys

 (overflow and underflow are not detected). This gives you the ability to use
 memcached to generate shared sequences of values.
 .sp
 (overflow and underflow are not detected). This gives you the ability to use
 memcached to generate shared sequences of values.
 .sp


@@ -152,11 +111,8 @@ Use memcached_strerror() to translate this value to a printable string.
 .SH HOME
 .sp
 To find out more information please check:
 .SH HOME
 .sp
 To find out more information please check:

-\fI\%https://launchpad.net/libmemcached\fP
-.SH AUTHOR
-.sp
-Brian Aker, <\fI\%brian@tangent.org\fP>
-.SS SEE ALSO
+\fI\%http://libmemcached.org/\fP
+.SH SEE ALSO

 .sp
 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
 .SH AUTHOR
 .sp
 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
 .SH AUTHOR