Merge of all doc fixes.

[m6w6/libmemcached] / docs / memcached_auto.rst

diff --git a/docs/memcached_auto.rst b/docs/memcached_auto.rst
index 1f35e4e7c4d0c9b2e6bcb0ac08d0502badefef72..39b4247a6436bf08c864a226ebb751fb5402d441 100644 (file)
--- a/docs/memcached_auto.rst
+++ b/docs/memcached_auto.rst
@@ -1,95 +1,34 @@
-=========================================================
-Incrementing and Decrementing values stored in the server
-=========================================================
+====================================
+Incrementing and Decrementing Values
+====================================

 
 
 
 

-Manipulate counters

 
 

+--------
+SYNOPSIS
+--------

 
 

-*******
-LIBRARY
-*******

 
 
 
 

-C Client Library for memcached (libmemcached, -lmemcached)
+#include <libmemcached/memcached.h>
+ 
+.. c:function:: memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);

 
 

+.. c:function:: memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);

 
 

---------
-SYNOPSIS
---------
+.. c:function:: 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);

 
 

+.. c:function:: 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);

 
 

+.. c:function::  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);

 
 

-.. code-block:: perl
+.. c:function:: 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);

 
 

-   #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);
+.. c:function:: 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);

 
 

+.. c:function:: 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);
+
+Compile and link with -lmemcached

 
 
 -----------
 
 
 -----------


@@ -97,7 +36,7 @@ DESCRIPTION
 -----------
 
 
 -----------
 
 

-memcached(1) servers have the ability to increment and decrement keys
+:manpage:`memcached(1)` 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.
 
 (overflow and underflow are not detected). This gives you the ability to use
 memcached to generate shared sequences of values.
 


@@ -133,9 +72,9 @@ memcached_decrement_with_initial_by_key() are master key equivalents of the
 above.
 
 
 above.
 
 

-******
+------

 RETURN
 RETURN

-******
+------

 
 
 A value of type \ ``memcached_return_t``\  is returned.
 
 
 A value of type \ ``memcached_return_t``\  is returned.


@@ -143,23 +82,15 @@ On success that value will be \ ``MEMCACHED_SUCCESS``\ .
 Use memcached_strerror() to translate this value to a printable string.
 
 
 Use memcached_strerror() to translate this value to a printable string.
 
 

-****
+----

 HOME
 HOME

-****
+----

 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 

-******
-AUTHOR
-******
-
-
-Brian Aker, <brian@tangent.org>
-
-

 --------
 SEE ALSO
 --------
 --------
 SEE ALSO
 --------