Merging bzr://localhost/libmemcached/994772 to Build branch
[m6w6/libmemcached] / docs / libmemcached_examples.rst
index b0374981ddde41774c57a77e26b7d0152867ca97..a43ee1a2a11f77a07cffd6614531359ab9e0d13b 100644 (file)
@@ -19,18 +19,18 @@ Connecting to servers
 ---------------------
 
 
-
 .. code-block:: c
 
-   const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"
-   memcached_st *memc= memcached(config_string, strlen(config_string);
-   {
-    ...
-   }
+  const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"
+  memcached_st *memc= memcached(config_string, strlen(config_string);
+  {
+  ...
+  }
    memcached_free(memc);
 
 
-In the above code you create a \ ``memcached_st``\  object with three server by making use of :manpage:`memcached_create_with_options(3)`.
+In the above code you create a :c:type:`memcached_st` object with three server 
+by making use of :c:func:`memcached_create`.
 
 
 --------------------------
@@ -41,6 +41,8 @@ Creating a pool of servers
 
 .. code-block:: c
 
+Creating a pool of Servers::
+
   const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"; 
   
   memcached_pool_st* pool= memcached_pool(config_string, strlen(config_string));
@@ -63,10 +65,10 @@ Creating a pool of servers
 
 
 
-In the above code you create a \ ``memcached_pool_st``\  object with three
-server by making use of :manpage:`memcached_pool(3)`.
+In the above code you create a :c:type:`memcached_pool_st` object with three
+server by making use of :c:func:`memcached_pool()`.
 
-When memcached_pool_destroy() all memory will be released that is associated
+When :c:func:`memcached_pool_destroy()` all memory will be released that is associated
 with the pool.
 
 
@@ -78,6 +80,8 @@ Adding a value to the server
 
 .. code-block:: c
 
+Adding a value to the Server::
+
    char *key= "foo";
    char *value= "value";
 
@@ -105,14 +109,14 @@ Fetching multiple values
    size_t key_length[]= {5, 3, 4};
    unsigned int x;
    uint32_t flags;
+
    char return_key[MEMCACHED_MAX_KEY];
    size_t return_key_length;
    char *return_value;
    size_t return_value_length;
+
    rc= memcached_mget(memc, keys, key_length, 3);
+
    x= 0;
    while ((return_value= memcached_fetch(memc, return_key, &return_key_length, 
                                          &return_value_length, &flags, &rc)))
@@ -123,7 +127,7 @@ Fetching multiple values
 
 
 Notice that you freed values returned from memcached_fetch(). The define
-\ ``MEMCACHED_MAX_KEY``\  is provided for usage.
+:c:type:`MEMCACHED_MAX_KEY` is provided for usage.
 
 
 
@@ -133,7 +137,7 @@ HOME
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 --------