]> git.sur5r.net Git - openldap/blobdiff - doc/man/man3/lber-memory.3
cleanup
[openldap] / doc / man / man3 / lber-memory.3
index 547739f6796a3771a760ed2adbf8a86c1e38b3b2..06465fcbb1a32fcf2cc16032e2189fe8cac21139 100644 (file)
@@ -1,29 +1,23 @@
-.TH LBER_MEMORY 3 "29 August 2001" "OpenLDAP LDVERSION"
+.TH LBER_MEMORY 3 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
-.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
-ber_memalloc, ber_memcalloc, ber_memrealloc, ber_memfree \- LBER memory allocators
+ber_memalloc, ber_memcalloc, ber_memrealloc, ber_memfree, ber_memvfree \- LBER memory allocators
+.SH LIBRARY
+OpenLDAP LBER (liblber, -llber)
 .SH SYNOPSIS
-.nf
-.ft B
-#include <lber.h>
-.ft
-.fi
+.B #include <lber.h>
 .LP
-.nf
-.ft B
-void * ber_memalloc( ber_len_t bytes )
-
-void * ber_memcalloc( ber_len_t nelems, ber_len_t bytes )
-
-void * ber_memrealloc( void *ptr, ber_len_t bytes);
-
-void ber_memfree( void *ptr );
-
-void ber_memvfree( void **vec );
-.ft
-.fi
+.BI "void *ber_memalloc(ber_len_t " bytes ");"
+.LP
+.BI "void *ber_memcalloc(ber_len_t " nelems ", ber_len_t " bytes ");"
+.LP
+.BI "void *ber_memrealloc(void *" ptr ", ber_len_t " bytes ");"
+.LP
+.BI "void ber_memfree(void *" ptr ");"
+.LP
+.BI "void ber_memvfree(void **" vec ");"
 .SH DESCRIPTION
 .LP
 These routines are used to allocate/deallocate memory used/returned
@@ -31,13 +25,28 @@ by the Lightweight BER library as required by
 .BR lber-encode (3)
 and
 .BR lber-decode (3).
+.BR ber_memalloc (),
+.BR ber_memcalloc (),
+.BR ber_memrealloc (),
+and
+.BR ber_memfree ()
+are used exactly like the standard
+.BR malloc (3),
+.BR calloc (3),
+.BR realloc (3),
+and
+.BR free (3)
+routines, respectively.  The
+.BR ber_memvfree ()
+routine is used to free a dynamically allocated array of pointers to
+arbitrary dynamically allocated objects.
 .SH SEE ALSO
-.BR lber-decode (3)
-.BR lber-encode (3)
+.BR lber-decode (3),
+.BR lber-encode (3),
 .BR lber-types (3)
 .LP
 .SH ACKNOWLEDGEMENTS
-.B     OpenLDAP
+.B OpenLDAP
 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
-.B     OpenLDAP
+.B OpenLDAP
 is derived from University of Michigan LDAP 3.3 Release.