ITS#5189 add note about db_stat and slapd needing to be run when using quick mode.

[openldap] / doc / man / man3 / lber-decode.3

diff --git a/doc/man/man3/lber-decode.3 b/doc/man/man3/lber-decode.3
index 5e9d28047cde4767daee274bffb078abac7ec987..e2644c561c226354cba1c113990c3a195557a72d 100644 (file)
--- a/doc/man/man3/lber-decode.3
+++ b/doc/man/man3/lber-decode.3
@@ -1,13 +1,11 @@
-.TH LBER_DECODE 3 "19 January 2002" "OpenLDAP LDVERSION"
+.TH LBER_DECODE 3 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
-.\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
-ber_get_next, ber_skip_tag, ber_peek_tag, ber_scanf, ber_get_int,
-ber_get_enum, ber_get_stringb, ber_get_stringa, ber_get_stringal,
-ber_get_stringbv, ber_get_null, ber_get_boolean, ber_get_bitstring,
-ber_first_element, ber_next_element
-\- LBER simplified Basic Encoding Rules library routines for decoding
+ber_get_next, ber_skip_tag, ber_peek_tag, ber_scanf, ber_get_int, ber_get_enum, ber_get_stringb, ber_get_stringa, ber_get_stringal, ber_get_stringbv, ber_get_null, ber_get_boolean, ber_get_bitstring, ber_first_element, ber_next_element \- OpenLDAP LBER simplified Basic Encoding Rules library routines for decoding
+.SH LIBRARY
+OpenLDAP LBER (liblber, -llber)
 .SH SYNOPSIS
 .B #include <lber.h>
 .LP
@@ -76,7 +74,9 @@ routine is used to read the next BER element from the given Sockbuf,
 returns the length of the entire element in \fIlen\fP, and sets up
 \fIber\fP for subsequent calls to 
 .BR ber_scanf ()
-et al to decode the element.
+et al to decode the element. See
+.BR lber-sockbuf (3)
+for details of the Sockbuf implementation of the \fIsb\fP parameter.
 .LP
 The
 .BR ber_scanf ()
@@ -100,6 +100,14 @@ returned in the parameter.  The caller should free the returned
 string using
 .BR ber_memfree ().
 .TP
+.B A
+Octet string.  A variant of "\fBa\fP".  A char ** should be supplied.
+Memory is allocated, filled with the contents of the octet string, 
+null-terminated, and returned in the parameter, unless a zero-length
+string would result; in that case, the arg is set to NULL.
+The caller should free the returned string using
+.BR ber_memfree ().
+.TP
 .B s
 Octet string.  A char * buffer should be supplied, followed by a pointer to a
 ber_len_t initialized to the size of the buffer.  Upon return, the
@@ -332,7 +340,7 @@ as follows.
 .fi
 .SH ERRORS
 If an error occurs during decoding, generally these routines return
-LBER_ERROR (\-1).
+LBER_ERROR ((ber_tag_t)\-1).
 .LP
 .SH NOTES
 .LP
@@ -341,11 +349,9 @@ The return values for all of these functions are declared in the
 header file.  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-encode (3),
+.BR lber-memory (3),
+.BR lber-sockbuf (3),
 .BR lber-types (3)
 .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.  
+.so ../Project