← Back to branch summary

~brianaker/libmemcached/libmemcached-gearman-remove

« back to all changes in this revision

Viewing changes to docs/man/hashkit_clone.3

  • Committer: Brian Aker
  • Date: 2012-09-30 23:57:30 UTC
  • mto: This revision was merged to the branch mainline in revision 1073.
  • Revision ID: brian@tangent.org-20120930235730-jl3k607syliahnl0
Fix how we do manpages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/hashkit_clone.3
1
 
.TH "HASHKIT_CLONE" "3" "September 16, 2012" "1.0.10" "libmemcached"
2
 
.SH NAME
3
 
hashkit_clone \- 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
 
.SH SYNOPSIS
34
 
.sp
35
 
#include <libhashkit/hashkit.h>
36
 
.INDENT 0.0
37
 
.TP
38
 
.B hashkit_st
39
 
.UNINDENT
40
 
.INDENT 0.0
41
 
.TP
42
 
.B \fI\%hashkit_st\fP *hashkit_create(\fI\%hashkit_st\fP\fI\ *hash\fP)
43
 
.UNINDENT
44
 
.INDENT 0.0
45
 
.TP
46
 
.B \fI\%hashkit_st\fP *hashkit_clone(\fI\%hashkit_st\fP\fI\ *destination\fP, const \fI\%hashkit_st\fP\fI\ *ptr\fP)
47
 
.UNINDENT
48
 
.INDENT 0.0
49
 
.TP
50
 
.B void hashkit_free(\fI\%hashkit_st\fP\fI\ *hash\fP)
51
 
.UNINDENT
52
 
.INDENT 0.0
53
 
.TP
54
 
.B bool hashkit_is_allocated(const \fI\%hashkit_st\fP\fI\ *hash\fP)
55
 
.UNINDENT
56
 
.sp
57
 
Compile and link with \-lhashkit
58
 
.SH DESCRIPTION
59
 
.sp
60
 
The \fI\%hashkit_create()\fP function initializes a hashkit object for use. If
61
 
you pass a NULL argument for hash, then the memory for the object is
62
 
allocated. If you specify a pre\-allocated piece of memory, that is
63
 
initialized for use.
64
 
.sp
65
 
The \fI\%hashkit_clone()\fP function initializes a hashkit object much like
66
 
\fI\%hashkit_create()\fP, but instead of using default settings it will use
67
 
the settings of the ptr hashkit object.
68
 
.sp
69
 
The \fI\%hashkit_free()\fP frees any resources being consumed by the hashkit
70
 
objects that were initialized with \fI\%hashkit_create()\fP or \fI\%hashkit_clone()\fP.
71
 
.sp
72
 
The \fI\%hashkit_is_allocated()\fP reports where the memory was allocated
73
 
for a hashkit object.
74
 
.SH RETURN VALUE
75
 
.sp
76
 
\fI\%hashkit_create()\fP and \fI\%hashkit_clone()\fP will return NULL on
77
 
failure or non\-NULL on success.
78
 
.sp
79
 
\fI\%hashkit_is_allocated()\fP returns true if the memory for the hashkit
80
 
object was allocated inside of \fI\%hashkit_create()\fP or
81
 
\fI\%hashkit_clone()\fP, otherwise it is false and was user\-supplied memory.
82
 
.SH HOME
83
 
.sp
84
 
To find out more information please check:
85
 
\fI\%http://libmemcached.org/\fP
86
 
.SH SEE ALSO
87
 
.sp
88
 
\fIhashkit_create(3)\fP \fIhashkit_value(3)\fP \fIhashkit_set_hash_fn(3)\fP
89
 
.SH AUTHOR
90
 
Brian Aker
91
 
.SH COPYRIGHT
92
 
2011-2012, Brian Aker DataDifferential, http://datadifferential.com/
93
 
.\" Generated by docutils manpage writer.
94
 
.\" 
95
 
.