X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_create.3;h=20e7ca3d62478e8a739ac9b0f7ac4ca33d8a7d27;hb=2ba52818375fa389a777cf3a2ab3a0249d8a7864;hp=1cb286a9e8da43e37d9939d650a5f5f49d99294e;hpb=1c5912a525fe2b06a185f97bb078ca6f782da3a4;p=m6w6%2Flibmemcached

diff --git a/docs/man/memcached_create.3 b/docs/man/memcached_create.3
index 1cb286a9..20e7ca3d 100644
--- a/docs/man/memcached_create.3
+++ b/docs/man/memcached_create.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_CREATE" "3" "April 08, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_CREATE" "3" "October 18, 2011" "1.01" "libmemcached"
 .SH NAME
 memcached_create \- libmemcached Documentation
 .
@@ -30,70 +30,79 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 ..
 .\" Man page generated from reStructeredText.
 .
-.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 memcachd_st
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st* memcached_create(memcached_st\fI\ *ptr\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void memcached_free(memcached_st\fI\ *ptr\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st* memcached_clone(memcached_st\fI\ *destination\fP, memcached_st\fI\ *source\fP)
+.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
-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 \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 \fI\%memcached_create()\fP or
 a NULL. If a NULL passed in then a structure is allocated for you.
 .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.
+Please note, when you write new application use
+\fBmemcached_create_with_options()\fP over
+\fI\%memcached_create()\fP.
 .sp
-memcached_servers_reset() allows you to zero out the list of servers that
-the memcached_st has.
+\fI\%memcached_clone()\fP is similar to \fI\%memcached_create()\fP 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 \fI\%memcached_create()\fP.
+If the destination argument is NULL a \fBmemcached_st\fP will be allocated
+for you.
 .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.
+\fI\%memcached_servers_reset()\fP allows you to zero out the list of
+servers that the \fBmemcached_st\fP has.
+.sp
+To clean up memory associated with a \fBmemcached_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 \fBmemcached_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 \fBmemcached_st\fP
+that was created (or initialized). On an allocation failure, it returns NULL.
 .SH HOME
 .sp
 To find out more information please check:
-\fI\%https://launchpad.net/libmemcached\fP
-.SH AUTHOR
-.sp
-Brian Aker, <\fI\%brian@tangent.org\fP>
+\fI\%http://libmemcached.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.
 .\" 
 .