Simplify the calling structure for creating a memcached_st.
[m6w6/libmemcached] / docs / man / memcached_generate_hash_value.3
index 21ce63b43afa64e87ee943c97365112227fd468b..18438f4ed5320921292ad6a1eb3ed6e0baefd58c 100644 (file)
@@ -1,6 +1,6 @@
-.TH "MEMCACHED_GENERATE_HASH_VALUE" "3" "April 07, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_GENERATE_HASH_VALUE" "3" "April 13, 2011" "0.47" "libmemcached"
 .SH NAME
-memcached_generate_hash_value \- libmemcached Documentation
+memcached_generate_hash_value \- Generating hash values directly
 .
 .nr rst2man-indent-level 0
 .
@@ -32,26 +32,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .
 .sp
 Hash a key value
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)
 .SH SYNOPSIS
 .sp
-.nf
-.ft C
 #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 uint32_t memcached_generate_hash_value (const char *key, size_t key_length, memcached_hash_t hash_algorithm);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B uint32_t memcached_generate_hash (memcached_st *ptr, const char *key, size_t key_length);
+.UNINDENT
+.sp
+Compile and link with \-lmemcachedutil \-lmemcached
 .SH DESCRIPTION
 .sp
 memcached_generate_hash_value() allows you to hash a key using one of
@@ -67,7 +60,7 @@ the hash value that would have been generated based on the defaults
 of the memcached_st structure.
 .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.
@@ -82,11 +75,11 @@ To find out more information please check:
 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
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
 .\" Generated by docutils manpage writer.
 .\" 
 .