Replace pod docs with sphinx docs.

[awesomized/libmemcached] / docs / memcached_generate_hash_value.rst

diff --git a/docs/memcached_generate_hash_value.rst b/docs/memcached_generate_hash_value.rst
new file mode 100644 (file)
index 0000000..278bf9c
--- /dev/null
+++ b/docs/memcached_generate_hash_value.rst
@@ -0,0 +1,96 @@
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+memcached_generate_hash_value - Hash a key value
+
+
+*******
+LIBRARY
+*******
+
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+
+********
+SYNOPSIS
+********
+
+
+
+.. code-block:: perl
+
+   #include <memcached.h>
+ 
+   uint32_t
+     memcached_generate_hash_value (const char *key,
+                                    size_t key_length,
+                                    memcached_hash_t hash_algorithm);
+ 
+   uint32_t 
+     memcached_generate_hash (memcached_st *ptr,
+                              const char *key, 
+                              size_t key_length);
+
+
+
+***********
+DESCRIPTION
+***********
+
+
+memcached_generate_hash_value() allows you to hash a key using one of
+the hash functions defined in the library. This method is provided for
+the convenience of higher-level language bindings and is not necessary
+for normal memcache operations.
+
+The allowed hash algorithm constants are listed in the manpage for
+memcached_behavior_set().
+
+memcached_generate_hash() takes a memcached_st struture and produces
+the hash value that would have been generated based on the defaults
+of the memcached_st structure.
+
+As of version 0.36 all hash methods have been placed into the library
+libhashkit(3) which is linked with libmemcached(3).
+
+
+******
+RETURN
+******
+
+
+A 32-bit integer which is the result of hashing the given key.
+For 64-bit hash algorithms, only the least-significant 32 bits are
+returned.
+
+
+****
+HOME
+****
+
+
+To find out more information please check: 
+`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+
+
+******
+AUTHOR
+******
+
+
+Brian Aker, <brian@tangent.org>
+
+
+********
+SEE ALSO
+********
+
+
+memcached(1) libmemcached(3) memcached_behavior_set(3) libhashkit(3)
+