Update to add ENV variable LIBMEMCACHED

[m6w6/libmemcached] / docs / memcached_auto.rst

diff --git a/docs/memcached_auto.rst b/docs/memcached_auto.rst
index d92f1f882583ec79de018ec8c701f4195287e422..c3f4c7f5b8343bfe44d6a8e54e0ff78709c37177 100644 (file)
--- a/docs/memcached_auto.rst
+++ b/docs/memcached_auto.rst
@@ -1,171 +1,96 @@
-.. highlight:: perl
+====================================
+Incrementing and Decrementing Values
+====================================

 
 

+.. index:: object: memcached_st

 
 

-memcached_increment, memcached_decrement, memcached_increment_with_initial, memcached_decrement_with_initial
-************************************************************************************************************
-
-
-Manipulate counters
-
-
-*******
-LIBRARY
-*******
+--------
+SYNOPSIS
+--------

 
 

+#include <libmemcached/memcached.h>
+ 
+.. c:function:: memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value)

 
 

-C Client Library for memcached (libmemcached, -lmemcached)
+.. c:function:: memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value)

 
 

+.. 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)

 
 

-********
-SYNOPSIS
-********
+.. 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 *group_key, size_t group_key_length, const char *key, size_t key_length, uint32_t offset, uint64_t *value)

 
 

+.. c:function:: 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, uint32_t offset, uint64_t *value)

 
 

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

 
 

-   #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_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)

 
 

+Compile and link with -lmemcached

 
 
 
 

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

 DESCRIPTION
 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.
 

-memcached_increment() takes a key and keylength and increments the value by
-the offset passed to it. The value is then returned via the unsigned int
+memcached_increment takes a key and keylength and increments the value by
+the offset passed to it. The value is then returned via the uint32_t

 value pointer you pass to it.
 
 value pointer you pass to it.
 

-memcached_decrement() takes a key and keylength and decrements the value by
-the offset passed to it. The value is then returned via the unsigned int
+memcached_decrement takes a key and keylength and decrements the value by
+the offset passed to it. The value is then returned via the uint32_t

 value pointer you pass to it.
 
 value pointer you pass to it.
 

-memcached_increment_with_initial() takes a key and keylength and increments
+memcached_increment_with_initial takes a key and keylength and increments

 the value by the offset passed to it. If the object specified by key does
 not exist, one of two things may happen: If the expiration value is
 MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
 expiration values, the operation will succeed by seeding the value for that
 key with a initial value to expire with the provided expiration time. The
 the value by the offset passed to it. If the object specified by key does
 not exist, one of two things may happen: If the expiration value is
 MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
 expiration values, the operation will succeed by seeding the value for that
 key with a initial value to expire with the provided expiration time. The

-flags will be set to zero.The value is then returned via the unsigned int
+flags will be set to zero.The value is then returned via the uint32_t

 value pointer you pass to it.
 
 value pointer you pass to it.
 

-memcached_decrement_with_initial() takes a key and keylength and decrements
+memcached_decrement_with_initial takes a key and keylength and decrements

 the value by the offset passed to it. If the object specified by key does
 not exist, one of two things may happen: If the expiration value is
 MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
 expiration values, the operation will succeed by seeding the value for that
 key with a initial value to expire with the provided expiration time. The
 the value by the offset passed to it. If the object specified by key does
 not exist, one of two things may happen: If the expiration value is
 MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
 expiration values, the operation will succeed by seeding the value for that
 key with a initial value to expire with the provided expiration time. The

-flags will be set to zero.The value is then returned via the unsigned int
+flags will be set to zero.The value is then returned via the uint32_t

 value pointer you pass to it.
 
 value pointer you pass to it.
 

-memcached_increment_by_key(), memcached_decrement_by_key(),
-memcached_increment_with_initial_by_key(), and
-memcached_decrement_with_initial_by_key() are master key equivalents of the
-above.
+:c:func:`memcached_increment_by_key`, :c:func:`memcached_decrement_by_key`,
+:c:func:`memcached_increment_with_initial_by_key`, and
+:c:func:`memcached_decrement_with_initial_by_key` are master key equivalents of the above.

 
 
 
 

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

 RETURN
 RETURN

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

 
 
 
 

-A value of type \ ``memcached_return_t``\  is returned.
-On success that value will be \ ``MEMCACHED_SUCCESS``\ .
-Use memcached_strerror() to translate this value to a printable string.
+A value of type :c:type:`memcached_return_t`  is returned.
+On success that value will be :c:type:`MEMCACHED_SUCCESS`.
+Use memcached_strerror to translate this value to a printable string.

 
 
 
 

-****
+----

 HOME
 HOME

-****
+----

 
 
 To find out more information please check:
 
 
 To find out more information please check:

-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_

 
 
 
 

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

 SEE ALSO
 SEE ALSO

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

 
 

-memcached(1) libmemcached(3) memcached_strerror(3)

 
 

+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`