Merging bzr://gaz.tangent.org/libmemcached/build/ to Build branch

[m6w6/libmemcached] / docs / man / memcached_generate_hash.3

diff --git a/docs/man/memcached_generate_hash.3 b/docs/man/memcached_generate_hash.3
index 48008e8f902688c5dc81685c13df002e1187f695..3bbbe447528e44101592eab3ff90ce5c5566a1bb 100644 (file)
--- a/docs/man/memcached_generate_hash.3
+++ b/docs/man/memcached_generate_hash.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_GENERATE_HASH" "3" "April 13, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_GENERATE_HASH" "3" "April 21, 2012" "1.0.6" "libmemcached"

 .SH NAME
 memcached_generate_hash \- Generating hash values directly
 .
 .SH NAME
 memcached_generate_hash \- Generating hash values directly
 .


@@ -37,27 +37,71 @@ Hash a key value
 #include <libmemcached/memcached.h>
 .INDENT 0.0
 .TP
 #include <libmemcached/memcached.h>
 .INDENT 0.0
 .TP

-.B uint32_t memcached_generate_hash_value (const char *key, size_t key_length, memcached_hash_t hash_algorithm);
+.B memcached_hash_t

 .UNINDENT
 .INDENT 0.0
 .TP
 .UNINDENT
 .INDENT 0.0
 .TP

-.B uint32_t memcached_generate_hash (memcached_st *ptr, const char *key, size_t key_length);
+.B uint32_t memcached_generate_hash_value(const char\fI\ *key\fP, size_t\fI\ key_length\fP, \fI\%memcached_hash_t\fP\fI\ hash_algorithm\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B uint32_t memcached_generate_hash(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_DEFAULT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_MD5
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_CRC
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_FNV1_64
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_FNV1A_64
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_FNV1_32
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_FNV1A_32
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_JENKINS
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_MURMUR
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_HSIEH

 .UNINDENT
 .sp
 Compile and link with \-lmemcachedutil \-lmemcached
 .SH DESCRIPTION
 .sp
 .UNINDENT
 .sp
 Compile and link with \-lmemcachedutil \-lmemcached
 .SH DESCRIPTION
 .sp

-memcached_generate_hash_value() allows you to hash a key using one of
+\fI\%memcached_generate_hash_value()\fP 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.
 .sp
 The allowed hash algorithm constants are listed in the manpage for
 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.
 .sp
 The allowed hash algorithm constants are listed in the manpage for

-memcached_behavior_set().
+\fBmemcached_behavior_set()\fP.

 .sp
 .sp

-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.
+\fI\%memcached_generate_hash()\fP takes a \fBmemcached_st\fP struture
+and produces the hash value that would have been generated based on the
+defaults of \fBmemcached_st\fP.

 .sp
 As of version 0.36 all hash methods have been placed into the library
 libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.
 .sp
 As of version 0.36 all hash methods have been placed into the library
 libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.