git.sur5r.net Git - openldap/blob - doc/man/man5/ldap.conf.5

   1 .TH LDAP.CONF 5 "29 November 1998" "OpenLDAP LDVERSION"
   2 .UC 6
   3 .SH NAME
   4 ldap.conf \- ldap configuration file
   5 .SH SYNOPSIS
   6 ETCDIR/ldap.conf
   7 .SH DESCRIPTION
   8 The
   9 .I ldap.conf
  10 configuration file is used to set system-wide defaults to be applied when
  11 running
  12 .I ldap
  13 clients.  If the environment variable \fBLDAPNOINIT\fP is defined, all
  14 defaulting is disabled.
  15 .LP
  16 Each user may specify an optional configuration file,
  17 .IR .ldaprc ,
  18 in his/her home directory which will be used to override the system-wide
  19 defaults file.
  20 .LP
  21 Additional configuration files can be specified using
  22 the \fBLDAPCONF\fP and \fBLDAPRC\fP environment variables.
  23 \fBLDAPCONF\fP may be set the path of a configuration file.  This
  24 path can be absolute or relative to current working directory.
  25 The \fBLDAPRC\fP, if defined, should be a basename of a file
  26 in the current working directory or in the user's home directory.
  27 .LP
  28 Environmental variables may also be used to augment the file based defaults.
  29 The name of the option is the as listed but with a prefix of \fBLDAP\fP.
  30 For example, to define \fBBASE\fP via the environment, define the variable
  31 \fBLDAPBASE\fP to desired value.
  32 .SH OPTIONS
  33 The different configuration options are:
  34 .TP 1i
  35 \fBBASE <base>\fP
  36 Used to specify the default base dn to use when performing ldap operations.
  37 The base must be specified as a Distinguished Name in LDAP format.
  38 .TP 1i
  39 \fBHOST <name[:port] ...>\fP
  40 Used to specify the name(s) of an LDAP server(s) to which
  41 .I ldap
  42 library should connect to.  Each server's name can be specified as a
  43 domain-style name or an IP address and optionally followed a ':' and
  44 the port number the ldap server is listening on.  A space separated
  45 listed of host may be provided.
  46 .TP 1i
  47 \fBPORT <port>\fP
  48 Used to specify the port used with connecting to LDAP servers(s).
  49 The port may be specified as a number.
  50 .TP 1i
  51 \fBSIZELIMIT <integer>\fP
  52 Used to specify a size limit to use when performing searches.  The
  53 number should be an non-negative integer.  \fISIZELIMIT\fP of zero (0)
  54 specifies unlimited search size.
  55 .TP 1i
  56 \fBTIMELIMIT <integer>\fP
  57 Used to specify a time limit to use when performing searches.  The
  58 number should be an non-negative integer.  \fITIMELIMIT\fP of zero (0)
  59 specifies unlimited search time to be used.
  60 .TP 1i
  61 \fBDEREF <never|searching|finding|always>\fP
  62 Specify how aliases dereferencing is done.  \fIDEREF\fP should
  63 be set to one of
  64 .B never,
  65 .B always,
  66 .B search,
  67 or
  68 .B find
  69 to specify that aliases are never dereferenced, always dereferenced,
  70 dereferenced when searching, or dereferenced only when locating the
  71 base object for the search.  The default is to never dereference aliases.
  72 .SH FILES
  73 .I  ETCDIR/ldap.conf
  74 .LP
  75 .I  $HOME/.ldaprc
  76 .LP
  77 .I  $CWD/.ldaprc
  78 .SH "SEE ALSO"
  79 ldap(3)
  80 .SH AUTHOR
  81 Kurt Zeilenga, The OpenLDAP Project
  82 .SH ACKNOWLEDGEMENTS
  83 .B      OpenLDAP
  84 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
  85 .B      OpenLDAP
  86 is derived from University of Michigan LDAP 3.3 Release.