docs: sanitize

diff --git a/docs/source/bin/memaslap.rst b/docs/source/bin/memaslap.rst
index eae05d813da08f0384d52b599b02f4eb887ac3ec..f323e524d5386b91822e4d1545399402a69359db 100644 (file)
--- a/docs/source/bin/memaslap.rst
+++ b/docs/source/bin/memaslap.rst
@@ -1229,4 +1229,6 @@ memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+.. only:: man
+
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)`

diff --git a/docs/source/bin/memcapable.rst b/docs/source/bin/memcapable.rst
index f5d18c28c3e520258454aa1a58d8771880a10dc7..da1a2e6c9c87a89ced7663daf7591b8671f534b6 100644 (file)
--- a/docs/source/bin/memcapable.rst
+++ b/docs/source/bin/memcapable.rst
@@ -56,5 +56,7 @@ Set the timeout from an IO operation to/from the server to \ *n*\  seconds.
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+.. only:: man
+
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
 

diff --git a/docs/source/bin/memcat.rst b/docs/source/bin/memcat.rst
index 3345a0b6abe5aa0851f4eadb513a010cc0151131..00773ee0629beab22f5ed516bda16e1945cf5b5f 100644 (file)
--- a/docs/source/bin/memcat.rst
+++ b/docs/source/bin/memcat.rst
@@ -49,6 +49,7 @@ For a full list of operations run the tool with the option:
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
 

diff --git a/docs/source/bin/memcp.rst b/docs/source/bin/memcp.rst
index d9547d918700b3c6d235b000558036beee1f7286..a60008be9a6b48b668cebdd9d4e36a57cc948cd5 100644 (file)
--- a/docs/source/bin/memcp.rst
+++ b/docs/source/bin/memcp.rst
@@ -52,6 +52,7 @@ For a full list of operations run the tool with the option:
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
 

diff --git a/docs/source/bin/memdump.rst b/docs/source/bin/memdump.rst
index 7ea39bcd76bcaf9804a4d3395c152c39a2bca729..8510605acbb165bd1781ece952156c2cecd26e36 100644 (file)
--- a/docs/source/bin/memdump.rst
+++ b/docs/source/bin/memdump.rst
@@ -39,4 +39,6 @@ For a full list of operations run the tool with option:
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+.. only:: man
+
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)`

diff --git a/docs/source/bin/memerror.rst b/docs/source/bin/memerror.rst
index b92699feae8ed8b2fd1bdb934cd5b8ae1057da12..2a630060dce0d41fdcbe757813b3f60b2847c710 100644 (file)
--- a/docs/source/bin/memerror.rst
+++ b/docs/source/bin/memerror.rst
@@ -38,5 +38,6 @@ For a full list of operations run the tool with option:
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)`

diff --git a/docs/source/bin/memexist.rst b/docs/source/bin/memexist.rst
index b407d90c1cee3098ecde499aaddb01796443ff4d..fd23a80b3c62f343fcb816e0aa3d4f0793374f66 100644 (file)
--- a/docs/source/bin/memexist.rst
+++ b/docs/source/bin/memexist.rst
@@ -43,6 +43,7 @@ For a full list of operations run the tool with the option:
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
 

diff --git a/docs/source/bin/memflush.rst b/docs/source/bin/memflush.rst
index 9caa422e10a340336067b421e1fe914038b2a681..06a5d4d7d500d86a61a3412769d67db1701fab66 100644 (file)
--- a/docs/source/bin/memflush.rst
+++ b/docs/source/bin/memflush.rst
@@ -46,4 +46,6 @@ For a full list of operations run the tool with option:
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+.. only:: man
+
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)`

diff --git a/docs/source/bin/memparse.rst b/docs/source/bin/memparse.rst
index eb535ecffe0edb8b131dbaff07ec5106fac2adf1..926a97b5ad334467a11be13475fa96df499a85c1 100644 (file)
--- a/docs/source/bin/memparse.rst
+++ b/docs/source/bin/memparse.rst
@@ -36,6 +36,7 @@ For a full list of operations run the tool with the option:
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
 

diff --git a/docs/source/bin/memping.rst b/docs/source/bin/memping.rst
index f3c8dce47f17bac310fb653947f47285b0c89fcb..5fdfef70c3f32a13d247ce31eec54e80f2b15733 100644 (file)
--- a/docs/source/bin/memping.rst
+++ b/docs/source/bin/memping.rst
@@ -43,4 +43,6 @@ For a full list of operations run the tool with the option:
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+.. only:: man
+
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)`

diff --git a/docs/source/bin/memrm.rst b/docs/source/bin/memrm.rst
index 1211043dca465da48e7a7dca55fd7253f6f4c734..783961b462eb322ce6f0a489a153142e8fc1417b 100644 (file)
--- a/docs/source/bin/memrm.rst
+++ b/docs/source/bin/memrm.rst
@@ -47,6 +47,7 @@ For a full list of operations run the tool with the
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
 

diff --git a/docs/source/bin/memslap.rst b/docs/source/bin/memslap.rst
index 8abd7fe0c08a79bb2832dedeb447819543aca5b9..80ac2526d38bfee920b66524485231b1f04c7025 100644 (file)
--- a/docs/source/bin/memslap.rst
+++ b/docs/source/bin/memslap.rst
@@ -43,5 +43,6 @@ For a full list of operations run the tool with:
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)`

diff --git a/docs/source/bin/memstat.rst b/docs/source/bin/memstat.rst
index a958d9022a269265449b29fcf07f333ea56a5223..e3193de91c8fd34050177d99ab05469906e2c5be 100644 (file)
--- a/docs/source/bin/memstat.rst
+++ b/docs/source/bin/memstat.rst
@@ -49,6 +49,7 @@ For a full list of operations run the tool with:
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
 

diff --git a/docs/source/bin/memtouch.rst b/docs/source/bin/memtouch.rst
index 44b4c0857ea55b765bb01da5684382368ea9c95f..50e924157b69201aea4c6c2a8e7bab74ce50a652 100644 (file)
--- a/docs/source/bin/memtouch.rst
+++ b/docs/source/bin/memtouch.rst
@@ -44,6 +44,7 @@ For a full list of operations run the tool with the option:
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
 

diff --git a/docs/source/conf.py.in b/docs/source/conf.py.in
index d0ebde0f68087aab057de2774b1d830574c0cee8..ad18ec838aac3ee8e7d38489af0fd3d3009d67bf 100644 (file)
--- a/docs/source/conf.py.in
+++ b/docs/source/conf.py.in
@@ -44,6 +44,13 @@ man_pages = [
   ('hashkit_create'                             , 'hashkit_create'                         , u'libhashkit Documentation'                            , man_authors, 3),
   ('hashkit_create'                             , 'hashkit_free'                           , u'libhashkit Documentation'                            , man_authors, 3),
   ('hashkit_create'                             , 'hashkit_is_allocated'                   , u'libhashkit Documentation'                            , man_authors, 3),
+  ('hashkit_function'                           , 'hashkit_function'                       , u'libhashkit Documentation'                            , man_authors, 3),
+  ('hashkit_function'                           , 'hashkit_get_distribution_function'      , u'libhashkit Documentation'                            , man_authors, 3),
+  ('hashkit_function'                           , 'hashkit_get_function'                   , u'libhashkit Documentation'                            , man_authors, 3),
+  ('hashkit_function'                           , 'hashkit_set_function'                   , u'libhashkit Documentation'                            , man_authors, 3),
+  ('hashkit_function'                           , 'hashkit_set_custom_distribution_function',u'libhashkit Documentation'                            , man_authors, 3),
+  ('hashkit_function'                           , 'hashkit_set_custom_function'            , u'libhashkit Documentation'                            , man_authors, 3),
+  ('hashkit_function'                           , 'hashkit_set_distribution_function'      , u'libhashkit Documentation'                            , man_authors, 3),
   ('hashkit_functions'                          , 'hashkit_crc32'                          , u'libhashkit Documentation'                            , man_authors, 3),
   ('hashkit_functions'                          , 'hashkit_fnv1_32'                        , u'libhashkit Documentation'                            , man_authors, 3),
   ('hashkit_functions'                          , 'hashkit_fnv1_64'                        , u'libhashkit Documentation'                            , man_authors, 3),
@@ -183,4 +190,9 @@ man_pages = [
   ('bin/memtouch'                               , 'memtouch'                               , u'libmemcached Documentation'                          , man_authors, 1),
   ]
 
+rst_prolog = """
+.. |libhashkit_version| replace:: @LIBHASHKIT_VERSION_MAJOR@.@LIBHASHKIT_VERSION_MINOR@
+.. |libmemcached_version| replace:: @LIBMEMCACHED_VERSION_MAJOR@.@LIBMEMCACHED_VERSION_MINOR@
+"""
+
 @SPHINX_CONF_APPEND@

diff --git a/docs/source/hashkit_create.rst b/docs/source/hashkit_create.rst
index 5473ba119200686c6441ceac1f1166d7d0c63a92..47371ecadf02aca36630f415b7e465e0e67a504f 100644 (file)
--- a/docs/source/hashkit_create.rst
+++ b/docs/source/hashkit_create.rst
@@ -1,18 +1,19 @@
-============================
 Creating a hashkit structure
 ============================
 
-.. highlightlang:: c
-
 .. index:: object: hashkit_st
 
---------
+Create, copy and free a hashkit structure
+
 SYNOPSIS
 --------
 
-.. describe:: #include <libhashkit/hashkit.h>
- 
-.. c:type:: hashkit_st
+#include <libhashkit-|libhashkit_version|/hashkit.h>
+  Compile and link with -lhashkit
+
+.. c:type:: struct hashkit_st
+
+   typedef struct hashkit_st hashkit_st;
 
 .. c:function:: hashkit_st *hashkit_create(hashkit_st *hash)
 
@@ -22,13 +23,9 @@ SYNOPSIS
 
 .. c:function:: bool hashkit_is_allocated(const hashkit_st *hash)
 
-Compile and link with -lhashkit
-
------------
 DESCRIPTION
 -----------
 
-
 The :c:func:`hashkit_create` function initializes a hashkit object for use. If
 you pass a NULL argument for hash, then the memory for the object is
 allocated. If you specify a pre-allocated piece of memory, that is
@@ -44,12 +41,9 @@ objects that were initialized with :c:func:`hashkit_create` or :c:func:`hashkit_
 The :c:func:`hashkit_is_allocated` reports where the memory was allocated 
 for a hashkit object.
 
-
-------------
 RETURN VALUE
 ------------
 
-
 :c:func:`hashkit_create` and :c:func:`hashkit_clone` will return NULL on 
 failure or non-NULL on success.
 
@@ -57,12 +51,17 @@ failure or non-NULL on success.
 object was allocated inside of :c:func:`hashkit_create` or 
 :c:func:`hashkit_clone`, otherwise it is false and was user-supplied memory.
 
-
-
---------
 SEE ALSO
 --------
 
+.. only:: man
+
+    :manpage:`libhashkit(3)`
+    :manpage:`hashkit_value(3)`
+    :manpage:`hashkit_function3)`
 
-:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)`
+.. only:: html
 
+    * :doc:`libhashkit`
+    * :doc:`hashkit_value`
+    * :doc:`hashkit_function`

diff --git a/docs/source/hashkit_function.rst b/docs/source/hashkit_function.rst
new file mode 100644 (file)
index 0000000..b32c77a
--- /dev/null
+++ b/docs/source/hashkit_function.rst
@@ -0,0 +1,62 @@
+Set Hash Function
+=================
+
+.. index:: object: hashkit_st
+.. index:: object: hashkit_hash_fn
+
+Set hash functions to use for calculating values for keys
+
+SYNOPSIS
+--------
+
+#include <libhashkit-|libhashkit_version|/hashkit.h>
+  Compile and link with -lhashkit
+
+.. c:type:: hashkit_hash_fn
+
+.. code-block:: c
+
+  typedef uint32_t (*hashkit_hash_fn)(const char *key, size_t key_length, void *context);
+
+.. c:function:: hashkit_return_t hashkit_set_function(hashkit_st *hash, hashkit_hash_algorithm_t hash_algorithm)
+
+.. c:function:: hashkit_return_t hashkit_set_custom_function(hashkit_st *hash, hashkit_hash_fn function, void *context)
+
+.. c:function:: hashkit_hash_algorithm_t hashkit_get_function(const hashkit_st *hash)
+
+.. c:function:: hashkit_return_t hashkit_set_distribution_function(hashkit_st *hash, hashkit_hash_algorithm_t hash_algorithm)
+
+.. c:function:: hashkit_return_t hashkit_set_custom_distribution_function(hashkit_st *self, hashkit_hash_fn function, void *context)
+
+.. c:function:: hashkit_hash_algorithm_t hashkit_get_distribution_function(const hashkit_st *self)
+
+DESCRIPTION
+-----------
+
+These functions are used to set and retrieve the key and distribution hash functions.
+
+
+RETURN VALUE
+------------
+
+:c:func:`hashkit_set_function`, :c:func:`hashkit_set_custom_function` and the distribution equivalents
+return :c:type:`hashkit_return_t` `HASHKIT_SUCCESS` on success.
+
+:c:func:`hashkit_get_function` and :c:func:`hashkit_get_distribution_function` return :c:type:`hashkit_hash_algorithm_t`
+indicating the hash function used.
+
+SEE ALSO
+--------
+
+.. only:: man
+
+    :manpage:`libhashkit(3)`
+    :manpage:`hashkit_create(3)`
+    :manpage:`hashkit_functions(3)`
+
+.. only:: html
+
+    * :doc:`libhashkit`
+    * :doc:`hashkit_create`
+    * :doc:`hashkit_functions`
+

diff --git a/docs/source/hashkit_functions.rst b/docs/source/hashkit_functions.rst
index 0c9e2cc17c0129a28e94a941d4b24ae13af1bc44..d6225d4edcb8a06783610205c49450abcf084441 100644 (file)
--- a/docs/source/hashkit_functions.rst
+++ b/docs/source/hashkit_functions.rst
@@ -1,4 +1,3 @@
-================
 Available Hashes
 ================
 
@@ -6,13 +5,12 @@ Available Hashes
 
 Various hash functions to use for calculating values for keys
 
-
---------
 SYNOPSIS
 --------
 
-#include <libhashkit/hashkit.h>
- 
+#include <libhashkit-|libhashkit_version|/hashkit.h>
+  Compile and link with -lhashkit
+
 .. c:function:: uint32_t hashkit_default(const char *key, size_t key_length)
 
 .. c:function:: uint32_t hashkit_fnv1_64(const char *key, size_t key_length)
@@ -29,39 +27,39 @@ SYNOPSIS
 
 .. c:function:: uint32_t hashkit_murmur(const char *key, size_t key_length)
 
+.. c:function:: uint32_t hashkit_murmur3(const char *key, size_t key_length)
+
 .. c:function:: uint32_t hashkit_jenkins(const char *key, size_t key_length)
 
 .. c:function:: uint32_t hashkit_md5(const char *key, size_t key_length)
 
-Compile and link with -lhashkit
-
-
------------
 DESCRIPTION
 -----------
 
-
 These functions generate hash values from a key using a variety of
 algorithms. These functions can be used standalone, or as arguments
-to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
+to :c:func:`hashkit_set_hash_fn` or :c:func:`hashkit_set_continuum_hash_fn`.
 
-The hashkit_hsieh is only available if the library is built with
+The :c:func:`hashkit_hsieh` is only available if the library is built with
 the appropriate flag enabled.
 
-
-------------
 RETURN VALUE
 ------------
 
-
 A 32-bit hash value.
 
-
-
---------
 SEE ALSO
 --------
 
+.. only:: man
+
+    :manpage:`libhashkit(3)`
+    :manpage:`hashkit_create(3)`
+    :manpage:`hashkit_function(3)`
+
+.. only:: html
 
-:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)` :manpage:`hashkit_set_continuum_hash_fn(3)`
+    * :doc:`libhashkit`
+    * :doc:`hashkit_create`
+    * :doc:`hashkit_function`
 

diff --git a/docs/source/hashkit_value.rst b/docs/source/hashkit_value.rst
index cae79ace26a87a464ae2c85ef9bd3cc0166eceb7..a70e89634cf2e0796a2bd50823154367e5fa13ac 100644 (file)
--- a/docs/source/hashkit_value.rst
+++ b/docs/source/hashkit_value.rst
@@ -1,46 +1,45 @@
-=============
-hashkit_value
-=============
-
+Generate hash value
+===================
 
 .. index:: object: hashkit_st
 
 Generate a value for the given key
 
---------
 SYNOPSIS
 --------
 
-
-#include <libhashkit/hashkit.h>
+#include <libhashkit-|libhashkit_version|/hashkit.h>
+  Compile and link with -lhashkit
 
 .. c:function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length)
- 
-Compile and link with -lhashkit
 
------------
 DESCRIPTION
 -----------
 
-
 The :c:func:`hashkit_value` function generates a 32-bit hash value from the
 given key and key_length. The hash argument is an initialized hashkit
 object, and distribution type and hash function is used from this
 object while generating the value.
 
-
-------------
 RETURN VALUE
 ------------
 
-
 A 32-bit hash value.
 
-
---------
 SEE ALSO
 --------
 
+.. only:: man
+
+    :manpage:`libhashkit(3)`
+    :manpage:`hashkit_create(3)`
+    :manpage:`hashkit_function(3)`
+    :manpage:`hashkit_functions(3)`
+
+.. only:: html
 
-:manpage:`hashkit_create(3)` :manpage:`hashkit_set_distribution(3)` :manpage:`hashkit_set_hash_fn(3)`
+    * :doc:`libhashkit`
+    * :doc:`hashkit_create`
+    * :doc:`hashkit_function`
+    * :doc:`hashkit_functions`
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 3a4e1c615b20d62ea3f8954519ae10a66748c457..d52d601c55fe9bce1261e9a74cf5a90c38dd93a3 100644 (file)
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -113,6 +113,7 @@ Libmemcached
 
    libhashkit
    hashkit_create
+   hashkit_function
    hashkit_functions
    hashkit_value
 

diff --git a/docs/source/libhashkit.rst b/docs/source/libhashkit.rst
index 5e6e28a5ba84fc70e27532d5c7af6957aa6d64b2..755f7b9a6d0644b12bab32c738eca4221b176108 100644 (file)
--- a/docs/source/libhashkit.rst
+++ b/docs/source/libhashkit.rst
@@ -1,28 +1,35 @@
-======================
 Introducing libhashkit
 ======================
 
+SYNOPSIS
+--------
 
-.. code-block:: c
-
-   cc [ flag ... ] file ... -lhashkit
- 
-   #include <libhashkit/hashkit.h>
-
-
+#include <libhashkit-|libhashkit_version|/hashkit.h>
+  Compile and link with -lhashkit.
 
------------
 DESCRIPTION
 -----------
 
+libhashkit is a small and thread-safe client library that provides a collection of useful hashing algorithm.
 
-libhashkit  is a small and thread-safe client library that provides a collection of useful hashing algorithm. libhashkit is distributed with libmemcached.
+libhashkit is distributed with libmemcached.
 
-
-
---------
 SEE ALSO
 --------
 
-:manpage:`libhashkit(3)`
+.. only:: man
+
+    :manpage:`libmemcached(3)`
+    :manpage:`hashkit_create(3)`
+    :manpage:`hashkit_function(3)`
+    :manpage:`hashkit_functions(3)`
+    :manpage:`hashkit_value(3)`
+
+.. only:: html
+
+    * :doc:`libmemcached`
+    * :doc:`hashkit_create`
+    * :doc:`hashkit_function`
+    * :doc:`hashkit_functions`
+    * :doc:`hashkit_value`
 

diff --git a/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst b/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst
index 4e79f43f21efdabc05fdee0690d682b1d5bde2ef..aa184e784075435025abecb69e3d9640ee45c650 100644 (file)
--- a/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst
+++ b/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst
@@ -39,4 +39,6 @@ translate this value to a printable string.
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+.. only:: man
+
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/libmemcached-1.0/memcached_touch.rst b/docs/source/libmemcached-1.0/memcached_touch.rst
index 6c1b931b6055628e184cada12c14d088eb7bd855..70a71be32b4831f7a647f834f0af9c53643022f9 100644 (file)
--- a/docs/source/libmemcached-1.0/memcached_touch.rst
+++ b/docs/source/libmemcached-1.0/memcached_touch.rst
@@ -43,5 +43,7 @@ string.
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+.. only:: man
+
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
 

diff --git a/docs/source/libmemcached.rst b/docs/source/libmemcached.rst
index 4de8d57975b11dbdb647fef1d6eb39e6a006b4b0..c78aa95ee03f8dc40fbcb23739a6922c317656b5 100644 (file)
--- a/docs/source/libmemcached.rst
+++ b/docs/source/libmemcached.rst
@@ -7,12 +7,12 @@ SYNOPSIS
 --------
 
 #include <libmemcached/memcached.h>
-
-Compile and link with -lmemcached
+  Compile and link with -lmemcached
 
 =======
 
-libMemcached is an open source C/C++ client library and tools for the memcached server (http://memcached.org/). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods.
+libMemcached is an open source C/C++ client library and tools for the memcached server (http://memcached.org/).
+It has been designed to be light on memory usage, thread safe, and provide full access to server side methods.
 
 libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided:
 
@@ -53,7 +53,8 @@ Nearly all functions return a :c:type:`memcached_return_t` value.
 This value can be translated to a printable string with 
 :c:type:`memcached_strerror`.
 
-Objects are stored on servers by hashing keys. The hash value maps the key to a particular server. All clients understand how this hashing works, so it is possibly to reliably both push data to a server and retrieve data from a server.
+Objects are stored on servers by hashing keys. The hash value maps the key to a particular server.
+All clients understand how this hashing works, so it is possibly to reliably both push data to a server and retrieve data from a server.
 
 Group keys can be optionally used to group sets of objects with servers. 
 
@@ -73,8 +74,6 @@ AC_SUBST(DEPS_LIBS)
 
 Some features of the library must be enabled through :c:func:`memcached_behavior_set`.
 
-Hope you enjoy it!
-
 
 ---------
 CONSTANTS
@@ -142,36 +141,110 @@ you can call :c:func:`memcached_quit` on a :c:type:`memcached_st` and then use t
 SEE ALSO
 --------
 
-
-:manpage:`memcached(1)` :manpage:`libmemcached_examples(3)`
-:manpage:`libmemcached(1)` :manpage:`memcat(1)` :manpage:`memcp(1)`
-:manpage:`memflush(1)` :manpage:`memrm(1)` :manpage:`memslap(1)`
-:manpage:`memstat(1)` :manpage:`memcached_fetch(3)`
-:manpage:`memcached_replace(3)` :manpage:`memcached_server_list_free(3)`
-:manpage:`libmemcached_examples(3)` :manpage:`memcached_clone(3)`
-:manpage:`memcached_free(3)` :manpage:`memcached_server_add(3)`
-:manpage:`memcached_server_push(3)` :manpage:`memcached_add(3)`
-:manpage:`memcached_get(3)` :manpage:`memcached_server_count(3)`
-:manpage:`memcached_create(3)` :manpage:`memcached_increment(3)`
-:manpage:`memcached_server_list(3)` :manpage:`memcached_set(3)`
-:manpage:`memcached_decrement(3)` :manpage:`memcached_mget(3)`
-:manpage:`memcached_server_list_append(3)` :manpage:`memcached_strerror(3)`
-:manpage:`memcached_delete(3)` :manpage:`memcached_quit(3)`
-:manpage:`memcached_server_list_count(3)` :manpage:`memcached_verbosity(3)`
-:manpage:`memcached_server_add_unix_socket(3)`
-:manpage:`memcached_result_create(3)`  :manpage:`memcached_result_free(3)`
-:manpage:`memcached_result_key_value(3)`
-:manpage:`memcached_result_key_length(3)`
-:manpage:`memcached_result_value(3)`  :manpage:`memcached_result_length(3)`
-:manpage:`memcached_result_flags(3)`  :manpage:`memcached_result_cas(3)`
-:manpage:`memcached_result_st(3)` :manpage:`memcached_append(3)`
-:manpage:`memcached_prepend(3)` :manpage:`memcached_fetch_result(3)`
-:manpage:`memerror(1)` :manpage:`memcached_get_by_key(3)`
-:manpage:`memcached_mget_by_key(3)` :manpage:`memcached_delete_by_key(3)`
-:manpage:`memcached_fetch_execute(3)` :manpage:`memcached_callback_get(3)`
-:manpage:`memcached_callback_set(3)` :manpage:`memcached_version(3)`
-:manpage:`memcached_lib_version(3)` :manpage:`memcached_result_set_value(3)`
-:manpage:`memcached_dump(3)` :manpage:`memdump(1)`
-:manpage:`memcached_set_memory_allocators(3)`
-:manpage:`memcached_get_memory_allocators(3)`
-:manpage:`memcached_get_user_data(3)` :manpage:`memcached_set_user_data(3)`
+.. only:: man
+
+    :manpage:`memcached(1)`
+    :manpage:`memaslap(1)`
+    :manpage:`memcapable(1)`
+    :manpage:`memcat(1)`
+    :manpage:`memcp(1)`
+    :manpage:`memdump(1)`
+    :manpage:`memerror(1)`
+    :manpage:`memexist(1)`
+    :manpage:`memflush(1)`
+    :manpage:`memparse(1)`
+    :manpage:`memping(1)`
+    :manpage:`memrm(1)`
+    :manpage:`memslap(1)`
+    :manpage:`memstat(1)`
+    :manpage:`memtouch(1)`
+    :manpage:`libhashkit(3)`
+    :manpage:`libmemcached_configuration(3)`
+    :manpage:`libmemcached_examples(3)`
+    :manpage:`libmemcachedutil(3)`
+    :manpage:`memcached_analyze(3)`
+    :manpage:`memcached_append(3)`
+    :manpage:`memcached_auto(3)`
+    :manpage:`memcached_behavior(3)`
+    :manpage:`memcached_callback(3)`
+    :manpage:`memcached_cas(3)`
+    :manpage:`memcached_create(3)`
+    :manpage:`memcached_delete(3)`
+    :manpage:`memcached_dump(3)`
+    :manpage:`memcached_exist(3)`
+    :manpage:`memcached_fetch(3)`
+    :manpage:`memcached_flush(3)`
+    :manpage:`memcached_flush_buffers(3)`
+    :manpage:`memcached_generate_hash_value(3)`
+    :manpage:`memcached_get(3)`
+    :manpage:`memcached_last_error_message(3)`
+    :manpage:`memcached_memory_allocators(3)`
+    :manpage:`memcached_pool(3)`
+    :manpage:`memcached_quit(3)`
+    :manpage:`memcached_result_st(3)`
+    :manpage:`memcached_return_t(3)`
+    :manpage:`memcached_sasl(3)`
+    :manpage:`memcached_servers(3)`
+    :manpage:`memcached_server_st(3)`
+    :manpage:`memcached_set(3)`
+    :manpage:`memcached_set_encoding_key(3)`
+    :manpage:`memcached_stats(3)`
+    :manpage:`memcached_strerror(3)`
+    :manpage:`memcached_touch(3)`
+    :manpage:`memcached_user_data(3)`
+    :manpage:`memcached_verbosity(3)`
+    :manpage:`memcached_version(3)`
+
+.. only:: html
+
+    * :manpage:`memcached(1)`
+    * :doc:`bin/memaslap`
+    * :doc:`bin/memcapable`
+    * :doc:`bin/memcat`
+    * :doc:`bin/memcp`
+    * :doc:`bin/memdump`
+    * :doc:`bin/memerror`
+    * :doc:`bin/memexist`
+    * :doc:`bin/memflush`
+    * :doc:`bin/memparse`
+    * :doc:`bin/memping`
+    * :doc:`bin/memrm`
+    * :doc:`bin/memslap`
+    * :doc:`bin/memstat`
+    * :doc:`bin/memtouch`
+    * :doc:`libhashkit`
+    * :doc:`libmemcached_configuration`
+    * :doc:`libmemcached_examples`
+    * :doc:`libmemcachedutil`
+    * :doc:`memcached_analyze`
+    * :doc:`memcached_append`
+    * :doc:`memcached_auto`
+    * :doc:`memcached_behavior`
+    * :doc:`memcached_callback`
+    * :doc:`memcached_cas`
+    * :doc:`memcached_create`
+    * :doc:`memcached_delete`
+    * :doc:`memcached_dump`
+    * :doc:`libmemcached/memcached_exist`
+    * :doc:`libmemcached/memcached_fetch`
+    * :doc:`memcached_flush`
+    * :doc:`memcached_flush_buffers`
+    * :doc:`memcached_generate_hash_value`
+    * :doc:`memcached_get`
+    * :doc:`libmemcached/memcached_last_error_message`
+    * :doc:`memcached_memory_allocators`
+    * :doc:`memcached_pool`
+    * :doc:`memcached_quit`
+    * :doc:`memcached_result_st`
+    * :doc:`libmemcached/memcached_return_t`
+    * :doc:`memcached_sasl`
+    * :doc:`memcached_servers`
+    * :doc:`memcached_server_st`
+    * :doc:`memcached_set`
+    * :doc:`libmemcached-1.0/memcached_set_encoding_key`
+    * :doc:`memcached_stats`
+    * :doc:`memcached_strerror`
+    * :doc:`libmemcached-1.0/memcached_touch`
+    * :doc:`memcached_user_data`
+    * :doc:`memcached_verbosity`
+    * :doc:`memcached_version`

diff --git a/docs/source/libmemcached/memcached_exist.rst b/docs/source/libmemcached/memcached_exist.rst
index 4bcd6934e4f702ba3b1ca101f4d89dd4a617c80a..3e4a8e77484aac2ff02d7d80552280f02c705d7a 100644 (file)
--- a/docs/source/libmemcached/memcached_exist.rst
+++ b/docs/source/libmemcached/memcached_exist.rst
@@ -41,7 +41,8 @@ RETURN
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
 
 

diff --git a/docs/source/libmemcached/memcached_fetch.rst b/docs/source/libmemcached/memcached_fetch.rst
index 0a9cd30c71a051d2f7cf70dec80d130c60e266ba..3fd638f13ac438f6448a8252069383ee983a78df 100644 (file)
--- a/docs/source/libmemcached/memcached_fetch.rst
+++ b/docs/source/libmemcached/memcached_fetch.rst
@@ -54,5 +54,7 @@ key allowed for the original memcached ascii server.
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_fetch_result(3)`
+.. only:: man
+
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_fetch_result(3)`
 

diff --git a/docs/source/libmemcached/memcached_last_error_message.rst b/docs/source/libmemcached/memcached_last_error_message.rst
index 0995550b4677d34045cc23d7a99f900381a707f9..5ae3188d42e88462be14d361a95e6e89f7d5db3d 100644 (file)
--- a/docs/source/libmemcached/memcached_last_error_message.rst
+++ b/docs/source/libmemcached/memcached_last_error_message.rst
@@ -35,6 +35,8 @@ de-allocated. If no error has occurred then it will return NULL.
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+.. only:: man
+
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
 
 

diff --git a/docs/source/libmemcached/memcached_return_t.rst b/docs/source/libmemcached/memcached_return_t.rst
index b60e2841f587a9a29c3117b612e16453981ac845..d2b99180715b953601eb8958202be03fc88f293a 100644 (file)
--- a/docs/source/libmemcached/memcached_return_t.rst
+++ b/docs/source/libmemcached/memcached_return_t.rst
@@ -121,4 +121,6 @@ Libmemcached return types:
 SEE ALSO
 --------
 
-:manpage:`memcached` :manpage:`libmemcached` :manpage:`memcached_str_error`
+.. only:: man
+
+  :manpage:`memcached` :manpage:`libmemcached` :manpage:`memcached_str_error`

diff --git a/docs/source/libmemcached_configuration.rst b/docs/source/libmemcached_configuration.rst
index c8c018e2214baf88c32931b799bf58f8c3df5509..1602f97d270fef2f742bd8462863aaaebe589fe7 100644 (file)
--- a/docs/source/libmemcached_configuration.rst
+++ b/docs/source/libmemcached_configuration.rst
@@ -8,16 +8,12 @@ Configuring Libmemcached
 SYNOPSIS 
 --------
 
-.. describe:: #include <libmemcached-1.0/memcached.h>
+#include <libmemcached-1.0/memcached.h>
+  Compile and link with -lmemcached
 
-.. c:function:: memcached_st *\
-                memcached(const char *string, size_t string_length)
+.. c:function:: memcached_st *memcached(const char *string, size_t string_length)
 
-.. c:function:: memcached_return_t \
-                libmemcached_check_configuration(const char *option_string, size_t length, \
-                                                 char *error_buffer, size_t error_buffer_size)
-
-Compile and link with -lmemcached
+.. c:function:: memcached_return_t libmemcached_check_configuration(const char *option_string, size_t length, char *error_buffer, size_t error_buffer_size)
 
 
 -----------
@@ -231,5 +227,14 @@ EXAMPLE
 SEE ALSO
 --------
 
+.. only:: man
+
+    :manpage:`memcached(1)`
+    :manpage:`libmemcached(3)`
+    :manpage:`memcached_strerror(3)`
+
+.. only:: html
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+    * :manpage:`memcached(1)`
+    * :doc:`libmemcached`
+    * :doc:`memcached_strerror`

diff --git a/docs/source/libmemcached_examples.rst b/docs/source/libmemcached_examples.rst
index 014a677e9f3eb22757d399d987ba5390aa196673..d3b0876f58b4f7d3c37dad1c08e09685264c33e3 100644 (file)
--- a/docs/source/libmemcached_examples.rst
+++ b/docs/source/libmemcached_examples.rst
@@ -130,6 +130,5 @@ Notice that you freed values returned from memcached_fetch(). The define
 SEE ALSO
 --------
 
-
 :manpage:`memcached(1)`
 

diff --git a/docs/source/libmemcachedutil.rst b/docs/source/libmemcachedutil.rst
index 9c8691753fe853a563ce563c1706b8e0534ec7cd..530043ed5ecca50d87328dd7f89526ff176030a9 100644 (file)
--- a/docs/source/libmemcachedutil.rst
+++ b/docs/source/libmemcachedutil.rst
@@ -10,12 +10,8 @@ Utility library for libmemcached
 SYNOPSIS
 --------
 
-.. code-block:: c
-
-   cc [ flag ... ] file ... -lmemcachedutil
- 
-   #include <libmemcached/memcached_util.h>
-
+#include <libmemcached/memcached_util.h>
+  Compile and link with -lmemcachedutil
 
 
 -----------
@@ -23,24 +19,32 @@ DESCRIPTION
 -----------
 
 
-:program:`libmemcachedutil`  is a small and thread-safe client library that 
-provides extra functionality built on top of :program:`libmemcached`.
+`libmemcachedutil` is a small and thread-safe client library that
+provides extra functionality built on top of `libmemcached`.
 
 
 -------
 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`.
+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:`memcached_pool`

diff --git a/docs/source/memcached_analyze.rst b/docs/source/memcached_analyze.rst
index 0aa85216b164f387e26cdd59e88b0ee753570e0c..50e3ee1b0f827679002ca87d343d1b79b5b7ed8c 100644 (file)
--- a/docs/source/memcached_analyze.rst
+++ b/docs/source/memcached_analyze.rst
@@ -56,6 +56,7 @@ memory allocated for it.
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
 

diff --git a/docs/source/memcached_append.rst b/docs/source/memcached_append.rst
index 0f4581113f16c4f7f6fc49e2a81f9dbd313b9825..12314af46e593e6a1e4b6af7b02d77e8e682ccc5 100644 (file)
--- a/docs/source/memcached_append.rst
+++ b/docs/source/memcached_append.rst
@@ -89,6 +89,7 @@ string.
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_add(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_replace(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_add(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_replace(3)`
 

diff --git a/docs/source/memcached_auto.rst b/docs/source/memcached_auto.rst
index f72e698a77a954dcde28f584943101a450609099..22b956218bf43c436e2972c259563f581ab95bb2 100644 (file)
--- a/docs/source/memcached_auto.rst
+++ b/docs/source/memcached_auto.rst
@@ -85,5 +85,6 @@ Use memcached_strerror to translate this value to a printable string.
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/memcached_behavior.rst b/docs/source/memcached_behavior.rst
index 87f958869b6913172239b75e1f17e1f195a65446..9f189ba49bbde92f593a0de950e6056f78f446ba 100644 (file)
--- a/docs/source/memcached_behavior.rst
+++ b/docs/source/memcached_behavior.rst
@@ -329,5 +329,6 @@ to data value, to taking a uin64_t.
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/memcached_callback.rst b/docs/source/memcached_callback.rst
index 8e32d90775b26b7fab7de0fd5a1816e2bfef10ff..7cccb77326d84c75d8bacc38a004b8e2af7a907e 100644 (file)
--- a/docs/source/memcached_callback.rst
+++ b/docs/source/memcached_callback.rst
@@ -137,5 +137,6 @@ successful setting, otherwise :c:type:`MEMCACHED_FAILURE` on error.
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/memcached_cas.rst b/docs/source/memcached_cas.rst
index 13b8842d4417e8d3da84cbe30d651cec2f05243a..b3cbddbacbd797800cce3ea3de4e09ed75411bb2 100644 (file)
--- a/docs/source/memcached_cas.rst
+++ b/docs/source/memcached_cas.rst
@@ -65,6 +65,7 @@ string.
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_append(3)` :manpage:`memcached_add(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_replace(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_append(3)` :manpage:`memcached_add(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_replace(3)`
 

diff --git a/docs/source/memcached_create.rst b/docs/source/memcached_create.rst
index 246a33d2a4bfa104f5ab66f919bba7c5e47e5341..a9ac137d0e063d0160e1532947fd32a75a5c8cb4 100644 (file)
--- a/docs/source/memcached_create.rst
+++ b/docs/source/memcached_create.rst
@@ -70,5 +70,6 @@ that was created (or initialized). On an allocation failure, it returns NULL.
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/memcached_delete.rst b/docs/source/memcached_delete.rst
index 493355dac4c75189b0d1b3ed36a61af8e6ab71d5..5daefaec4b2212b38d6e7567aa68dbfde77b631a 100644 (file)
--- a/docs/source/memcached_delete.rst
+++ b/docs/source/memcached_delete.rst
@@ -54,4 +54,6 @@ means that the message was queued for delivery.
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+.. only:: man
+
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/memcached_dump.rst b/docs/source/memcached_dump.rst
index bee396df0d5c851974b3d894b52d3319409d37ca..5959cec876a0a2536dacd97afa66528514b5317b 100644 (file)
--- a/docs/source/memcached_dump.rst
+++ b/docs/source/memcached_dump.rst
@@ -52,5 +52,6 @@ string.
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/memcached_flush.rst b/docs/source/memcached_flush.rst
index c2ac60f52d225eb7332b6f68997284e0736a4352..94612f4a907de510060cc45f214c322f0209ec5d 100644 (file)
--- a/docs/source/memcached_flush.rst
+++ b/docs/source/memcached_flush.rst
@@ -46,4 +46,6 @@ Use :c:type:`memcached_strerror` to translate this value to a printable string.
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+.. only:: man
+
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/memcached_flush_buffers.rst b/docs/source/memcached_flush_buffers.rst
index 0c92d3a293a2c38078286b1c2931cf70cdcfb0f9..4e1720069d9b14353ac1382683c39b058c2da7d1 100644 (file)
--- a/docs/source/memcached_flush_buffers.rst
+++ b/docs/source/memcached_flush_buffers.rst
@@ -44,5 +44,6 @@ string.
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/memcached_generate_hash_value.rst b/docs/source/memcached_generate_hash_value.rst
index 4a81a8d068ea1bf697dcc8b81dbfe188b4981a78..413a729204d76d0110ab27f0815deabc9ad788a8 100644 (file)
--- a/docs/source/memcached_generate_hash_value.rst
+++ b/docs/source/memcached_generate_hash_value.rst
@@ -82,5 +82,6 @@ returned.
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/memcached_get.rst b/docs/source/memcached_get.rst
index 4ece04e555aed8e46288ac36f87b76123122dd64..8c478ce92ac33a6b62a7b43f76e0fa597c046cc2 100644 (file)
--- a/docs/source/memcached_get.rst
+++ b/docs/source/memcached_get.rst
@@ -120,4 +120,6 @@ to :c:type:`MEMCACHED_END` upon successful conclusion.
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+.. only:: man
+
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/memcached_memory_allocators.rst b/docs/source/memcached_memory_allocators.rst
index 6ed8ae3d6f3d636fd0f2bca8a9fb5ea4d860aaeb..0df7d70c9d080a91f9ea05edd7088127ef773678 100644 (file)
--- a/docs/source/memcached_memory_allocators.rst
+++ b/docs/source/memcached_memory_allocators.rst
@@ -81,4 +81,6 @@ of function pointers.
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+.. only:: man
+
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/memcached_pool.rst b/docs/source/memcached_pool.rst
index 044924444d0a14f05d67e961db99e5f127728a79..c28fbf384ee06eb24830593665ba406fca52aa7a 100644 (file)
--- a/docs/source/memcached_pool.rst
+++ b/docs/source/memcached_pool.rst
@@ -7,30 +7,20 @@ SYNOPSIS
 --------
 
 #include <libmemcached/memcached_pool.h>
+  Compile and link with -lmemcachedutil -lmemcached
 
-.. c:type:: memcached_pool_st
+.. c:type:: struct memcached_pool_st
+
+  typedef struct memcached_pool_st memcached_pool_st;
 
 .. c:function:: memcached_pool_st* memcached_pool(const char *option_string, size_t option_string_length) 
 
-.. c:function:: memcached_pool_st* memcached_pool_create(memcached_st* mmc, int initial, int max)
-.. deprecated:: 0.46
-   Use :c:func:`memcached_pool`
- 
 .. c:function:: memcached_st* memcached_pool_destroy(memcached_pool_st* pool)
  
-.. c:function:: memcached_st* memcached_pool_pop(memcached_pool_st* pool, bool block, memcached_return_t *rc)
-.. deprecated:: 0.53
-   Use :c:func:`memcached_pool_fetch`
-
 .. c:function:: memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc)
-
 .. versionadded:: 0.53
    Synonym for memcached_pool_pop
 
-.. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc)
-.. deprecated:: 0.53
-   Use :c:func:`memcached_pool_push`
-
 .. c:function:: memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc)
 .. versionadded:: 0.53
    Synonym for memcached_pool_push.
@@ -39,7 +29,19 @@ SYNOPSIS
  
 .. c:function:: memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
 
-Compile and link with -lmemcachedutil -lmemcached
+
+.. c:function:: memcached_pool_st* memcached_pool_create(memcached_st* mmc, int initial, int max)
+.. deprecated:: 0.46
+   Use :c:func:`memcached_pool`
+
+.. c:function:: memcached_st* memcached_pool_pop(memcached_pool_st* pool, bool block, memcached_return_t *rc)
+.. deprecated:: 0.53
+   Use :c:func:`memcached_pool_fetch`
+
+.. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc)
+.. deprecated:: 0.53
+   Use :c:func:`memcached_pool_release`
+
 
 -----------
 DESCRIPTION
@@ -48,39 +50,53 @@ DESCRIPTION
 
 :c:func:`memcached_pool` is used to create a connection pool of objects you 
 may use to remove the overhead of using memcached_clone for short lived
-:c:type:`memcached_st` objects. Please see :doc:`libmemcached_configuration` for details on the format of the configuration string.
+:c:type:`memcached_st` objects. Please see :doc:`libmemcached_configuration`
+for details on the format of the configuration string.
 
 :c:func:`memcached_pool_destroy` is used to destroy the connection pool
 created with :c:func:`memcached_pool_create` and release all allocated
 resources. It will return the pointer to the :c:type:`memcached_st` structure
-passed as an argument to :c:func:`memcached_pool_create`, and returns the ownership of the pointer to the caller when created with :c:func:`memcached_pool_create`, otherwise NULL is returned..
+passed as an argument to :c:func:`memcached_pool_create`, and returns the
+ownership of the pointer to the caller when created with
+:c:func:`memcached_pool_create`, otherwise NULL is returned..
 
 :c:func:`memcached_pool_fetch` is used to fetch a connection structure from the
 connection pool. The relative_time argument specifies if the function should
 block and wait for a connection structure to be available if we try
 to exceed the maximum size. You need to specify time in relative time.
 
-:c:func:`memcached_pool_release` is used to return a connection structure back to the pool.
+:c:func:`memcached_pool_release` is used to return a connection structure back
+to the pool.
 
-:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_set` is used to get/set behavior flags on all connections in the pool.
+:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_set`
+is used to get/set behavior flags on all connections in the pool.
 
-Both :c:func:`memcached_pool_release` and :c:func:`memcached_pool_fetch` are thread safe.
+Both :c:func:`memcached_pool_release` and :c:func:`memcached_pool_fetch` are
+thread safe.
 
 ------
 RETURN
 ------
 
-:c:func:`memcached_pool_destroy` returns the pointer (and ownership) to the :c:type:`memcached_st` structure used to create the pool. If connections are in use it returns NULL.
+:c:func:`memcached_pool_destroy` returns the pointer (and ownership) to the
+:c:type:`memcached_st` structure used to create the pool. If connections are in
+use it returns NULL.
 
-:c:func:`memcached_pool_pop` returns a pointer to a :c:type:`memcached_st` structure from the pool (or NULL if an allocation cannot be satisfied).
+:c:func:`memcached_pool_pop` returns a pointer to a :c:type:`memcached_st`
+structure from the pool (or NULL if an allocation cannot be satisfied).
 
 :c:func:`memcached_pool_release` returns :c:type:`MEMCACHED_SUCCESS` upon success.
 
-:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_get` returns :c:type:`MEMCACHED_SUCCESS` upon success.
+:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_get`
+returns :c:type:`MEMCACHED_SUCCESS` upon success.
 
-If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
+If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not
+be obtained. If any of the parameters passed to any of these functions is
+invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
 
-memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
+memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while
+waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was
+available.
 
 
 
@@ -88,4 +104,16 @@ memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while wait
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`libmemcached_configuration(3)`
+.. only:: man
+
+    :manpage:`memcached(1)`
+    :manpage:`libmemcached(3)`
+    :manpage:`libmemcached_configuration(3)`
+    :manpage:`memcached_strerror(3)`
+
+.. only:: html
+
+    * :manpage:`memcached(1)`
+    * :doc:`libmemcached`
+    * :doc:`libmemcached_configuration`
+    * :doc:`memcached_strerror`

diff --git a/docs/source/memcached_quit.rst b/docs/source/memcached_quit.rst
index 9f79a79ba43cbc1b32e68deb2dcdd441ab5dd407..f4ffc17a36803275ba08652b1998816324f7d65f 100644 (file)
--- a/docs/source/memcached_quit.rst
+++ b/docs/source/memcached_quit.rst
@@ -43,4 +43,6 @@ translate this value to a printable string.
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+.. only:: man
+
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/memcached_result_st.rst b/docs/source/memcached_result_st.rst
index 40e1ad86dbe7fcec79d30126c89a851cb28c67ef..124d20e79dfc47b332d1cfae1242a4d5e9ad3d3a 100644 (file)
--- a/docs/source/memcached_result_st.rst
+++ b/docs/source/memcached_result_st.rst
@@ -114,4 +114,6 @@ to do this will result in leaked memory.
 SEE ALSO
 --------
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+.. only:: man
+
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/memcached_sasl.rst b/docs/source/memcached_sasl.rst
index ff2dad31e91efc6384064d07635968045c9406fb..1a76aa4178f0fd5da6ee46495a58309144599a85 100644 (file)
--- a/docs/source/memcached_sasl.rst
+++ b/docs/source/memcached_sasl.rst
@@ -58,5 +58,6 @@ this memcached handle. :c:func:`memcached_set_sasl_auth_data` returns
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/memcached_server_st.rst b/docs/source/memcached_server_st.rst
index dbbaf03d13bf8e6e9b5a9dde58f60be664a950c7..dd9e7bfbcd60c6954e7b96dc94e77fa48bb59e96 100644 (file)
--- a/docs/source/memcached_server_st.rst
+++ b/docs/source/memcached_server_st.rst
@@ -76,5 +76,6 @@ Varies, see particular functions.
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/memcached_servers.rst b/docs/source/memcached_servers.rst
index 2aea068d28b587db78d73e0cab15cd3ca6aa3b0e..7ebb523db5973ceae3de4609f5cc4e1b47efc29a 100644 (file)
--- a/docs/source/memcached_servers.rst
+++ b/docs/source/memcached_servers.rst
@@ -86,5 +86,6 @@ Varies, see particular functions.
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`

diff --git a/docs/source/memcached_set.rst b/docs/source/memcached_set.rst
index 6776234ccf5620e68529ce80e615e882a7ff2bbf..a55ffff6b560c9f138b1ab28a6853edcfcad7960 100644 (file)
--- a/docs/source/memcached_set.rst
+++ b/docs/source/memcached_set.rst
@@ -88,6 +88,7 @@ For :c:func:`memcached_replace` and :c:func:`memcached_add`, :c:type:`MEMCACHED_
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_append(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_append(3)`
 

diff --git a/docs/source/memcached_stats.rst b/docs/source/memcached_stats.rst
index d8f795332573b63fa465e1309627fbfe7124cc96..e247a7bed100d6f759b1c2f10c741af0e55ddfd1 100644 (file)
--- a/docs/source/memcached_stats.rst
+++ b/docs/source/memcached_stats.rst
@@ -72,6 +72,7 @@ memory allocated for it.
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
 

diff --git a/docs/source/memcached_strerror.rst b/docs/source/memcached_strerror.rst
index 8d71687685d52768148905eefeb950f5549c9253..115a58ffe4e02e9e5660fb10983e9dd9a5602e63 100644 (file)
--- a/docs/source/memcached_strerror.rst
+++ b/docs/source/memcached_strerror.rst
@@ -42,6 +42,7 @@ RETURN
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
 

diff --git a/docs/source/memcached_user_data.rst b/docs/source/memcached_user_data.rst
index 3063caa3efd162f8552d4ef0c309b5d7c7cfd526..b45f192e09ba07cc8b99136ce8c75cd0bac40ced 100644 (file)
--- a/docs/source/memcached_user_data.rst
+++ b/docs/source/memcached_user_data.rst
@@ -59,6 +59,7 @@ RETURN
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
 

diff --git a/docs/source/memcached_verbosity.rst b/docs/source/memcached_verbosity.rst
index 3c73e316e6d82c4e3452d4c1634474aac04e17a0..6eedaf7ea76fb39d2020ecc9338858f23e7588f0 100644 (file)
--- a/docs/source/memcached_verbosity.rst
+++ b/docs/source/memcached_verbosity.rst
@@ -42,6 +42,7 @@ Use :c:func:`memcached_strerror` to translate this value to a printable string.
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
 

diff --git a/docs/source/memcached_version.rst b/docs/source/memcached_version.rst
index fe261020b701689935d6980d9f4c3a6bd155269b..77f30b1d363c6ede3dfa87ae8b08a79d640686a6 100644 (file)
--- a/docs/source/memcached_version.rst
+++ b/docs/source/memcached_version.rst
@@ -50,6 +50,7 @@ a printable string.
 SEE ALSO
 --------
 
+.. only:: man
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
 

diff --git a/include/libhashkit-1.0/CMakeLists.txt b/include/libhashkit-1.0/CMakeLists.txt
index bb97fb30fff28c9a82ed56c411771cf1012f1cf0..13e836f62758852959f866b133f3e8ee5e8dbc51 100644 (file)
--- a/include/libhashkit-1.0/CMakeLists.txt
+++ b/include/libhashkit-1.0/CMakeLists.txt
@@ -1,9 +1,7 @@
 
 configure_file(configure.h.in configure.h @ONLY)
 
-install_public_headers(
-        libhashkit-1.0
-
+install_public_headers(libhashkit-1.0
         algorithm.h
         basic_string.h
         behavior.h