Merge in documentation updates.

[m6w6/libmemcached] / docs / memcached_get.rst

diff --git a/docs/memcached_get.rst b/docs/memcached_get.rst
index a489af4383108236dc422347ab32b55158026908..5f62532cee133cbb1084e01d5c9832f97882e426 100644 (file)
--- a/docs/memcached_get.rst
+++ b/docs/memcached_get.rst
@@ -1,13 +1,9 @@
-.. highlight:: perl
+===============================
+Retrieving data from the server
+===============================
 
 
-****
-NAME
-****
-
-
-memcached_get, memcached_mget, memcached_fetch, memcached_mget_execute,
-memcached_mget_execute_by_key - Get a value
+Get a value
 
 
 *******
@@ -18,15 +14,15 @@ LIBRARY
 C Client Library for memcached (libmemcached, -lmemcached)
 
 
-********
+--------
 SYNOPSIS
-********
+--------
 
 
 
 .. code-block:: perl
 
-   #include <memcached.h>
+   #include <libmemcached/memcached.h>
  
    memcached_result_st *
      memcached_fetch_result (memcached_st *ptr,
@@ -96,9 +92,9 @@ SYNOPSIS
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 memcached_get() is used to fetch an individual value from the server. You
@@ -165,7 +161,7 @@ as memcached_get() and memcached_mget(). The difference is that they take
 a master key that is used for determining which server an object was stored
 if key partitioning was used for storage.
 
-All of the above functions are not supported when the \ ``MEMCACHED_BEHAVIOR_USE_UDP``\ 
+All of the above functions are not testsed when the \ ``MEMCACHED_BEHAVIOR_USE_UDP``\ 
 has been set. Executing any of these functions with this behavior on will result in
 \ ``MEMCACHED_NOT_SUPPORTED``\  being returned or, for those functions which do not return
 a \ ``memcached_return_t``\ , the error function parameter will be set to
@@ -203,10 +199,8 @@ AUTHOR
 Brian Aker, <brian@tangent.org>
 
 
-********
+--------
 SEE ALSO
-********
-
-
-memcached(1) libmemcached(3) memcached_strerror(3)
+--------
 
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`