Update build bits, include forgotten manpages.

[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 b81e3ce7cea705dee98cd161e40250ddeaaf5d74..86a131c1c2bce69ccf9510dd7f1f16cf8bcbd514 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 09, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_GENERATE_HASH_VALUE" "3" "May 22, 2012" "1.0.8" "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,39 +32,76 @@ 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
 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.


@@ -76,7 +113,7 @@ 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 AUTHOR
 .sp
 Brian Aker, <\fI\%brian@tangent.org\fP>