docs: libmemcachedutil

[awesomized/libmemcached] / docs / source / libmemcachedutil.rst

diff --git a/docs/source/libmemcachedutil.rst b/docs/source/libmemcachedutil.rst
index 9c8691753fe853a563ce563c1706b8e0534ec7cd..f17cd86ba49c2f4019cfa4b189c99f0c14e5eb5b 100644 (file)
--- a/docs/source/libmemcachedutil.rst
+++ b/docs/source/libmemcachedutil.rst
@@ -1,46 +1,41 @@
-============================
-Introducing libmemcachedutil
-============================
 
+libmemcachedutil - C/C++ utilities extending libmemcached
+=========================================================
 
 Utility library for libmemcached
 
-
---------
 SYNOPSIS
 --------
 
-.. code-block:: c
-
-   cc [ flag ... ] file ... -lmemcachedutil
- 
-   #include <libmemcached/memcached_util.h>
+#include <libmemcachedutil-|libmemcached_version|/util.h>
+  Compile and link with -lmemcachedutil -lmemcached
 
-
-
------------
 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 AND PROCESSES
+---------------------
 
+Do not try to access an instance of `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`.
 
--------
-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 :c:type:`memcached_st`, or use the memcached pool
-implementation. see :c:func:`memcached_pool_create`.
-
---------
 SEE ALSO
 --------
 
+.. only:: man
+
+    :manpage:`libmemcached(3)`
+    :manpage:`memcached_pool(3)`
+    :manpage:`memcached_pool_destroy(3)`
+    :manpage:`memcached_pool_pop(3)`
+    :manpage:`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)`
+.. only:: html
 
+    * :doc:`../libmemcached`
+    * :doc:`libmemcachedutil/memcached_pool`