X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_generate_hash_value.3;h=635a0e286728d79b57255007b69b28fc7f5b59d7;hb=178d4c4b7794f9115f9c4d387b01c14961cb3c1e;hp=614e1d9a5ddb5f6f7cd44b5983e691503b51cb40;hpb=e668c212d13197abf5d8e2ddc7916057c94325b6;p=awesomized%2Flibmemcached diff --git a/docs/man/memcached_generate_hash_value.3 b/docs/man/memcached_generate_hash_value.3 index 614e1d9a..635a0e28 100644 --- 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 08, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_GENERATE_HASH_VALUE" "3" "September 26, 2011" "0.53" "libmemcached" .SH NAME -memcached_generate_hash_value \- libmemcached Documentation +memcached_generate_hash_value \- Generating hash values directly . .nr rst2man-indent-level 0 . @@ -32,39 +32,32 @@ 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 - -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 +\fBmemcached_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 -memcached_behavior_set(). +\fBmemcached_behavior_set()\fP. .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. +\fBmemcached_generate_hash()\fP takes a \fBmemcached_st\fP struture +and produces the hash value that would have been generated based on the +defaults of the \fBmemcached_st structure\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. @@ -76,7 +69,7 @@ returned. .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>