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

   1 .TH UD.CONF 5 "22 September 1998" "OpenLDAP LDVERSION"
   2 .UC 6
   3 .SH NAME
   4 ud.conf \- ud configuration file
   5 .SH SYNOPSIS
   6 ETCDIR/ud.conf
   7 .SH DESCRIPTION
   8 The
   9 .I ud
  10 configuration file is used to set system-wide defaults to be applied when
  11 running
  12 .IR ud .
  13 Note that each user may specify an optional configuration file,
  14 .IR .udrc ,
  15 in his/her home directory which will be used instead of the system-wide
  16 configuration file.
  17 .SH OPTIONS
  18 The different configuration options are:
  19 .TP 1i
  20 \fBHOST <name>\fP
  21 Used to specify the name of an LDAP server to which
  22 .I ud
  23 should connect.  There may be only one entry per config file.
  24 The server's name can be specified as a domain-style name or an IP address.
  25 .TP 1i
  26 \fBBASE <base>\fP
  27 Used to specify the search base to use when performing search operations.
  28 The base may be changed by those using
  29 .I ud
  30 by using the
  31 .I cb
  32 command.
  33 There may be only one entry per config file.
  34 The base must be specified as a Distinguished Name in LDAP format.
  35 .TP 1i
  36 \fBGROUPBASE <base>\fP
  37 Used to specify the base used when creating groups.
  38 The base may be changed by those using
  39 .I ud
  40 by using the
  41 .I changegroup
  42 command.
  43 There may be only one entry per config file.
  44 The base must be specified as a Distinguished Name in LDAP format.
  45 .TP 1i
  46 \fBSEARCH <algorithm>\fP
  47 Used to specify a search algorithm to use when performing searches.  More than
  48 one algorithm may be specified, and each is tried in turn until a suitable
  49 response is found.
  50
  51 Each algorithm specifies a filter that should be used when performing a find
  52 operation.  Filters contain LDAP-style attribute types (e.g., uid, cn,
  53 postalAddress)
  54 and operators to test for equality or approximate equality.  Prefix operators
  55 may also be used to specify AND, OR and NOT operations (see ldap(3) for
  56 more details on the filter format).  Algorithms use a
  57 compile-time constant as a separator to use when parsing the input the user
  58 has provided.  This parsed input can then be referenced similarly to an
  59 .I awk
  60 program using symbols like $1, $2, and $0 for the entire batch of input.
  61
  62 For example, the algoritm
  63 .I cn=$0
  64 causes
  65 .I ud
  66 to perform a lookup on the entire string the user has typed, searching for
  67 anything where the commonName exactly matches the whole thing.
  68
  69 Another example,
  70 .I sn~=$NF
  71 causes
  72 .I ud
  73 to do a search where the last element the user has typed (NF = number of fields
  74 and is a special "number" that can be used in
  75 .I awk
  76 as well as
  77 .IR ud )
  78 searching for any matches that approximately match Surname.
  79
  80 Search algorithms also support a special feature which allows one to specify
  81 the
  82 .I exact
  83 number of fields that must be present in order for the algorithm to be
  84 applied.  This number must be specified between square brackets.
  85
  86 For example,
  87 .I [1] uid=$1
  88 causes this algorithm to be applied when the number of fields is exactly equal
  89 to one.  If there is exactly one field, the token is looked up as a UID.
  90 .SH FILES
  91 .I  ETCDIR/ud.conf
  92 .SH "SEE ALSO"
  93 ud(1),
  94 ldap(3)
  95 .SH AUTHOR
  96 Bryan Beecher, University of Michigan
  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.