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