1Config::Model::models::UIstesrelCfo:nC:toCrnoifnbifugit:ge:RdMeoaPddeeWrlrl:i:tDmeoo(cd3ue)mlesn:t:aIttisoenlf::ConfigReadWrite(3)
2
3
4

NAME

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

DESCRIPTION

10       Configuration classes used by Config::Model
11

Elements

13   backend
14       specifies the backend to store permanently configuration data.
15       Optional. Type enum. choice: 'cds_file', 'perl_file', 'custom'.
16
17       Here are some explanations on the possible values:
18
19       'IniFile'
20           Ini file format. Beware that the structure of your model must match
21           the limitations of the INI file format, i.e only a 2 levels
22           hierarchy. Configuration filename is made with instance name
23
24       'cds_file'
25           file with config data string. This is Config::Model own
26           serialisation format, designed to be compact and readable.
27           Configuration filename is made with instance name
28
29       'custom'
30           deprecated
31
32       'perl_file'
33           file with a perl data structure. Configuration filename is made
34           with instance name
35
36   config_dir
37        Optional. Type uniline.
38
39   os_config_dir - configuration file directory for specific OS
40       Specify and alternate location of a configuration directory depending
41       on the OS (as returned by $^O or $Config{'osname'}, see "PLATFORMS" in
42       perlport) Common values for $^O are 'linux', 'MSWin32', 'darwin'
43       Optional. Type hash of uniline.
44
45   file - target configuration file name
46       specify the configuration file name. This parameter may not be
47       applicable depending on your application. It may also be hardcoded in a
48       custom backend. If not specified, the instance name is used as base
49       name for your configuration file. The configuration file namecan be
50       specified with &index() or &element function. See backend
51       specifications <http://search.cpan.org/dist/Config-
52       Model/lib/Config/Model/BackendMgr.pm#Backend_specification> and
53       Config::Model::Role::ComputeFunction.  Optional. Type uniline.
54
55   function
56       Deprecated  Optional. Type uniline.
57
58   auto_create - Creates configuration files as needed
59        Optional. Type boolean.
60
61       upstream_default value :
62           0
63
64   yaml_class
65       Specify the YAML class that is used to load and dump YAML files.
66       Defaults to YAML::Tiny. See yaml_class doc for details on  why another
67       YAML class can suit your configuration file needs.  Optional. Type
68       uniline.
69
70       upstream_default value :
71           YAML::Tiny
72
73   file_mode - configuration file mode
74       specify the configuration file mode. "file_mode" parameter can be used
75       to set the mode of the written file. "file_mode" value can be in any
76       form supported by "chmod" in Path::Tiny.  Optional. Type uniline.
77
78   default_layer - How to find default values in a global config file
79       Specifies where to find a global configuration file that specifies
80       default values. For instance, this is used by OpenSSH to specify a
81       global configuration file ("/etc/ssh/ssh_config") that is overridden by
82       user's file.  Optional. Type node of class
83       Itself::ConfigReadWrite::DefaultLayer .
84
85   class
86        Optional. Type uniline.
87
88   store_class_in_hash
89       Specify element hash name that contains all INI classes. See "Arbitrary
90       class name" in Config::Model::Backend::IniFile  Optional. Type uniline.
91
92   section_map
93       Specify element name that contains one INI class. E.g. to store INI
94       class [foo] in element Foo, specify { foo => "Foo" }  Optional. Type
95       hash of uniline.
96
97   split_list_value
98       Regexp to split the value read from ini file. Usually "\s+" or "[,\s]"
99       Optional. Type uniline.
100
101   split_check_list_value
102       Regexp to split the value read from ini file. Usually "\s+" or "[,\s]"
103       Optional. Type uniline.
104
105   assign_char
106       Character used to assign value in INI file. Default is "=". See details
107       Optional. Type uniline.
108
109       upstream_default value :
110           #
111
112   assign_with
113       String used write assignment in INI file. Default is "" = "". See
114       details  Optional. Type uniline.
115
116       upstream_default value :
117           #
118
119   join_list_value
120       string to join list values before writing the entry in ini file.
121       Usually " " or ", "  Optional. Type uniline.
122
123   join_check_list_value
124       string to join checked items names before writing the entry in the ini
125       file. Usually " " or ", "  Optional. Type uniline.
126
127   write_boolean_as
128       Specify how to write a boolean value in config file. Suggested values
129       are "no","yes".  Optional. Type list of uniline.
130
131   force_lc_section
132       force section to be lowercase.  Optional. Type boolean.
133
134       upstream_default value :
135           0
136
137   force_lc_key
138       force key names to be lowercase.  Optional. Type boolean.
139
140       upstream_default value :
141           0
142
143   force_lc_value
144       force values to be lowercase.  Optional. Type boolean.
145
146       upstream_default value :
147           0
148
149   full_dump
150       Also dump default values in the data structure. Useful if the dumped
151       configuration data will be used by the application. (default is yes)
152       Optional. Type boolean.
153
154       upstream_default value :
155           1
156
157   comment_delimiter
158       list of characters that start a comment. When more that one character
159       is used. the first one is used to write back comment. For instance,
160       value "#;" indicate that a comments can start with "#" or ";" and that
161       all comments are written back with "#".  Optional. Type uniline.
162
163       upstream_default value :
164           #
165
166   quote_value
167       Specify how to handle quoted values. By default, quoted values are left
168       as is. With "shell_style", value are parsed and unquoted like in a
169       shell. Values containing a space are written back with double quotes.
170       Optional. Type enum. choice: 'shell_style'.
171
172   auto_delete - Delete empty configuration file
173       Delete configuration files when no information is left in there. This
174       may happen when data is removed by user. This is mostly useful when the
175       configuration of an application is made of several files.  Optional.
176       Type boolean.
177
178       upstream_default value :
179           0
180

SEE ALSO

182       •   cme
183
184       •   Config::Model::models::Itself::ConfigReadWrite::DefaultLayer
185
186
187
188perl v5.36.0                 Confi2g0:2:2M-o0d7e-l2:2:models::Itself::ConfigReadWrite(3)
Impressum