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

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