Update for release.

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

diff --git a/docs/man/memcached_free.3 b/docs/man/memcached_free.3
index 82c10f4dab3d6b4b64899c9dff64e913553a7b35..3aec610ab1ab7c7e61208bb3a96a92aaff93e473 100644 (file)
--- a/docs/man/memcached_free.3
+++ b/docs/man/memcached_free.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_FREE" "3" "June 17, 2011" "0.49" "libmemcached"
+.TH "MEMCACHED_FREE" "3" "September 16, 2012" "1.0.10" "libmemcached"
 .SH NAME
 memcached_free \- libmemcached Documentation
 .
@@ -35,54 +35,62 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 #include <libmemcached/memcached.h>
 .INDENT 0.0
 .TP
-.B memcached_st *memcached_create (memcached_st *ptr);
+.B memcached_st
 .UNINDENT
 .INDENT 0.0
 .TP
-.B void memcached_free (memcached_st *ptr);
+.B \fI\%memcached_st\fP* memcached_create(\fI\%memcached_st\fP\fI\ *ptr\fP)
 .UNINDENT
 .INDENT 0.0
 .TP
-.B memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
+.B void memcached_free(\fI\%memcached_st\fP\fI\ *ptr\fP)
 .UNINDENT
 .INDENT 0.0
 .TP
-.B void memcached_servers_reset(memcached_st);
+.B \fI\%memcached_st\fP* memcached_clone(\fI\%memcached_st\fP\fI\ *destination\fP, \fI\%memcached_st\fP\fI\ *source\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void memcached_servers_reset(\fI\%memcached_st\fP)
 .UNINDENT
 .sp
 Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
-memcached_create() is used to create a \fBmemcached_st\fP structure that will then
-be used by other libmemcached(3) functions to communicate with the server. You
-should either pass a statically declared \fBmemcached_st\fP to memcached_create() or
+\fI\%memcached_create()\fP is used to create a \fI\%memcached_st\fP
+structure that will then be used by other libmemcached(3) functions to
+communicate with the server. You should either pass a statically declared
+\fI\%memcached_st\fP to \fI\%memcached_create()\fP or
 a NULL. If a NULL passed in then a structure is allocated for you.
 .sp
-Please note, when you write new application use memcached_create_with_options() over memcached_create().
+Please note, when you write new application use
+\fBmemcached()\fP over \fI\%memcached_create()\fP.
 .sp
-memcached_clone() is similar to memcached_create(3) but it copies the
-defaults and list of servers from the source \fBmemcached_st\fP. If you pass a null as
-the argument for the source to clone, it is the same as a call to memcached_create().
-If the destination argument is NULL a \fBmemcached_st\fP will be allocated for you.
+\fI\%memcached_clone()\fP is similar to \fI\%memcached_create()\fP but
+it copies the defaults and list of servers from the source
+\fI\%memcached_st\fP. If you pass a null as the argument for the source
+to clone, it is the same as a call to \fI\%memcached_create()\fP.
+If the destination argument is NULL a \fI\%memcached_st\fP will be allocated
+for you.
 .sp
-memcached_servers_reset() allows you to zero out the list of servers that
-the memcached_st has.
+\fI\%memcached_servers_reset()\fP allows you to zero out the list of
+servers that the \fI\%memcached_st\fP has.
 .sp
-To clean up memory associated with a \fBmemcached_st\fP structure you should pass
-it to memcached_free() when you are finished using it. memcached_free() is
-the only way to make sure all memory is deallocated when you finish using
-the structure.
+To clean up memory associated with a \fI\%memcached_st\fP structure you
+should pass it to \fI\%memcached_free()\fP when you are finished using it.
+\fI\%memcached_free()\fP is the only way to make sure all memory is
+deallocated when you finish using the structure.
 .sp
 You may wish to avoid using memcached_create(3) or memcached_clone(3) with a
 stack based allocation. The most common issues related to ABI safety involve
 heap allocated structures.
 .SH RETURN
 .sp
-memcached_create() returns a pointer to the memcached_st that was created
-(or initialized). On an allocation failure, it returns NULL.
+\fI\%memcached_create()\fP returns a pointer to the \fI\%memcached_st\fP
+that was created (or initialized). On an allocation failure, it returns NULL.
 .sp
-memcached_clone() returns a pointer to the memcached_st that was created
-(or initialized). On an allocation failure, it returns NULL.
+\fI\%memcached_clone()\fP returns a pointer to the \fI\%memcached_st\fP
+that was created (or initialized). On an allocation failure, it returns NULL.
 .SH HOME
 .sp
 To find out more information please check:
@@ -93,7 +101,7 @@ To find out more information please check:
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT
-2011, Brian Aker DataDifferential, http://datadifferential.com/
+2011-2012, Brian Aker DataDifferential, http://datadifferential.com/
 .\" Generated by docutils manpage writer.
 .\" 
 .