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