Adding in memcached_last_error_message.3

[awesomized/libmemcached] / docs / man / hashkit_free.3

diff --git a/docs/man/hashkit_free.3 b/docs/man/hashkit_free.3
index 81fe571bf21f97c9a5fc96ce22d87fb76e67903d..6e314bba695424bf4b1f3a1248d66de7804df616 100644 (file)
--- a/docs/man/hashkit_free.3
+++ b/docs/man/hashkit_free.3
@@ -1,4 +1,4 @@
-.TH "HASHKIT_FREE" "3" "April 10, 2011" "0.47" "libmemcached"
+.TH "HASHKIT_FREE" "3" "September 09, 2011" "0.52" "libmemcached"
 .SH NAME
 hashkit_free \- libhashkit Documentation
 .
@@ -30,54 +30,62 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 ..
 .\" Man page generated from reStructeredText.
 .
-.sp
-Create and destroy hashkit objects
-.SH LIBRARY
-.sp
-C Library for hashing algorithms (libmemcached, \-lhashkit)
 .SH SYNOPSIS
 .sp
-.nf
-.ft C
-#include <libmemcached/hashkit.h>
-
-hashkit_st *hashkit_create(hashkit_st *hash);
-
-hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
-
-void hashkit_free(hashkit_st *hash);
-
-bool hashkit_is_allocated(const hashkit_st *hash);
-.ft P
-.fi
+#include <libhashkit/hashkit.h>
+.INDENT 0.0
+.TP
+.B hashkit_st
+.UNINDENT
+.INDENT 0.0
+.TP
+.B hashkit_st *hashkit_create(hashkit_st *hash);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void hashkit_free(hashkit_st *hash);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B bool hashkit_is_allocated(const hashkit_st *hash);
+.UNINDENT
+.sp
+Compile and link with \-lhashkit
 .SH DESCRIPTION
 .sp
-The hashkit_create() function initializes a hashkit object for use. If
+The \fBhashkit_create()\fP function initializes a hashkit object for use. If
 you pass a NULL argument for hash, then the memory for the object is
 allocated. If you specify a pre\-allocated piece of memory, that is
 initialized for use.
 .sp
-The hashkit_clone() function initializes a hashkit object much like
-hashkit_create(), but instead of using default settings it will use
+The \fBhashkit_clone()\fP function initializes a hashkit object much like
+\fBhashkit_create()\fP, but instead of using default settings it will use
 the settings of the ptr hashkit object.
 .sp
-The hashkit_free() frees any resources being consumed by the hashkit
-objects that were initialized with hashkit_create() or hashkit_clone().
+The \fBhashkit_free()\fP frees any resources being consumed by the hashkit
+objects that were initialized with \fBhashkit_create()\fP or \fBhashkit_clone()\fP.
 .sp
-The hashkit_is_allocated() reports where the memory was allocated
+The \fBhashkit_is_allocated()\fP reports where the memory was allocated
 for a hashkit object.
 .SH RETURN VALUE
 .sp
-hashkit_create() and hashkit_clone() will return NULL on failure or
-non\-NULL on success.
+\fBhashkit_create()\fP and \fBhashkit_clone()\fP will return NULL on
+failure or non\-NULL on success.
 .sp
-hashkit_is_allocated() returns true if the memory for the hashkit
-object was allocated inside of hashkit_create() or hashkit_clone(),
-otherwise it is false and was user\-supplied memory.
+\fBhashkit_is_allocated()\fP returns true if the memory for the hashkit
+object was allocated inside of \fBhashkit_create()\fP or
+\fBhashkit_clone()\fP, otherwise it is false and was user\-supplied memory.
 .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
+\fIhashkit_create(3)\fP \fIhashkit_value(3)\fP \fIhashkit_set_hash_fn(3)\fP
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT