Merge doc update.
[m6w6/libmemcached] / docs / libmemcachedutil.rst
index d213876dc27c541b132bc59d22ba4159ef64fc56..692aa2ef444bda18ff2d6f4b7c4439f77a674b2f 100644 (file)
@@ -1,29 +1,16 @@
-.. highlight:: perl
+===========
+Introducing
+===========
 
 
-****
-NAME
-****
+Utility library for libmemcached
 
 
-libmemcachedutil - Utility library for libmemcached
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library containing utility functions for libmemcached (libmemcachedutil, -lmemcachedutil)
-
-
-********
+--------
 SYNOPSIS
-********
+--------
 
-
-
-.. code-block:: perl
+.. code-block:: c
 
    cc [ flag ... ] file ... -lmemcachedutil
  
@@ -31,47 +18,39 @@ SYNOPSIS
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
-\ **libmemcachedutil**\  is a small and thread-safe client library that provides
-extra functionality built on top of \ **libmemcached**\ .
+:program:`libmemcachedutil`  is a small and thread-safe client library that 
+provides extra functionality built on top of :program:`libmemcached`.
 
 
-*******
+-------
 THREADS
-*******
+-------
 
 
-Do not try to access an instance of \ ``memcached_st``\  from multiple threads
+Do not try to access an instance of :c:type:`memcached_st` from multiple threads
 at the same time. If you want to access memcached from multiple threads
-you should either clone the \ ``memcached_st``\ , or use the memcached pool
-implementation. see memcached_pool_create(3).
+you should either clone the :c:type:`memcached_st`, or use the memcached pool
+implementation. see :c:func:`memcached_pool_create`.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-
-
-******
-AUTHOR
-******
-
-
-Trond Norbye, <trond.norbye@gmail.com>
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-********
+--------
 SEE ALSO
-********
+--------
 
 
-libmemcached(3) memcached_pool_create(3) memcached_pool_destroy(3) memcached_pool_pop(3) memcached_pool_push(3)
+:manpage:`libmemcached(3)` :manpage:`memcached_pool_create(3)` :manpage:`memcached_pool_destroy(3)` :manpage:`memcached_pool_pop(3)` :manpage:`memcached_pool_push(3)`