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.
  14 Note that each user may specify an optional configuration file,
  15 .IR .ldaprc ,
  16 in his/her home directory which will be used to override system-wide
  17 defaults file.  The user may also provide a local configuration
  18 file
  19 .I ldaprc
  20 which will be used to override per-user and system-wide defaults.
  21 Environmental variables may be used to file based defaults.
  22 .SH OPTIONS
  23 The different configuration options are:
  24 .TP 1i
  25 .TP 1i
  26 \fBBASE <base>\fP
  27 Used to specify the default base dn to use when performing ldap operations.
  28 The base must be specified as a Distinguished Name in LDAP format.
  29 \fBHOST <name[:port] ...>\fP
  30 Used to specify the name(s) of an LDAP server(s) to which
  31 .I ldap
  32 library should connect to.  Each server's name can be specified as a
  33 domain-style name or an IP address and optionally followed a ':' and
  34 the port number the ldap server is listening on.  A space separated
  35 listed of host may be provided.
  36 .TP 1i
  37 \fBPORT <port>\fP
  38 Used to specify the port used with connecting to LDAP servers(s).
  39 The port may be specified as a number.
  40 .TP 1i
  41 \fBSIZELIMIT <integer>\fP
  42 Used to specify a size limit to use when performing searches.  The
  43 number should be an non-negative integer.  \fISIZELIMIT\fP of zero (0)
  44 specifies unlimited search size.
  45 .TP 1i
  46 \fBTIMELIMIT <integer>\fP
  47 Used to specify a time limit to use when performing searches.  The
  48 number should be an non-negative integer.  \fITIMELIMIT\fP of zero (0)
  49 specifies unlimited search time to be used.
  50 .TP 1i
  51 \fBDEREF <never|searching|finding|always>\fP
  52 Specify how aliases dereferencing is done.  \fIDEREF\fP should
  53 be set to one of
  54 .B never,
  55 .B always,
  56 .B search,
  57 or
  58 .B find
  59 to specify that aliases are never dereferenced, always dereferenced,
  60 dereferenced when searching, or dereferenced only when locating the
  61 base object for the search.  The default is to never dereference aliases.
  62 .SH FILES
  63 .I  ETCDIR/ldap.conf
  64 .SH "SEE ALSO"
  65 ldap(3)
  66 .SH AUTHOR
  67 Kurt Zeilenga, The OpenLDAP Project
  68 .SH ACKNOWLEDGEMENTS
  69 .B      OpenLDAP
  70 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
  71 .B      OpenLDAP
  72 is derived from University of Michigan LDAP 3.3 Release.