Penguin
Recent Changes
Blame: ldaptemplates.conf(5)
EditPageHistoryDiffInfoLikePages
Annotated edit history of ldaptemplates.conf(5) version 5, including all changes. View license author blame.
Rev Author # Line
1 perry 1 LDAPTEMPLATES.CONF
2 !!!LDAPTEMPLATES.CONF
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 ACTIONS
7 EXAMPLE
8 FILES
9 SEE ALSO
10 ACKNOWLEDGEMENTS
11 ----
12 !!NAME
13
14
15 ldaptemplates.conf - configuration file for LDAP display template routines
16 !!SYNOPSIS
17
18
19 /etc/ldap/ldaptemplates.conf
20 !!DESCRIPTION
21
22
23 The file /etc/ldap/ldaptemplates.conf contains information
24 used by the LDAP display templates routines (see
5 KonstantinMatyukhin 25 ldap_disptmpl(3)). Blank lines and lines that have a first
1 perry 26 character of `#' are treated as comments and ignored.
27 Non-comment lines contain one or more tokens. Tokens are
28 separated by white space, and double quotes `
29
30
31 The first non-commment line specifies the version of the
32 template information and must contain the token
33 ''Version'' followed by an integer version number.
34 E.g.,
35
36
37 __ Version 1
38 __The current version is ''1,'' so the above example is always the correct opening line.
39
40
41 The remainder of the file consists of one or more display
42 templates. The first two lines of the display template
43 should each contain a single token that specifies singular
44 and plural names for the template that are suitable for
45 human consumption. These names are stored in the
46 ''dt_name'' and ''dt_pluralname'' members of the
47 ''ldap_disptmpl'' structure. E.g.,
48
49
50 __
51 __specifies appropriate names for a template designed to display X.500 person information.
52
53
54 The next line specifies the name of the icon or similar
55 element that is associated with this template.
56 E.g.,
57
58
59 __
60 __The next line is a blank-separated list of template options.
61
62
63 __
64 __The next portion of the template is a list of X.500 object classes that is used to determine whether the template should be used to display a given entry. The object class information consists of one or more lines, followed by a terminating line that contains the single token ''END.'' Each line contains one or more object class names, all of which must be present in an X.500 entry for the ''ldap_oc2template(3)'' routine to return a pointer to this template. The object class information is stored in the ''dt_oclist'' member of the ''ldap_disptmpl'' structure. Multiple lines can be used to associate more than one set of object classes with a given template. E.g.,
65
66
67 __ umichPerson
68 lblPerson
69 END
70 __means that the template is appropriate for display of umichPerson entries or lblPerson entries.
71
72
73 Next next line after the object class list is the name of
74 the attribute to authenticate as to make changes (use
75
76
77 __
78 __The next line is the default attribute to use when naming a new entry. E.g.,
79
80
81 __
82 __The next line is the default location under which new entries are created. It should be a string-represented Distringuished Name. E.g.,
83
84
85 __
86 __The next section is a list of rules used to assign default values to new entries. The list should be terminated with a line that contains the single token ''END.'' Each line in this section should either begin with the token ''constant'' and be followed by the name of the attribute and a constant value to assign, or the line should begin with ''addersdn'' followed by the name of an attribute whose value will be the DN of the person who has authenticated to add the entry. E.g.,
87
88
89 __ constant associatedDomain umich.edu
90 addersdn seeAlso
91 END
92 __The last portion of the template is a list of items to display. It consists of one or more lines, followed by a terminating line that contains the single token ''END.'' Each line is must begin with the token ''samerow'' or the token ''item''
93
94
95 It is assumed that each item appears on a row by itself
96 unless it was preceded by a ''samerow'' line (in which
97 case it should be displayed on the same line as the previous
98 item, if possible). Lines that begin with ''samerow''
99 should not have any other tokens on them.
100
101
102 Lines that begin with ''item'' must have at least three
103 more tokens on them: an item type, a label, and an attribute
104 name. Any extra tokens are taken as extra arguments and are
105 stored in the ''ti_args'' member of the
106 ''ldap_tmplitem'' structure.
107
108
109 The item type token must be one of the following strings:
110 ''cis'' (for case ignore string attributes), ''mls''
111 (for multiline string attributes), ''mail'' (for RFC-822
112 conformant mail address attributes), ''dn'' (for
113 distinguished name pointer attributes), ''bool'' (for
114 Boolean attributes), ''jpeg'' (for JPEG photo
115 attributes), ''jpegbtn'' (for a button that will retrieve
116 and show a JPEG photo attribute), ''fax'' (for FAX T.4
117 format image attributes), ''faxbtn'' (for a button that
118 will retrieve and show a FAX photo attribute),
119 ''audiobtn'' (for audio attributes), ''time'' (for UTC
120 time attributes), ''date'' (for UTC time attributes where
121 only the date portion should be shown), ''url'' (for
122 labeled Uniform Resource Locator attributes),
123 ''searchact'' (to define an action that will do a
124 directory search for other entries), ''linkact'' (to
125 define an action which is a link to another display
126 template). See the ACTIONS section below for more
127 information on search and link actions.
128
129
130 An example of an item line for the drink attribute
131 (displayed with label
132
133
134 __ item cis
135 __
136 !!ACTIONS
137
138
139 This section has not been written yet. Sorry!
140 !!EXAMPLE
141
142
143 The following template configuration file contains two
144 templates, one for display of people entries and one for
145 display of contries.
146
147
148 __ #
149 # LDAP display templates
150 #
151 # Version must be 1 for now
152 #
153 Version 1
154 #
155 # Person template
156 __
157 !!FILES
158
159
160 /etc/ldap/ldaptemplates.conf
161 !!SEE ALSO
162
163
4 perry 164 ldap(3), ldap_disptmpl(3)
1 perry 165 !!ACKNOWLEDGEMENTS
166
167
168 __OpenLDAP__ is developed and maintained by The OpenLDAP
169 Project (http://www.openldap.org/). __OpenLDAP__ is
170 derived from University of Michigan LDAP 3.3
171 Release.
172 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.