Penguin
Recent Changes
Blame: ldapsearchprefs.conf(5)
EditPageHistoryDiffInfoLikePages
Annotated edit history of ldapsearchprefs.conf(5) version 4, including all changes. View license author blame.
Rev Author # Line
1 perry 1 LDAPSEARCHPREFS.CONF
2 !!!LDAPSEARCHPREFS.CONF
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 EXAMPLE
7 FILES
8 SEE ALSO
9 ACKNOWLEDGEMENTS
10 ----
11 !!NAME
12
13
14 ldapsearchprefs.conf - configuration file for LDAP search preference routines
15 !!SYNOPSIS
16
17
18 /etc/ldap/ldapsearchprefs.conf
19 !!DESCRIPTION
20
21
22 The file /etc/ldap/ldapsearchprefs.conf contains information
23 used by the LDAP search preference routines (see
24 ldap-searchpref(3)). Blank lines and lines that have a first
25 character of `#' are treated as comments and ignored.
26 Non-comment lines contain one or more tokens. Tokens are
27 separated by white space, and double quotes `
28
29
30 Search preferences are typically used by LDAP-based client
31 programs to specify what a user may search for, which
32 attributes are searched, and which options are available to
33 the user.
34
35
36 The first non-commment line specifies the version of the
37 template information and must contain the token
38 ''Version'' followed by an integer version number.
39 E.g.,
40
41
42 __ Version 1
43 __The current version is ''1,'' so the above example is always the correct opening line.
44
45
46 The remainder of the file consists of one or more search
47 preference configurations. The first line of a search
48 preference is a human-readable name for the type of object
49 being searched for, e.g.
50 so_objtypeprompt'' member of the ''ldap_searchobj''
51 structure. E.g.,
52
53
54 __
55 __specifies a label for a search preference designed to find X.500 entries for People.
56
57
58 The next line specifies a list of options for this search
59 object. The only option currently allowed is
60 so_options'' member of the
61 ''ldap_searchobj'' structure and can be tested using the
62 LDAP_IS_SEARCHOBJ_OPTION_SET() macro. Use
63 ''
64
65
66 The next line specifes a label to use for
67
68
69 For example:
70
71
72 __
73 __can be used by LDAP client programs to label the field into which the user can type a so_prompt'' member of the ''ldap_searchobj'' structure.
74
75
76 The next line specifies an LDAP filter prefix to append to
77 all
78
79
80 __
81 __would cause only entries containing the object class so_filterprefix'' member of the ''ldap_searchobj'' structure.
82
83
84 The next line is an LDAP filter tag (see ldap-filter(3))
85 which specifies the set of LDAP filters to be applied for
86
87
88 __
89 __would tell the client program to use the set of LDAP filters from the ldap filter configuration file tagged so_filtertag'' member of the ''ldap_searchobj'' structure.
90
91
92 The next line specifies an LDAP attribute to retrieve to
93 help the user choose when several entries match the search
94 terms specified. For example:
95
96
97 __
98 __specifies that if more than one entry matches the search criteria, the client program should retrieve the
99
100
101 __
102 __The above information is stored in the ''so_defaultselectattr'' and ''so_defaultselecttext'' members of the ''ldap_searchobj'' structure. Note that these are defaults, and are intended to be overridden by the sa_selectattr and sa_selecttext fields of the ldap_searchattr data structure (see below).
103
104
105 The next line specifies the scope of the LDAP search to be
106 performed. Acceptable values are subtree, onelevel, and
107 base. See ldap(3) for more information.
108
109
110 The next section is a list of
111
112
113 __
114 __Each line represents one method of searching. In this example, there are three ways of searching - by Common Name, by Surname, and by Business Phone number. The first field is the text which should be displayed to user. The second field is the attribute which will be searched. The third field is a bitmap which specifies which of the match types (discussed below) are permitted for this search type. A
115
116
117 The next section is a list of search match options,
118 terminated by a a line containing only the string
119
120
121 __
122 __In this example, there are five ways of refining the search. For each method, there is an LDAP filter suffix which is appended to the ldap filter thus far constructed. The routine ldap_build_filter() may be used to construct the whole filter. It substitutes the appropriate attribute for
123 !!EXAMPLE
124
125
126 The following example illustrates one possible configuration
127 of search preferences for
128
129
130 # Version number
131 Version 1
132 # Name for this search object
133 People
134 # Label to place before text box user types in
135 In this example, the user may search for People. For
136 !!FILES
137
138
139 /etc/ldap/ldapsearchprefs.conf
140 !!SEE ALSO
141
142
4 perry 143 ldap(3). ldap-searchprefs(3)
1 perry 144 !!ACKNOWLEDGEMENTS
145
146
147 __OpenLDAP__ is developed and maintained by The OpenLDAP
148 Project (http://www.openldap.org/). __OpenLDAP__ is
149 derived from University of Michigan LDAP 3.3
150 Release.
151 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.