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

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