X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcachedutil.rst;h=369600ce7b3b130ddbbc9fc0d9c2a04a9fc4088c;hb=e1833e25ab4a98f9a3f9f9268185af57b2280eaf;hp=692aa2ef444bda18ff2d6f4b7c4439f77a674b2f;hpb=f2a59b728c20f7fe78874dd41187ab3fb2db6c7e;p=awesomized%2Flibmemcached diff --git a/docs/source/libmemcachedutil.rst b/docs/source/libmemcachedutil.rst index 692aa2ef..369600ce 100644 --- a/docs/source/libmemcachedutil.rst +++ b/docs/source/libmemcachedutil.rst @@ -1,56 +1,41 @@ -=========== -Introducing -=========== +libmemcachedutil - C/C++ utilities extending libmemcached +========================================================= Utility library for libmemcached - --------- SYNOPSIS -------- -.. code-block:: c - - cc [ flag ... ] file ... -lmemcachedutil - - #include - - +#include + Compile and link with -lmemcachedutil ------------ 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 :c:type:`memcached_st` from multiple threads +Do not try to access an instance of :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`. - - ----- -HOME ----- - +you should either clone the :type:`memcached_st`, or use the memcached pool +implementation. See :func:`memcached_pool_create`. -To find out more information please check: -`http://libmemcached.org/ `_ - - --------- 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`