X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fhashkit_hsieh.3;h=1229f2b4df0493cb6d4a467cc9e5c677415c1228;hb=0792d5bdd0b2a352cce1a4cb084eca19b15acc56;hp=9815ff0e325c85322ddf1593564863067bd013f1;hpb=30e386cd241ac56fd9205d12c143761475307705;p=m6w6%2Flibmemcached diff --git a/docs/man/hashkit_hsieh.3 b/docs/man/hashkit_hsieh.3 index 9815ff0e..c415db1e 100644 --- a/docs/man/hashkit_hsieh.3 +++ b/docs/man/hashkit_hsieh.3 @@ -1,4 +1,4 @@ -.TH "HASHKIT_HSIEH" "3" "April 09, 2011" "0.47" "libmemcached" +.TH "HASHKIT_HSIEH" "3" "April 17, 2012" "1.0.6" "libmemcached" .SH NAME hashkit_hsieh \- libhashkit Documentation . @@ -32,34 +32,58 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] . .sp Various hash functions to use for calculating values for keys -.SH LIBRARY -.sp -C Library for hashing algorithms (libmemcached, \-lhashkit) .SH SYNOPSIS .sp -.nf -.ft C -#include - -uint32_t hashkit_default(const char *key, size_t key_length); -uint32_t hashkit_fnv1_64(const char *key, size_t key_length); -uint32_t hashkit_fnv1a_64(const char *key, size_t key_length); -uint32_t hashkit_fnv1_32(const char *key, size_t key_length); -uint32_t hashkit_fnv1a_32(const char *key, size_t key_length); -uint32_t hashkit_crc32(const char *key, size_t key_length); -uint32_t hashkit_hsieh(const char *key, size_t key_length); -uint32_t hashkit_murmur(const char *key, size_t key_length); -uint32_t hashkit_jenkins(const char *key, size_t key_length); -uint32_t hashkit_md5(const char *key, size_t key_length); -.ft P -.fi +#include +.INDENT 0.0 +.TP +.B uint32_t hashkit_default(const char\fI\ *key\fP, size_t\fI\ key_length\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B uint32_t hashkit_fnv1_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B uint32_t hashkit_fnv1a_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B uint32_t hashkit_fnv1_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B uint32_t hashkit_fnv1a_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B uint32_t hashkit_crc32(const char\fI\ *key\fP, size_t\fI\ key_length\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B uint32_t hashkit_hsieh(const char\fI\ *key\fP, size_t\fI\ key_length\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B uint32_t hashkit_murmur(const char\fI\ *key\fP, size_t\fI\ key_length\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B uint32_t hashkit_jenkins(const char\fI\ *key\fP, size_t\fI\ key_length\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B uint32_t hashkit_md5(const char\fI\ *key\fP, size_t\fI\ key_length\fP) +.UNINDENT +.sp +Compile and link with \-lhashkit .SH DESCRIPTION .sp These functions generate hash values from a key using a variety of algorithms. These functions can be used standalone, or as arguments to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3). .sp -The hashkit_hsieh() is only available if the library is built with +The hashkit_hsieh is only available if the library is built with the appropriate flag enabled. .SH RETURN VALUE .sp @@ -67,11 +91,10 @@ A 32\-bit hash value. .SH HOME .sp To find out more information please check: -\fI\%https://launchpad.net/libmemcached\fP +\fI\%http://libmemcached.org/\fP .SH SEE ALSO .sp -hashkit_create(3) hashkit_value(3) hashkit_set_hash_fn(3) -hashkit_set_continuum_hash_fn(3) +\fIhashkit_create(3)\fP \fIhashkit_value(3)\fP \fIhashkit_set_hash_fn(3)\fP \fIhashkit_set_continuum_hash_fn(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT