Merge in updates to all docs/etc.
[m6w6/libmemcached] / docs / man / memcached_free.3
index d1691762164d955c15690a60cddd5cc470a544a4..25c6c29d599f8060b977effdd3c1a14a3d9cc6e9 100644 (file)
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_FREE" "3" "April 07, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_FREE" "3" "April 12, 2011" "0.47" "libmemcached"
 .SH NAME
 memcached_free \- libmemcached Documentation
 .
@@ -32,24 +32,27 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .
 .sp
 Create a memcached_st structure
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)
 .SH SYNOPSIS
 .sp
-.nf
-.ft C
 #include <libmemcached/memcached.h>
-
-memcached_st *memcached_create (memcached_st *ptr);
-
-void memcached_free (memcached_st *ptr);
-
-memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
-
-void memcached_servers_reset(memcached_st);
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_create (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void memcached_free (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void memcached_servers_reset(memcached_st);
+.UNINDENT
+.sp
+Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
 memcached_create() is used to create a \fBmemcached_st\fP structure that will then
@@ -57,6 +60,8 @@ 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
 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().
+.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().
@@ -84,16 +89,13 @@ memcached_clone() returns a pointer to the memcached_st that was created
 .sp
 To find out more information please check:
 \fI\%https://launchpad.net/libmemcached\fP
-.SH AUTHOR
-.sp
-Brian Aker, <\fI\%brian@tangent.org\fP>
 .SH SEE ALSO
 .sp
-memcached(1) libmemcached(3) memcached_strerror(3)
+\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
 .\" Generated by docutils manpage writer.
 .\" 
 .