Print this page
9842 man page typos and spelling
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man4/ldaptemplates.conf.4
+++ new/usr/src/man/man4/ldaptemplates.conf.4
1 1 '\" te
2 2 .\" Copyright (C) 1990, Regents of the University of Michigan. All Rights Reserved.
3 3 .\" Portions Copyright (C) 1997, Sun Microsystems, Inc. All Rights Reserved.
4 4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
5 5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
6 6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
|
↓ open down ↓ |
6 lines elided |
↑ open up ↑ |
7 7 .TH LDAPTEMPLATES.CONF 4 "Jul 9, 2003"
8 8 .SH NAME
9 9 ldaptemplates.conf \- configuration file for LDAP display template routines
10 10 .SH SYNOPSIS
11 11 .LP
12 12 .nf
13 13 \fB/etc/opt/SUNWconn/ldap/current/ldaptemplates.conf\fR
14 14 .fi
15 15
16 16 .SH DESCRIPTION
17 -.sp
18 17 .LP
19 18 The \fBldaptemplates.conf\fR file contains information used by the LDAP display
20 19 routines.
21 20 .sp
22 21 .LP
23 22 Blank lines and lines that start with a hash character ('#') are treated as
24 23 comments and ignored. Non-comment lines contain one or more tokens. Tokens are
25 24 separated by white space, and double quotes can be used to include white space
26 25 inside a token.
27 26 .sp
28 27 .LP
29 -The first non-commment line specifies the version of the template information
28 +The first non-comment line specifies the version of the template information
30 29 and must contain the token \fBVersion\fR followed by an integer version number.
31 30 For example,
32 31 .sp
33 32 .in +2
34 33 .nf
35 34 Version 1
36 35 .fi
37 36 .in -2
38 37 .sp
39 38
40 39 .sp
41 40 .LP
42 41 The current version is \fI1\fR, so the above example is always the correct
43 42 first line.
44 43 .sp
45 44 .LP
46 45 The remainder of the file consists of one or more display templates. The first
47 46 two lines of the display template each contain a single token that specifies
48 47 singular and plural names for the template in a user-friendly format. For
49 48 example,
50 49 .sp
51 50 .in +2
52 51 .nf
53 52 "Person"
54 53 "People"
55 54 .fi
56 55 .in -2
57 56 .sp
58 57
59 58 .sp
60 59 .LP
61 60 specifies appropriate names for a template designed to display person
62 61 information.
63 62 .sp
64 63 .LP
65 64 The next line specifies the name of the icon or similar element that is
66 65 associated with this template. For example,
67 66 .sp
68 67 .in +2
69 68 .nf
70 69 "person icon"
71 70 .fi
72 71 .in -2
73 72 .sp
74 73
75 74 .sp
76 75 .LP
77 76 The next line is a blank-separated list of template options. "" can be used if
78 77 no options are desired. Available options are: \fBaddable\fR (it is appropriate
79 78 to allow entries of this type to be added), \fBmodrdn\fR (it is appropriate to
80 79 offer the \fBmodify rdn\fR operation), \fBaltview\fR (this template is an
81 80 alternate view of another template). For example,
82 81 .sp
83 82 .in +2
84 83 .nf
85 84 "addable" "modrdn"
86 85 .fi
87 86 .in -2
88 87 .sp
89 88
90 89 .sp
91 90 .LP
92 91 The next portion of the template is a list of X.500 object classes that is used
93 92 to determine whether the template should be used to display a given entry. The
94 93 object class information consists of one or more lines, followed by a
95 94 terminating line that contains the single token \fBEND\fR. Each line contains
96 95 one or more object class names, all of which must be present in a directory
97 96 entry. Multiple lines can be used to associate more than one set of object
98 97 classes with a given template. For example,
99 98 .sp
100 99 .in +2
101 100 .nf
102 101 emailPerson
103 102 orgPerson
104 103 END
105 104 .fi
106 105 .in -2
107 106 .sp
108 107
109 108 .sp
110 109 .LP
111 110 means that the template is appropriate for display of \fBemailPerson\fR entries
112 111 or \fBorgPerson\fR entries.
113 112 .sp
114 113 .LP
115 114 The next line after the object class list is the name of the attribute to
116 115 authenticate as to make changes (use "" if it is appropriate to authenticate as
117 116 the entry itself). For example,
118 117 .sp
119 118 .in +2
120 119 .nf
121 120 "owner"
122 121 .fi
123 122 .in -2
124 123 .sp
125 124
126 125 .sp
127 126 .LP
128 127 The next line is the default attribute to use when naming a new entry, for
129 128 example,
130 129 .sp
131 130 .in +2
132 131 .nf
133 132 "cn"
134 133 .fi
135 134 .in -2
136 135 .sp
137 136
138 137 .sp
139 138 .LP
140 139 The next line is the distinguished name of the default location under which new
141 140 entries are created. For example,
142 141 .sp
143 142 .in +2
144 143 .nf
145 144 "o=XYZ, c=US"
146 145 .fi
147 146 .in -2
148 147 .sp
149 148
150 149 .sp
151 150 .LP
152 151 The next section is a list of rules used to assign default values to new
153 152 entries. The list should be terminated with a line that contains the single
154 153 token \fBEND\fR. Each line in this section should either begin with the token
155 154 \fBconstant\fR and be followed by the name of the attribute and a constant
156 155 value to assign, or the line should begin with \fBaddersdn\fR followed by the
157 156 name of an attribute whose value will be the DN of the person who has
158 157 authenticated to add the entry. For example,
159 158 .sp
160 159 .in +2
161 160 .nf
162 161 constant associatedDomain XYZ.us
163 162 addersdn seeAlso
164 163 END
165 164 .fi
166 165 .in -2
167 166 .sp
168 167
169 168 .sp
170 169 .LP
171 170 The last portion of the template is a list of items to display. It consists of
172 171 one or more lines, followed by a terminating line that contains the single
173 172 token \fBEND\fR. Each line is must begin with the token \fBsamerow\fR or the
174 173 token \fBitem\fR
175 174 .sp
176 175 .LP
177 176 It is assumed that each item appears on a row by itself unless it was preceded
178 177 by a \fBsamerow\fR line (in which case it should be displayed on the same line
179 178 as the previous item, if possible). Lines that begin with \fBsamerow\fR should
180 179 not have any other tokens on them.
181 180 .sp
182 181 .LP
183 182 Lines that begin with \fBitem\fR must have at least three more tokens on them:
184 183 an item type, a label, and an attribute name. Any extra tokens are taken as
185 184 extra arguments.
186 185 .sp
187 186 .LP
188 187 The item type token must be one of the following strings:
189 188 .sp
190 189 .ne 2
191 190 .na
192 191 \fB\fBcis\fR \fR
193 192 .ad
194 193 .RS 14n
195 194 case-ignore string attributes
196 195 .RE
197 196
198 197 .sp
199 198 .ne 2
200 199 .na
201 200 \fB\fBmls\fR \fR
202 201 .ad
203 202 .RS 14n
204 203 multiline string attributes
205 204 .RE
206 205
207 206 .sp
208 207 .ne 2
209 208 .na
210 209 \fB\fBmail\fR \fR
211 210 .ad
212 211 .RS 14n
213 212 RFC-822 conformant mail address attributes
214 213 .RE
215 214
216 215 .sp
217 216 .ne 2
218 217 .na
219 218 \fB\fBdn\fR \fR
220 219 .ad
221 220 .RS 14n
222 221 distinguished name pointer attributes
223 222 .RE
224 223
225 224 .sp
226 225 .ne 2
227 226 .na
228 227 \fB\fBbool\fR \fR
229 228 .ad
230 229 .RS 14n
231 230 Boolean attributes
232 231 .RE
233 232
234 233 .sp
235 234 .ne 2
236 235 .na
237 236 \fB\fBjpeg\fR \fR
238 237 .ad
239 238 .RS 14n
240 239 JPEG photo attributes
241 240 .RE
242 241
243 242 .sp
244 243 .ne 2
245 244 .na
246 245 \fB\fBjpegbtn\fR \fR
247 246 .ad
248 247 .RS 14n
249 248 a button that will retrieve and show a JPEG photo attribute
250 249 .RE
251 250
252 251 .sp
253 252 .ne 2
254 253 .na
255 254 \fB\fBfax\fR \fR
256 255 .ad
257 256 .RS 14n
258 257 FAX T.4 format image attributes
259 258 .RE
260 259
261 260 .sp
262 261 .ne 2
263 262 .na
264 263 \fB\fBfaxbtn\fR \fR
265 264 .ad
266 265 .RS 14n
267 266 a button that will retrieve and show a FAX photo attribute
268 267 .RE
269 268
270 269 .sp
271 270 .ne 2
272 271 .na
273 272 \fB\fBaudiobtn\fR \fR
274 273 .ad
275 274 .RS 14n
276 275 audio attributes
277 276 .RE
278 277
279 278 .sp
280 279 .ne 2
281 280 .na
282 281 \fB\fBtime\fR \fR
283 282 .ad
284 283 .RS 14n
285 284 UTC time attributes
286 285 .RE
287 286
288 287 .sp
289 288 .ne 2
290 289 .na
291 290 \fB\fBdate\fR \fR
292 291 .ad
293 292 .RS 14n
294 293 UTC time attributes where only the date portion should be shown
295 294 .RE
296 295
297 296 .sp
298 297 .ne 2
299 298 .na
300 299 \fB\fBurl\fR \fR
301 300 .ad
302 301 .RS 14n
303 302 labeled Uniform Resource Locator attributes
304 303 .RE
305 304
306 305 .sp
307 306 .ne 2
308 307 .na
309 308 \fB\fBsearchact\fR \fR
310 309 .ad
311 310 .RS 14n
312 311 define an action that will do a directory search for other entries
313 312 .RE
314 313
315 314 .sp
316 315 .ne 2
317 316 .na
318 317 \fB\fBlinkact\fR \fR
319 318 .ad
320 319 .RS 14n
321 320 define an action which is a link to another display template
322 321 .RE
323 322
324 323 .sp
325 324 .ne 2
326 325 .na
327 326 \fB\fBprotected\fR \fR
328 327 .ad
329 328 .RS 14n
330 329 for an encrypted attribute, with values displayed as asterisks
331 330 .RE
332 331
333 332 .sp
334 333 .LP
335 334 An example of an item line for the drink attribute (displayed with label "Work
336 335 Phone"):
337 336 .sp
338 337 .in +2
339 338 .nf
340 339 item cis "Work Phone" telephoneNumber
341 340 .fi
342 341 .in -2
343 342 .sp
344 343
345 344 .SH EXAMPLES
346 345 .LP
347 346 \fBExample 1 \fRA Sample Configuration File Containing a Template that Displays
348 347 People Entries
349 348 .sp
350 349 .LP
351 350 The following template configuration file contains a templates for display of
352 351 people entries.
353 352
354 353 .sp
355 354 .in +2
356 355 .nf
357 356 #
358 357 # LDAP display templates
359 358 #
360 359 # Version must be 1 for now
361 360 #
362 361 Version 1
363 362 #
364 363 # Person template
365 364 "Person"
366 365 "People"
367 366
368 367 # name of the icon that is associated with this template
369 368 "person icon"
370 369
371 370 # blank-separated list of template options ("" for none)
372 371 "addable"
373 372
374 373 #
375 374 # objectclass list
376 375 person
377 376 END
378 377
379 378 #
380 379 # name of attribute to authenticate as ("" means auth as this entry)
381 380 ""
382 381
383 382 #
384 383 # default attribute name to use when forming RDN of a new entry
385 384 #
386 385 "cn"
387 386
388 387 #
389 388 # default location when adding new entries (DN; "" means no default)
390 389 "o=XYZ, c=US"
391 390
392 391 #
393 392 # rules used to define default values for new entries
394 393 END
395 394
396 395 #
397 396 # list of items for display
398 397 item jpegbtn "View Photo" jpegPhoto "Next Photo"
399 398 item audiobtn "Play Sound" audio
400 399 item cis "Also Known As" cn
401 400 item cis "Title" title
402 401 item mls "Work Address" postalAddress
403 402 item cis "Work Phone" telephoneNumber
404 403 item cis "Fax Number" facsimileTelephoneNumber
405 404 item mls "Home Address" homePostalAddress
406 405 item cis "Home Phone" homePhone
|
↓ open down ↓ |
367 lines elided |
↑ open up ↑ |
407 406 item cis "User ID" uid
408 407 item mail "E-Mail Address" mail
409 408 item cis "Description" description
410 409 item dn "See Also" seeAlso
411 410 END
412 411 .fi
413 412 .in -2
414 413 .sp
415 414
416 415 .SH ATTRIBUTES
417 -.sp
418 416 .LP
419 417 See \fBattributes\fR(5) for a description of the following attributes:
420 418 .sp
421 419
422 420 .sp
423 421 .TS
424 422 box;
425 423 c | c
426 424 l | l .
427 425 ATTRIBUTE TYPE ATTRIBUTE VALUE
428 426 Stability Level Evolving
429 427 .TE
430 428
431 429 .SH SEE ALSO
432 -.sp
433 430 .LP
434 431 \fBldap_disptmpl\fR(3LDAP), \fBldap_entry2text\fR(3LDAP), \fBattributes\fR(5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX