openldap/doc/man/man5/ud.conf.5

.TH UD.CONF 5 "22 September 1998" "OpenLDAP LDVERSION"
.\" $OpenLDAP$
.\" Copyright 1998-1999 The OpenLDAP Foundation All Rights Reserved.
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
.UC 6
.SH NAME
ud.conf \- ud configuration file
.SH SYNOPSIS
ETCDIR/ud.conf
.SH DESCRIPTION
The
.I ud
configuration file is used to set system-wide defaults to be applied when
running
.IR ud .
Note that each user may specify an optional configuration file,
.IR .udrc ,
in his/her home directory which will be used instead of the system-wide
configuration file.
.SH OPTIONS
The different configuration options are:
.TP 1i
\fBHOST <name>\fP
Used to specify the name of an LDAP server to which 
.I ud 
should connect.  There may be only one entry per config file.
The server's name can be specified as a domain-style name or an IP address.
.TP 1i
\fBBASE <base>\fP
Used to specify the search base to use when performing search operations.
The base may be changed by those using
.I ud
by using the
.I cb
command.
There may be only one entry per config file.
The base must be specified as a Distinguished Name in LDAP format.
.TP 1i
\fBGROUPBASE <base>\fP
Used to specify the base used when creating groups.
The base may be changed by those using
.I ud
by using the 
.I changegroup
command.
There may be only one entry per config file.
The base must be specified as a Distinguished Name in LDAP format.
.TP 1i
\fBSEARCH <algorithm>\fP
Used to specify a search algorithm to use when performing searches.  More than
one algorithm may be specified, and each is tried in turn until a suitable
response is found.

Each algorithm specifies a filter that should be used when performing a find
operation.  Filters contain LDAP-style attribute types (e.g., uid, cn,
postalAddress)
and operators to test for equality or approximate equality.  Prefix operators
may also be used to specify AND, OR and NOT operations (see ldap(3) for
more details on the filter format).  Algorithms use a
compile-time constant as a separator to use when parsing the input the user
has provided.  This parsed input can then be referenced similarly to an
.I awk
program using symbols like $1, $2, and $0 for the entire batch of input.

For example, the algoritm
.I cn=$0
causes
.I ud
to perform a lookup on the entire string the user has typed, searching for 
anything where the commonName exactly matches the whole thing.

Another example,
.I sn~=$NF
causes
.I ud
to do a search where the last element the user has typed (NF = number of fields
and is a special "number" that can be used in
.I awk
as well as
.IR ud )
searching for any matches that approximately match Surname.

Search algorithms also support a special feature which allows one to specify
the 
.I exact
number of fields that must be present in order for the algorithm to be
applied.  This number must be specified between square brackets.

For example,
.I [1] uid=$1
causes this algorithm to be applied when the number of fields is exactly equal
to one.  If there is exactly one field, the token is looked up as a UID.
.SH FILES
.I  ETCDIR/ud.conf
.SH "SEE ALSO"
ud(1),
ldap(3)
.SH AUTHOR
Bryan Beecher, University of Michigan
.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.