Move extern schema_init_done outside of #ifdef SLAPD_SCHEMA_NOT_COMPAT

[openldap] / doc / man / man5 / ldap.conf.5

diff --git a/doc/man/man5/ldap.conf.5 b/doc/man/man5/ldap.conf.5
index 26c0781dc67d87d81935bf8641af193e3d77cb21..1e9e5266e9345e2c7ecda4094f4d1b262f8956f2 100644 (file)
--- a/doc/man/man5/ldap.conf.5
+++ b/doc/man/man5/ldap.conf.5
@@ -1,31 +1,56 @@
 .TH LDAP.CONF 5 "29 November 1998" "OpenLDAP LDVERSION"
+.\" $OpenLDAP$
+.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
+.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .UC 6
 .SH NAME
-ldap.conf \- ldap configuration file
+ldap.conf, .ldaprc \- ldap configuration file
 .SH SYNOPSIS
 ETCDIR/ldap.conf
+\fP.ldaprc\fP
 .SH DESCRIPTION
 The
 .I ldap.conf
 configuration file is used to set system-wide defaults to be applied when
 running
 .I ldap
-clients.
-Note that each user may specify an optional configuration file,
+clients.  If the environment variable \fBLDAPNOINIT\fP is defined, all
+defaulting is disabled.
+.LP
+Each user may specify an optional configuration file,
 .IR .ldaprc ,
-in his/her home directory which will be used to override system-wide
-defaults file.  The user may also provide a local configuration
-file
-.I ldaprc
-which will be used to override per-user and system-wide defaults.
-Environmental variables may be used to file based defaults.
+in his/her home directory which will be used to override the system-wide
+defaults file.
+.LP
+Additional configuration files can be specified using
+the \fBLDAPCONF\fP and \fBLDAPRC\fP environment variables.
+\fBLDAPCONF\fP may be set the path of a configuration file.  This
+path can be absolute or relative to current working directory.
+The \fBLDAPRC\fP, if defined, should be a basename of a file
+in the current working directory or in the user's home directory.
+.LP
+Environmental variables may also be used to augment the file based defaults.
+The name of the option is the as listed but with a prefix of \fBLDAP\fP.
+For example, to define \fBBASE\fP via the environment, define the variable
+\fBLDAPBASE\fP to desired value.
+.LP
+Some options are user\-only.  Such options are ignored if present
+in the
+.IR ldap.conf
+(or file specified by
+.BR LDAPCONF ).
 .SH OPTIONS
 The different configuration options are:
 .TP 1i
-.TP 1i
 \fBBASE <base>\fP
-Used to specify the default base dn to use when performing ldap operations.
+Used to specify the default base DN to use when performing ldap operations.
 The base must be specified as a Distinguished Name in LDAP format.
+.TP 1i
+\fBBINDDN <dn>\fP
+Used to specify the default bind DN to use when performing ldap operations.
+The bind DN must be specified as a Distinguished Name in LDAP format.
+This is a user\-only option.
+.TP 1i
 \fBHOST <name[:port] ...>\fP
 Used to specify the name(s) of an LDAP server(s) to which 
 .I ldap 
@@ -61,6 +86,10 @@ dereferenced when searching, or dereferenced only when locating the
 base object for the search.  The default is to never dereference aliases.
 .SH FILES
 .I  ETCDIR/ldap.conf
+.LP
+.I  $HOME/.ldaprc
+.LP
+.I  $CWD/.ldaprc
 .SH "SEE ALSO"
 ldap(3)
 .SH AUTHOR