From: Kurt Zeilenga <kurt@openldap.org>
Date: Thu, 13 Jul 2000 22:56:16 +0000 (+0000)
Subject: Add basic pages for BER types and memory allocators.
X-Git-Tag: LDBM_PRE_GIANT_RWLOCK~2453
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=19e45aee801c3408ecbdb392b313a85654d20786;p=openldap

Add basic pages for BER types and memory allocators.
---

diff --git a/doc/man/man3/lber-decode.3 b/doc/man/man3/lber-decode.3
index 70b260f2a3..a954896f12 100644
--- a/doc/man/man3/lber-decode.3
+++ b/doc/man/man3/lber-decode.3
@@ -1,4 +1,4 @@
-.TH LBER_DECODE 3 "12 May 2000" "OpenLDAP LDVERSION"
+.TH LBER_DECODE 3 "12 July 2000" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
 .\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
@@ -349,20 +349,13 @@ Some routines may dynamically allocate memory
 which must be freed by the caller using supplied deallocation routines.
 .SH SEE ALSO
 .BR lber-encode (3)
+.BR lber-memory (3)
 .BR lber-types (3)
 .BR ldap-parse (3)
 .BR ldap-sync (3)
 .BR ldap-async (3)
-.LP
-Yeong, W., Howes, T., and Hardcastle-Kille, S.,
-"Lightweight Directory Access Protocol", OSI-DS-26, April 1992.
-.LP
-Information Processing - Open Systems Interconnection - Model and Notation -
-Service Definition - Specification of Basic Encoding Rules for Abstract
-Syntax Notation One, International Organization for Standardization,
-International Standard 8825.
 .SH AUTHOR
-Tim Howes, University of Michigan
+The OpenLDAP Project <http://www.openldap.org/>
 .SH ACKNOWLEDGEMENTS
 .B	OpenLDAP
 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
diff --git a/doc/man/man3/lber-encode.3 b/doc/man/man3/lber-encode.3
index 9d5fbb980d..0fec605a7c 100644
--- a/doc/man/man3/lber-encode.3
+++ b/doc/man/man3/lber-encode.3
@@ -317,20 +317,13 @@ The return values for all of these functions are declared in the
 <lber.h> header file.
 .SH SEE ALSO
 .BR lber-decode (3)
+.BR lber-memory (3)
 .BR lber-types (3)
 .BR ldap-async (3)
 .BR ldap-sync (3)
 .BR ldap-parse (3)
-.LP
-Yeong, W., Howes, T., and Hardcastle-Kille, S.,
-"Lightweight Directory Access Protocol", OSI-DS-26, April 1992.
-.LP
-Information Processing - Open Systems Interconnection - Model and Notation -
-Service Definition - Specification of Basic Encoding Rules for Abstract
-Syntax Notation One, International Organization for Standardization,
-International Standard 8825.
 .SH AUTHOR
-Tim Howes, University of Michigan
+The OpenLDAP Project <http://www.openldap.org/>
 .SH ACKNOWLEDGEMENTS
 .B	OpenLDAP
 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
diff --git a/doc/man/man3/lber-memory.3 b/doc/man/man3/lber-memory.3
new file mode 100644
index 0000000000..99547ba677
--- /dev/null
+++ b/doc/man/man3/lber-memory.3
@@ -0,0 +1,60 @@
+.TH LBER_MEMORY 3 "12 July 2000" "OpenLDAP LDVERSION"
+.\" $OpenLDAP$
+.\" Copyright 1998-2000 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
+.SH SYNOPSIS
+.nf
+.ft B
+#include <lber.h>
+.ft
+.fi
+.LP
+.nf
+.ft B
+void * ber_memalloc(
+	ber_len_t bytes )
+.ft
+.fi
+.LP
+.nf
+.ft B
+void * ber_memcalloc(
+	ber_len_t nelems, ber_len_t bytes )
+.ft
+.fi
+.LP
+.nf
+.ft B
+void * ber_memrealloc(
+	void \(**ptr,
+	ber_len_t bytes);
+.ft
+.fi
+.LP
+.nf
+.ft B
+void * ber_memfree(
+	void \(**ptr );
+.ft
+.fi
+.SH DESCRIPTION
+.LP
+These routines are used to allocate/deallocate memory used/returned
+by the Lightweight BER library as required by
+.BR lber-encode (3)
+and
+.BR lber-decode (3).
+.SH SEE ALSO
+.BR lber-decode (3)
+.BR lber-encode (3)
+.BR lber-types (3)
+.LP
+.SH AUTHOR
+The OpenLDAP Project <http://www.openldap.org/>
+.SH ACKNOWLEDGEMENTS
+.B	OpenLDAP
+is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
+.B	OpenLDAP
+is derived from University of Michigan LDAP 3.3 Release.  
diff --git a/doc/man/man3/lber-types.3 b/doc/man/man3/lber-types.3
new file mode 100644
index 0000000000..7144a8f29f
--- /dev/null
+++ b/doc/man/man3/lber-types.3
@@ -0,0 +1,47 @@
+.TH LBER_TYPES 3 "12 July 2000" "OpenLDAP LDVERSION"
+.\" $OpenLDAP$
+.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
+.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
+.SH NAME
+ber_int_t, ber_len_t, ber_tag_t \- LBER types
+.SH SYNOPSIS
+.nf
+.ft B
+#include <lber.h>
+.ft
+.fi
+.LP
+.nf
+.ft B
+typedef impl_int_t ber_int_t;
+typedef impl_len_t ber_len_t;
+typedef impl_tag_t ber_tag_t;
+.ft
+.fi
+.SH DESCRIPTION
+.LP
+The are basic types defined for use with the Lightweight BER library.
+.LP
+.B ber_int_t
+is a signed integer of at least 32 bits.
+.LP
+.B ber_len_t
+is a unsigned integer of at least 32 bits used to represent a length.  
+It is commonly equivalent to a
+.BR size_t .
+.LP
+.B ber_len_t
+is a unsigned integer of at least 32 bits used to represent a
+BER tag.  It is commonly equivalent to a
+.BR unsigned\ long .
+.SH SEE ALSO
+.BR lber-encode (3)
+.BR lber-decode (3)
+.LP
+.SH AUTHOR
+The OpenLDAP Project <http://www.openldap.org/>
+.SH ACKNOWLEDGEMENTS
+.B	OpenLDAP
+is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
+.B	OpenLDAP
+is derived from University of Michigan LDAP 3.3 Release.