Print this page
9842 man page typos and spelling
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man4/ldapsearchprefs.conf.4.man.txt
+++ new/usr/src/man/man4/ldapsearchprefs.conf.4.man.txt
1 1 LDAPSEARCHPREFS.CONF(4) File Formats and Configurations
2 2
3 3
4 4
5 5 NAME
6 6 ldapsearchprefs.conf - configuration file for LDAP search preference
7 7 routines
8 8
9 9 SYNOPSIS
10 10 /etc/opt/SUNWconn/ldap/current/ldapsearchprefs.conf
11 11
12 12
13 13 DESCRIPTION
14 14 The ldapsearchprefs.conf file contains information used by LDAP when
15 15 searching the directory. Blank lines and lines that start with a hash
|
↓ open down ↓ |
15 lines elided |
↑ open up ↑ |
16 16 ('#') character are treated as comments and ignored. Non-comment lines
17 17 contain one or more tokens. Tokens are separated by white space, and
18 18 double quotes can be used to include white space inside a token.
19 19
20 20
21 21 Search preferences are typically used by LDAP-based client programs to
22 22 specify what a user may search for, which attributes are searched, and
23 23 which options are available to the user.
24 24
25 25
26 - The first non-commment line specifies the version of the template
26 + The first non-comment line specifies the version of the template
27 27 information and must contain the token Version followed by an integer
28 28 version number. For example:
29 29
30 30 Version 1
31 31
32 32
33 33
34 34
35 35 The current version is 1, so the above example is always the correct
36 36 opening line.
37 37
38 38
39 39 The remainder of the file consists of one or more search preference
40 40 configurations. The first line of a search preference is a human-
41 41 readable name for the type of object being searched for, for example
42 42 People or Organizations. This name is stored in the so_objtypeprompt
43 43 member of the ldap_searchobj structure (see ldap_searchprefs(3LDAP)).
44 44 For example:
45 45
46 46 People
47 47
48 48
49 49
50 50
51 51 specifies a label for a search preference designed to find X.500
52 52 entries for people.
53 53
54 54
55 55 The next line specifies a list of options for this search object. The
56 56 only option currently allowed is "internal" which means that this
57 57 search object should not be presented directly to a user. Options are
58 58 placed in the so_options member of the ldap_searchobj structure and can
59 59 be tested using the LDAP_IS_SEARCHOBJ_OPTION_SET() macro. Use "" if no
60 60 special options are required.
61 61
62 62
63 63 The next line specifies a label to use for "Fewer Choices" searches.
64 64 "Fewer Choices" searches are those where the user's input is fed to the
65 65 ldap_filter routines to determine an appropriate filter to use. This
66 66 contrasts with explicitly-constructed LDAP filters, or "More Choices"
67 67 searches, where the user can explicitly construct an LDAP filter.
68 68
69 69
70 70 For example:
71 71
72 72 "Search For:"
73 73
74 74
75 75
76 76
77 77 can be used by LDAP client programs to label the field into which the
78 78 user can type a "Fewer Choices" search.
79 79
80 80
81 81 The next line specifies an LDAP filter prefix to append to all "More
82 82 Choices" searched. This is typically used to limit the types of entries
83 83 returned to those containing a specific object class. For example:
84 84
85 85 "(&(objectClass=person)"
86 86
87 87
88 88
89 89
90 90 would cause only entries containing the object class person to be
91 91 returned by a search. Note that parentheses may be unbalanced here,
92 92 since this is a filter prefix, not an entire filter.
93 93
94 94
95 95 The next line is an LDAP filter tag which specifies the set of LDAP
96 96 filters to be applied for "Fewer Choices" searching. The line
97 97
98 98 "x500-People"
99 99
100 100
101 101
102 102
103 103 would tell the client program to use the set of LDAP filters from the
104 104 ldap filter configuration file tagged "x500-People".
105 105
106 106
107 107 The next line specifies an LDAP attribute to retrieve to help the user
108 108 choose when several entries match the search terms specified. For
109 109 example:
110 110
111 111 "title"
112 112
113 113
114 114
115 115
116 116 specifies that if more than one entry matches the search criteria, the
117 117 client program should retrieve the title attribute that and present
118 118 that to the user to allow them to select the appropriate entry. The
119 119 next line specifies a label for the above attribute, for example,
120 120
121 121 "Title:"
122 122
123 123
124 124
125 125
126 126 Note that the values defined so far in the file are defaults, and are
127 127 intended to be overridden by the specific search options that follow.
128 128
129 129
130 130 The next line specifies the scope of the LDAP search to be performed.
131 131 Acceptable values are subtree, onelevel, and base.
132 132
133 133
134 134 The next section is a list of "More Choices" search options, terminated
135 135 by a line containing only the string END. For example:
136 136
137 137 "Common Name" cn 11111 "" ""
138 138 "Surname" sn 11111 "" ""
139 139 "Business Phone" "telephoneNumber" 11101 "" ""
140 140 END
141 141
142 142
143 143
144 144
145 145 Each line represents one method of searching. In this example, there
146 146 are three ways of searching - by Common Name, by Surname, and by
147 147 Business Phone number. The first field is the text which should be
148 148 displayed to user. The second field is the attribute which will be
149 149 searched. The third field is a bitmap which specifies which of the
150 150 match types are permitted for this search type. A "1" value in a given
151 151 bit position indicates that a particular match type is valid, and a "0"
152 152 indicates that is it not valid. The fourth and fifth fields are,
153 153 respectively, the select attribute name and on-screen name for the
154 154 selected attribute. These values are intended to override the defaults
155 155 defined above. If no specific values are specified, the client software
156 156 uses the default values above.
157 157
158 158
159 159 The next section is a list of search match options, terminated by a a
160 160 line containing only the string END. Example:
161 161
162 162 "exactly matches" "(%a=%v))"
163 163 "approximately matches" "(%a~=%v))"
164 164 "starts with" "(%a=%v*))"
165 165 "ends with" "(%a=*%v))"
166 166 "contains" "(%a=*%v*))"
167 167 END
168 168
169 169
170 170
171 171
172 172 In this example, there are five ways of refining the search. For each
173 173 method, there is an LDAP filter suffix which is appended to the ldap
174 174 filter.
175 175
176 176 EXAMPLES
177 177 Example 1 A Sample Configuration Using Search Preference for "people"
178 178
179 179
180 180 The following example illustrates one possible configuration of search
181 181 preferences for "people".
182 182
183 183
184 184 # Version number
185 185 Version 1
186 186 # Name for this search object
187 187 People
188 188 # Label to place before text box user types in
189 189 "Search For:"
190 190 # Filter prefix to append to all "More Choices" searches
191 191 "(&(objectClass=person)"
192 192 # Tag to use for "Fewer Choices" searches - from ldapfilter.conf file
193 193 "x500-People"
194 194 # If a search results in > 1 match, retrieve this attribute to help
195 195 # user distinguish between the entries...
196 196 multilineDescription
197 197 # ...and label it with this string:
198 198 "Description"
199 199 # Search scope to use when searching
200 200 subtree
201 201 # Follows a list of "More Choices" search options. Format is:
202 202 # Label, attribute, select-bitmap, extra attr display name, extra attr ldap name
203 203 # If last two are null, "Fewer Choices" name/attributes used
204 204 "Common Name" cn 11111 "" ""
205 205 "Surname" sn 11111 "" ""
206 206 "Business Phone" "telephoneNumber" 11101 "" ""
207 207 "E-Mail Address" "mail" 11111 "" ""
208 208 "Uniqname" "uid" 11111 "" ""
209 209 END
210 210 # Match types
211 211 "exactly matches" "(%a=%v))"
212 212 "approximately matches" "(%a~=%v))"
213 213 "starts with" "(%a=%v*))"
214 214 "ends with" "(%a=*%v))"
215 215 "contains" "(%a=*%v*))"
216 216 END
217 217
218 218
219 219
220 220 In this example, the user may search for People. For "fewer choices"
221 221 searching, the tag for the ldapfilter.conf(4) file is "x500-People".
222 222
223 223 ATTRIBUTES
224 224 See attributes(5) for a description of the following attributes:
225 225
226 226
227 227
228 228
229 229 +----------------+-----------------+
230 230 |ATTRIBUTE TYPE | ATTRIBUTE VALUE |
231 231 |Stability Level | Evolving |
232 232 +----------------+-----------------+
233 233
234 234 SEE ALSO
235 235 ldap_searchprefs(3LDAP), attributes(5)
236 236
237 237
238 238
239 239 November 26, 2017 LDAPSEARCHPREFS.CONF(4)
|
↓ open down ↓ |
203 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX