Config::Model::models::Itself::ConfigAccept(3pm)

1Config::Model::models::UIstesrelCfo:n:tCroiCnbofunitfgeiAdgc:cP:eeMprotld(e3Dl)o:c:ummoednetlast:i:oIntself::ConfigAccept(3)
2
3
4

NAME

6       Config::Model::models::Itself::ConfigAccept - Configuration class
7       Itself::ConfigAccept
8

DESCRIPTION

10       Configuration classes used by Config::Model
11

Elements

13   name_match
14       Deprecated  Optional. Type uniline.
15
16       upstream_default value :
17           .*
18
19   accept_after
20       specify where to insert accepted element. This does not change the
21       behavior and helps generating more consistent  user interfaces.
22       Optional. Type reference.
23
24   type
25       specify the type of the configuration element.Leaf is used for plain
26       value.  Mandatory. Type enum. choice: 'node', 'warped_node', 'hash',
27       'list', 'leaf', 'check_list'.
28
29   value_type
30        Optional. Type enum. choice: 'boolean', 'enum', 'integer',
31       'reference', 'number', 'uniline', 'string', 'file', 'dir'.
32
33       Here are some explanations on the possible values:
34
35       'integer'
36           positive or negative integer
37
38       'uniline'
39           string with no embedded newline
40
41   class - Override implementation of element
42       Perl class name used to override the implementation of the
43       configuration element. This override Perl class must inherit a
44       Config::Model class that matches the element type, i.e.
45       Config::Model::Value, Config::Model::HashId or Config::Model::ListId.
46       Use with care.  Optional. Type uniline.
47
48   morph
49       When set, a recurse copy of the value from the old object to the new
50       object is attemped. Old values are dropped when  a copy is not possible
51       (usually because of mismatching types)  Optional. Type boolean.
52
53   refer_to
54       points to an array or hash element in the configuration tree using grab
55       syntax. The available choice of this reference value (or check list)is
56       made from the available keys of the pointed hash element or the values
57       of the pointed array element.  Optional. Type uniline.
58
59   computed_refer_to
60       points to an array or hash element in the configuration tree using a
61       path computed with value from several other elements in the
62       configuration tree. The available choice of this reference value (or
63       check list) is made from the available keys of the pointed hash element
64       or the values of the pointed array element. The keys of several hashes
65       (or lists) can be combined by using the '+' operator in the formula.
66       For instance, '! host:$a lan + ! host:foobar lan'. See
67       Config::Model::IdElementReference for more details.  Optional. Type
68       warped_node.
69
70   replace_follow
71       Path specifying a hash of value element in the configuration tree. The
72       hash if used in a way similar to the replace parameter. In this case,
73       the replacement is not coded in the model but specified by the
74       configuration.  Optional. Type uniline.
75
76   compute
77       compute the default value according to a formula and value from other
78       elements in the configuration tree.  Optional. Type warped_node.
79
80   migrate_from
81       Specify an upgrade path from an old value and compute the value to
82       store in the new element.  Optional. Type warped_node.
83
84   write_as
85       Specify how to write a boolean value. Example 'no' 'yes'.  Optional.
86       Type list of uniline.
87
88   migrate_values_from
89       Specifies that the values of the hash or list are copied from another
90       hash or list in the configuration tree once configuration data are
91       loaded.  Optional. Type uniline.
92
93   migrate_keys_from
94       Specifies that the keys of the hash are copied from another hash in the
95       configuration tree only when the hash is created.  Optional. Type
96       uniline.
97
98   write_empty_value
99       By default, hash entries without data are not saved in configuration
100       files. Set this parameter to 1 if a key must be saved in the
101       configuration file even if the hash contains no value for that key.
102       Optional. Type boolean.
103
104       upstream_default value :
105           0
106
107   mandatory
108        Optional. Type boolean.
109
110   config_class_name
111        Optional. Type reference.
112
113   choice
114       Specify the possible values of an enum. This can also be used in a
115       reference element so the possible enum value will be the combination of
116       the specified choice and the referred to values.  Optional. Type list
117       of uniline.
118
119   min
120       minimum value.  Optional. Type number.
121
122   max
123       maximum value.  Optional. Type number.
124
125   min_index
126       minimum number of keys.  Optional. Type integer.
127
128   max_index
129       maximum number of keys.  Optional. Type integer.
130
131   default
132       Specify default value. This default value is written in the
133       configuration data.  Optional. Type string.
134
135   upstream_default
136       Another way to specify a default value. But this default value is
137       considered as "built_in" the application and is not written in the
138       configuration data (unless modified)  Optional. Type string.
139
140   convert
141       Convert value or index to uppercase (uc) or lowercase (lc).  Optional.
142       Type enum.
143
144   match
145       Perl regular expression to assert the validity of the value. To check
146       the whole value, use "^" and "$". For instance "^foo|bar$" allows "foo"
147       or "bar" but not "foobar". To be case insentive, use the "(?i)"
148       extended pattern. For instance, the regexp "^(?i)foo|bar$" also allows
149       the values "Foo" and "Bar".  Optional. Type uniline.
150
151   assert
152       Raise an error if the test code snippet does returns false. Note this
153       snippet is also run on undefined value, which may not be what you want.
154       Optional. Type hash of node of class Itself::CommonElement::Assert .
155
156   warn_if
157       Warn user if the code snippet returns true.  Optional. Type hash of
158       node of class Itself::CommonElement::Assert .
159
160   warn_unless
161       Warn user if the code snippet returns false.  Optional. Type hash of
162       node of class Itself::CommonElement::Assert .
163
164   warn_if_match
165       Warn user if a defined value matches the regular expression.  Optional.
166       Type hash of node of class Itself::CommonElement::WarnIfMatch .
167
168   warn_unless_match
169       Warn user if defined value does not match the regular expression.
170       Optional. Type hash of node of class Itself::CommonElement::WarnIfMatch
171       .
172
173   warn
174       Unconditionally issue a warning with this string when this parameter is
175       used. This should be used mostly with "accept"  Optional. Type string.
176
177   grammar
178       Feed this grammar to Parse::RecDescent to perform validation.
179       Optional. Type string.
180
181   default_list
182       Specify items checked by default.  Optional. Type check_list.
183
184   upstream_default_list
185       Specify items checked by default in the application.  Optional. Type
186       check_list.
187
188   allow_keys_from
189       this hash allows keys from the keys of the hash pointed by the path
190       string.  Optional. Type uniline.
191
192   allow_keys_matching
193       Keys must match the specified regular expression.  Optional. Type
194       uniline.
195
196   follow_keys_from
197       this hash contains the same keys as the hash pointed by the path
198       string.  Optional. Type uniline.
199
200   warn_if_key_match
201       Warn user if a key is created matching this regular expression.
202       Optional. Type uniline.
203
204   warn_unless_key_match
205       Warn user if a key is created not matching this regular expression.
206       Optional. Type uniline.
207
208   ordered
209       keep track of the order of the elements of this hash.  Optional. Type
210       boolean.
211
212   default_keys
213       default keys hashes.  Optional. Type list of string.
214
215   auto_create_keys
216       always create a set of keys specified in this list.  Optional. Type
217       list of string.
218
219   allow_keys
220       specify a set of allowed keys.  Optional. Type list of string.
221
222   auto_create_ids
223       always create the number of id specified in this integer.  Optional.
224       Type string.
225
226   default_with_init
227       specify a set of keys to create and initialization on some elements .
228       E.g. ' foo => "X=Av Y=Bv", bar => "Y=Av Z=Cz"'  Optional. Type hash of
229       string.
230
231   max_nb
232        Optional. Type integer.
233
234   replace
235       Used for enum to substitute one value with another. This parameter must
236       be used to enable user to upgrade a configuration with obsolete values.
237       The old value is the key of the hash, the new one is the value of the
238       hash.  Optional. Type hash of string.
239
240   duplicates
241       Specify the policy regarding duplicated values stored in the list or as
242       hash values (valid only when cargo type is "leaf"). The policy can be
243       "allow" (default), "suppress", "warn" (which offers the possibility to
244       apply a fix), "forbid".  Optional. Type enum. choice: 'allow',
245       'suppress', 'warn', 'forbid'.
246
247       upstream_default value :
248           allow
249
250   help
251       Specify help string specific to possible values. E.g for "light" value,
252       you could write " red => 'stop', green => 'walk'  Optional. Type hash
253       of string.
254
255   status
256        Optional. Type enum. choice: 'obsolete', 'deprecated', 'standard'.
257
258       upstream_default value :
259           standard
260
261   level
262       Used to highlight important parameter or to hide others. Hidden
263       parameter are mostly used to hide features that are unavailable at
264       start time. They can be made available later using warp mechanism.
265       Optional. Type enum. choice: 'important', 'normal', 'hidden'.
266
267       upstream_default value :
268           normal
269
270   summary
271       enter short information regarding this element.  Optional. Type
272       uniline.
273
274   description
275       enter detailed help information regarding this element.  Optional. Type
276       string.
277
278   warp
279       change the properties (i.e. default value or its value_type)
280       dynamically according to the value of another Value object located
281       elsewhere in the configuration tree.  Optional. Type warped_node of
282       class Itself::WarpValue .
283
284   index_type
285       Specify the type of allowed index for the hash. "String" means no
286       restriction.  Optional. Type enum.
287
288   cargo
289       Specify the properties of the configuration element configuration in
290       this hash or list.  Optional. Type warped_node.
291

NAME

DESCRIPTION

Elements

SEE ALSO