syncrepl consistency patch: utilize BDB txn rollback

[openldap] / doc / man / man3 / ldap_open.3

diff --git a/doc/man/man3/ldap_open.3 b/doc/man/man3/ldap_open.3
index 7c19bc9b122c23e307a23db07e817b467a75a5fb..293fbbff7ae05564aff0b2cc234c734609ebcab9 100644 (file)
--- a/doc/man/man3/ldap_open.3
+++ b/doc/man/man3/ldap_open.3
@@ -1,10 +1,14 @@
-.TH LDAP_OPEN 3 "22 September 1998" "OpenLDAP LDVERSION"
+.TH LDAP_OPEN 3 "RELEASEDATE" "OpenLDAP LDVERSION"
+.\" $OpenLDAP$
+.\" Copyright 1998-2004 The OpenLDAP Foundation All Rights Reserved.
+.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.

 .SH NAME
 ldap_init, ldap_open \- Initialize the LDAP library and open a connection to an LDAP server
 .SH NAME
 ldap_init, ldap_open \- Initialize the LDAP library and open a connection to an LDAP server

+.SH LIBRARY
+OpenLDAP LDAP (libldap, -lldap)

 .SH SYNOPSIS
 .nf
 .ft B
 .SH SYNOPSIS
 .nf
 .ft B

-#include <lber.h>

 #include <ldap.h>
 .LP
 .ft B
 #include <ldap.h>
 .LP
 .ft B


@@ -66,7 +70,7 @@ for more details.
                char            *ld_matched;
                int             ld_refhoplimit;
                unsigned long   ld_options;
                char            *ld_matched;
                int             ld_refhoplimit;
                unsigned long   ld_options;

-       #define LDAP_OPT_REFERRALS      0x00000002      /* set by default */
+       #define LDAP_OPT_REFERRALS      0x00000002 /* set by default */

        #define LDAP_OPT_RESTART        0x00000004
                /* ... other stuff you should not mess with ... */
        } LDAP;
        #define LDAP_OPT_RESTART        0x00000004
                /* ... other stuff you should not mess with ... */
        } LDAP;


@@ -81,8 +85,8 @@ but does not open a connection
 to the LDAP server.  The actual connection open will occur when the
 first operation is attempted.  At this time,
 .B ldap_init()
 to the LDAP server.  The actual connection open will occur when the
 first operation is attempted.  At this time,
 .B ldap_init()

-should only
-be used if the LDAP library is compiled with LDAP_REFERRALS defined.
+is preferred.  
+.B ldap_open() will be depreciated in a later release.

 .SH ERRORS
 If an error occurs, these routines will return NULL and errno should be
 set appropriately.
 .SH ERRORS
 If an error occurs, these routines will return NULL and errno should be
 set appropriately.


@@ -112,7 +116,7 @@ in the LDAP structure.
 .BR ldap_bind (3),
 .BR errno (3)
 .SH ACKNOWLEDGEMENTS
 .BR ldap_bind (3),
 .BR errno (3)
 .SH ACKNOWLEDGEMENTS

-.B     OpenLDAP
+.B OpenLDAP

 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 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.  
 is derived from University of Michigan LDAP 3.3 Release.