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 .LP
  36 Some options are user\-only.  Such options are ignored if present
  37 in the
  38 .IR ldap.conf
  39 (or file specified by
  40 .BR LDAPCONF ).
  41 .SH OPTIONS
  42 The different configuration options are:
  43 .TP 1i
  44 \fBBASE <base>\fP
  45 Used to specify the default base DN to use when performing ldap operations.
  46 The base must be specified as a Distinguished Name in LDAP format.
  47 .TP 1i
  48 \fBBINDDN <dn>\fP
  49 Used to specify the default bind DN to use when performing ldap operations.
  50 The bind DN must be specified as a Distinguished Name in LDAP format.
  51 This is a user\-only option.
  52 .TP 1i
  53 \fBHOST <name[:port] ...>\fP
  54 Used to specify the name(s) of an LDAP server(s) to which
  55 .I ldap
  56 library should connect to.  Each server's name can be specified as a
  57 domain-style name or an IP address and optionally followed a ':' and
  58 the port number the ldap server is listening on.  A space separated
  59 listed of host may be provided.
  60 .TP 1i
  61 \fBPORT <port>\fP
  62 Used to specify the port used with connecting to LDAP servers(s).
  63 The port may be specified as a number.
  64 .TP 1i
  65 \fBSIZELIMIT <integer>\fP
  66 Used to specify a size limit to use when performing searches.  The
  67 number should be an non-negative integer.  \fISIZELIMIT\fP of zero (0)
  68 specifies unlimited search size.
  69 .TP 1i
  70 \fBTIMELIMIT <integer>\fP
  71 Used to specify a time limit to use when performing searches.  The
  72 number should be an non-negative integer.  \fITIMELIMIT\fP of zero (0)
  73 specifies unlimited search time to be used.
  74 .TP 1i
  75 \fBDEREF <never|searching|finding|always>\fP
  76 Specify how aliases dereferencing is done.  \fIDEREF\fP should
  77 be set to one of
  78 .B never,
  79 .B always,
  80 .B search,
  81 or
  82 .B find
  83 to specify that aliases are never dereferenced, always dereferenced,
  84 dereferenced when searching, or dereferenced only when locating the
  85 base object for the search.  The default is to never dereference aliases.
  86 .SH FILES
  87 .I  ETCDIR/ldap.conf
  88 .LP
  89 .I  $HOME/.ldaprc
  90 .LP
  91 .I  $CWD/.ldaprc
  92 .SH "SEE ALSO"
  93 ldap(3)
  94 .SH AUTHOR
  95 Kurt Zeilenga, The OpenLDAP Project
  96 .SH ACKNOWLEDGEMENTS
  97 .B      OpenLDAP
  98 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
  99 .B      OpenLDAP
 100 is derived from University of Michigan LDAP 3.3 Release.