From: Kurt Zeilenga Date: Sun, 29 Nov 1998 20:58:40 +0000 (+0000) Subject: Add ldap.conf man page. X-Git-Tag: OPENLDAP_SLAPD_BACK_LDAP~1000 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=ba84e238670894c9d6ca1f6c3858309dc54b487e;p=openldap Add ldap.conf man page. --- diff --git a/doc/man/man5/ldap.conf.5 b/doc/man/man5/ldap.conf.5 new file mode 100644 index 0000000000..26c0781dc6 --- /dev/null +++ b/doc/man/man5/ldap.conf.5 @@ -0,0 +1,72 @@ +.TH LDAP.CONF 5 "29 November 1998" "OpenLDAP LDVERSION" +.UC 6 +.SH NAME +ldap.conf \- ldap configuration file +.SH SYNOPSIS +ETCDIR/ldap.conf +.SH DESCRIPTION +The +.I ldap.conf +configuration file is used to set system-wide defaults to be applied when +running +.I ldap +clients. +Note that each user may specify an optional configuration file, +.IR .ldaprc , +in his/her home directory which will be used to override system-wide +defaults file. The user may also provide a local configuration +file +.I ldaprc +which will be used to override per-user and system-wide defaults. +Environmental variables may be used to file based defaults. +.SH OPTIONS +The different configuration options are: +.TP 1i +.TP 1i +\fBBASE \fP +Used to specify the default base dn to use when performing ldap operations. +The base must be specified as a Distinguished Name in LDAP format. +\fBHOST \fP +Used to specify the name(s) of an LDAP server(s) to which +.I ldap +library should connect to. Each server's name can be specified as a +domain-style name or an IP address and optionally followed a ':' and +the port number the ldap server is listening on. A space separated +listed of host may be provided. +.TP 1i +\fBPORT \fP +Used to specify the port used with connecting to LDAP servers(s). +The port may be specified as a number. +.TP 1i +\fBSIZELIMIT \fP +Used to specify a size limit to use when performing searches. The +number should be an non-negative integer. \fISIZELIMIT\fP of zero (0) +specifies unlimited search size. +.TP 1i +\fBTIMELIMIT \fP +Used to specify a time limit to use when performing searches. The +number should be an non-negative integer. \fITIMELIMIT\fP of zero (0) +specifies unlimited search time to be used. +.TP 1i +\fBDEREF \fP +Specify how aliases dereferencing is done. \fIDEREF\fP should +be set to one of +.B never, +.B always, +.B search, +or +.B find +to specify that aliases are never dereferenced, always dereferenced, +dereferenced when searching, or dereferenced only when locating the +base object for the search. The default is to never dereference aliases. +.SH FILES +.I ETCDIR/ldap.conf +.SH "SEE ALSO" +ldap(3) +.SH AUTHOR +Kurt Zeilenga, The OpenLDAP Project +.SH ACKNOWLEDGEMENTS +.B OpenLDAP +is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). +.B OpenLDAP +is derived from University of Michigan LDAP 3.3 Release.