Merge in main doc trunk.
[m6w6/libmemcached] / docs / memcached_set.rst
index d0dbbd267c652476568c4011415e366673b9c7d6..099d1559f70f2f013fd240617aea6211696bd71c 100644 (file)
@@ -1,24 +1,22 @@
-.. highlight:: perl
-
-
-memcached_set, memcached_add, memcached_replace
-***********************************************
+==========================
+Storing and Replacing Data
+==========================
 
 
 Store value on server
 
 
-*******
+-------
 LIBRARY
-*******
+-------
 
 
 C Client Library for memcached (libmemcached, -lmemcached)
 
 
-********
+--------
 SYNOPSIS
-********
+--------
 
 
 
@@ -119,16 +117,16 @@ SYNOPSIS
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 memcached_set(), memcached_add(), and memcached_replace() are all used to
 store information on the server. All methods take a key, and its length to
 store the object. Keys are currently limited to 250 characters by the
 memcached(1) server. You must also supply a value and a length. Optionally you
-may support an expiration time for the object and a 16 byte value (it is
+may tests an expiration time for the object and a 16 byte value (it is
 meant to be used as a bitmap).
 
 memcached_set() will write an object to the server. If an object already
@@ -151,7 +149,7 @@ data stored. Currently expiration and key are not used in the server.
 memcached_cas() overwrites data in the server as long as the "cas" value is 
 still the same in the server. You can get the cas value of a result by 
 calling memcached_result_cas() on a memcached_result_st(3) structure. At the point 
-that this note was written cas is still buggy in memached. Turning on support
+that this note was written cas is still buggy in memached. Turning on tests
 for it in libmemcached(3) is optional. Please see memcached_set() for 
 information on how to do this.
 
@@ -164,7 +162,7 @@ objects to particular servers.
 If you are looking for performance, memcached_set() with non-blocking IO is 
 the fastest way to store data on the server.
 
-All of the above functions are supported with the \ ``MEMCACHED_BEHAVIOR_USE_UDP``\ 
+All of the above functions are testsed with the \ ``MEMCACHED_BEHAVIOR_USE_UDP``\ 
 behavior enabled. But when using these operations with this behavior on, there 
 are limits to the size of the payload being sent to the server.  The reason for 
 these limits is that the Memcahed Server does not allow multi-datagram requests
@@ -182,9 +180,9 @@ total size of the command, including overhead, exceeds 1400 bytes, a \ ``MEMCACH
 will be returned.
 
 
-******
+------
 RETURN
-******
+------
 
 
 All methods return a value of type \ ``memcached_return_t``\ .
@@ -195,26 +193,18 @@ For memcached_replace() and memcached_add(), \ ``MEMCACHED_NOTSTORED``\  is a
 legitmate error in the case of a collision.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 
-******
-AUTHOR
-******
-
-
-Brian Aker, <brian@tangent.org>
-
-
-********
+--------
 SEE ALSO
-********
+--------
 
 
 memcached(1) libmemached(3) memcached_strerror(3)