Merge in trunk
[m6w6/libmemcached] / docs / man / memcached_set_memory_allocators_context.3
index b381c9d58b76cc6aa0d347d55da5e4ecf06aa583..65ddca2c9212adab716683f5d0b9b2153bf93685 100644 (file)
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_SET_MEMORY_ALLOCATORS_CONTEXT" "3" "April 08, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_SET_MEMORY_ALLOCATORS_CONTEXT" "3" "June 17, 2011" "0.49" "libmemcached"
 .SH NAME
 memcached_set_memory_allocators_context \- libmemcached Documentation
 .
@@ -32,57 +32,43 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .
 .sp
 Manage memory allocator functions
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)
 .SH SYNOPSIS
 .sp
-.nf
-.ft C
 #include <libmemcached/memcached.h>
-
-memcached_return_t
-  memcached_set_memory_allocators (memcached_st *ptr,
-                                   memcached_malloc_fn mem_malloc,
-                                   memcached_free_fn mem_free,
-                                   memcached_realloc_fn mem_realloc,
-                                   memcached_calloc_fn mem_calloc,
-                                  void *context);
-
-void
-  memcached_get_memory_allocators (memcached_st *ptr,
-                                   memcached_malloc_fn *mem_malloc,
-                                   memcached_free_fn *mem_free,
-                                   memcached_realloc_fn *mem_realloc,
-                                   memcached_calloc_fn *mem_calloc);
-
-void *
-  memcached_get_memory_allocators_context(const memcached_st *ptr);
-
-void *
-  (*memcached_malloc_fn) (memcached_st *ptr, const size_t size,
-                         void *context);
-
-void *
-  (*memcached_realloc_fn) (memcached_st *ptr, void *mem,
-                           const size_t size,
-                          void *context);
-
-void
-  (*memcached_free_fn) (memcached_st *ptr, void *mem,
-                       void *context);
-
-void *
-(*memcached_calloc_fn) (memcached_st *ptr,
-                       size_t nelem,
-                        const size_t elsize,
-                       void *context);
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_set_memory_allocators (memcached_st *ptr, memcached_malloc_fn mem_malloc, memcached_free_fn mem_free, memcached_realloc_fn mem_realloc, memcached_calloc_fn mem_calloc, void *context);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void memcached_get_memory_allocators (memcached_st *ptr, memcached_malloc_fn *mem_malloc, memcached_free_fn *mem_free, memcached_realloc_fn *mem_realloc, memcached_calloc_fn *mem_calloc);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void * memcached_get_memory_allocators_context(const memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context);
+.UNINDENT
+.sp
+Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
-libmemcached(3) allows you to specify your own memory allocators optimized
-for your application.
+libmemcached(3) allows you to specify your own memory allocators, optimized
+for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.
 .sp
 memcached_set_memory_allocators() is used to set the memory allocators used
 by the memcached instance specified by ptr. Please note that you cannot
@@ -112,18 +98,14 @@ and MEMCACHED_FAILURE if you don\(aqt pass a complete set of function pointers.
 .SH HOME
 .sp
 To find out more information please check:
-\fI\%https://launchpad.net/libmemcached\fP
-.SH AUTHOR
-.sp
-Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
-Brian Aker, <\fI\%brian@tangent\fP.orf<gt>
+\fI\%http://libmemcached.org/\fP
 .SH SEE ALSO
 .sp
-memcached(1) libmemcached(3) memcached_get_user_data(3) memcached_set_user_data(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.
 .\" 
 .