Fixes around m4 from trunk
[awesomized/libmemcached] / docs / man / hashkit_value.3
1 .TH "HASHKIT_VALUE" "3" "October 18, 2011" "1.01" "libmemcached"
2 .SH NAME
3 hashkit_value \- libhashkit Documentation
4 .
5 .nr rst2man-indent-level 0
6 .
7 .de1 rstReportMargin
8 \\$1 \\n[an-margin]
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
11 -
12 \\n[rst2man-indent0]
13 \\n[rst2man-indent1]
14 \\n[rst2man-indent2]
15 ..
16 .de1 INDENT
17 .\" .rstReportMargin pre:
18 . RS \\$1
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
22 ..
23 .de UNINDENT
24 . RE
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30 ..
31 .\" Man page generated from reStructeredText.
32 .
33 .sp
34 Generate a value for the given key
35 .SH SYNOPSIS
36 .sp
37 #include <libhashkit/hashkit.h>
38 .INDENT 0.0
39 .TP
40 .B uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length);
41 .UNINDENT
42 .sp
43 Compile and link with \-lhashkit
44 .SH DESCRIPTION
45 .sp
46 The \fBhashkit_value()\fP function generates a 32\-bit hash value from the
47 given key and key_length. The hash argument is an initialized hashkit
48 object, and distribution type and hash function is used from this
49 object while generating the value.
50 .SH RETURN VALUE
51 .sp
52 A 32\-bit hash value.
53 .SH HOME
54 .sp
55 To find out more information please check:
56 \fI\%http://libmemcached.org/\fP
57 .SH SEE ALSO
58 .sp
59 \fIhashkit_create(3)\fP \fIhashkit_set_distribution(3)\fP \fIhashkit_set_hash_fn(3)\fP
60 .SH AUTHOR
61 Brian Aker
62 .SH COPYRIGHT
63 2011, Brian Aker DataDifferential, http://datadifferential.com/
64 .\" Generated by docutils manpage writer.
65 .\"
66 .