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

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

diff --git a/docs/man/memcached_generate_hash_value.3 b/docs/man/memcached_generate_hash_value.3
index 21ce63b43afa64e87ee943c97365112227fd468b..2408a52d7286f11e40e733a6fc231937b7ae253b 100644 (file)
--- a/docs/man/memcached_generate_hash_value.3
+++ b/docs/man/memcached_generate_hash_value.3
@@ -1,6 +1,6 @@
-.TH "MEMCACHED_GENERATE_HASH_VALUE" "3" "April 07, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_GENERATE_HASH_VALUE" "3" "April 09, 2012" "1.0.6" "libmemcached"

 .SH NAME
 .SH NAME

-memcached_generate_hash_value \- libmemcached Documentation
+memcached_generate_hash_value \- Generating hash values directly

 .
 .nr rst2man-indent-level 0
 .
 .
 .nr rst2man-indent-level 0
 .


@@ -32,42 +32,79 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .
 .sp
 Hash a key value
 .
 .sp
 Hash a key value

-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)

 .SH SYNOPSIS
 .sp
 .SH SYNOPSIS
 .sp

-.nf
-.ft C

 #include <libmemcached/memcached.h>
 #include <libmemcached/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);
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B memcached_hash_t
+.UNINDENT
+.INDENT 0.0
+.TP
+.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
 .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
 .sp
 As of version 0.36 all hash methods have been placed into the library

-libhashkit(3) which is linked with libmemcached(3).
+libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.

 .SH RETURN
 .sp
 A 32\-bit integer which is the result of hashing the given key.
 .SH RETURN
 .sp
 A 32\-bit integer which is the result of hashing the given key.


@@ -76,17 +113,17 @@ returned.
 .SH HOME
 .sp
 To find out more information please check:
 .SH HOME
 .sp
 To find out more information please check:

-\fI\%https://launchpad.net/libmemcached\fP
+\fI\%http://libmemcached.org/\fP

 .SH AUTHOR
 .sp
 Brian Aker, <\fI\%brian@tangent.org\fP>
 .SH SEE ALSO
 .sp
 .SH AUTHOR
 .sp
 Brian Aker, <\fI\%brian@tangent.org\fP>
 .SH SEE ALSO
 .sp

-memcached(1) libmemcached(3) memcached_behavior_set(3) libhashkit(3)
+\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP

 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT

-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/

 .\" Generated by docutils manpage writer.
 .\" 
 .
 .\" Generated by docutils manpage writer.
 .\" 
 .