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 keyword when a backend is associated to a node
51       contained in a hash. See backend specifications
52       <http://search.cpan.org/dist/Config-
53       Model/lib/Config/Model/BackendMgr.pm#Backend_specification>.  Optional.
54       Type uniline.
55
56   function
57       Deprecated  Optional. Type uniline.
58
59   auto_create - Creates configuration files as needed
60        Optional. Type boolean.
61
62       upstream_default value :
63           0
64
65   yaml_class
66       Specify the YAML class that is used to load and dump YAML files.
67       Defaults to YAML::Tiny. See yaml_class doc for details on  why another
68       YAML class can suit your configuration file needs.  Optional. Type
69       uniline.
70
71       upstream_default value :
72           YAML::Tiny
73
74   file_mode - configuration file mode
75       specify the configuration file mode. "file_mode" parameter can be used
76       to set the mode of the written file. "file_mode" value can be in any
77       form supported by "chmod" in Path::Tiny.  Optional. Type uniline.
78
79   default_layer - How to find default values in a global config file
80       Specifies where to find a global configuration file that specifies
81       default values. For instance, this is used by OpenSSH to specify a
82       global configuration file ("/etc/ssh/ssh_config") that is overridden by
83       user's file.  Optional. Type node of class
84       Itself::ConfigReadWrite::DefaultLayer .
85
86   class
87        Optional. Type uniline.
88
89   store_class_in_hash
90       Specify element hash name that contains all INI classes. See "Arbitrary
91       class name" in Config::Model::Backend::IniFile  Optional. Type uniline.
92
93   section_map
94       Specify element name that contains one INI class. E.g. to store INI
95       class [foo] in element Foo, specify { foo => "Foo" }  Optional. Type
96       hash of uniline.
97
98   split_list_value
99       Regexp to split the value read from ini file. Usually "\s+" or "[,\s]"
100       Optional. Type uniline.
101
102   split_check_list_value
103       Regexp to split the value read from ini file. Usually "\s+" or "[,\s]"
104       Optional. Type uniline.
105
106   assign_char
107       Character used to assign value in INI file. Default is "=". See details
108       Optional. Type uniline.
109
110       upstream_default value :
111           #
112
113   assign_with
114       String used write assignment in INI file. Default is "" = "". See
115       details  Optional. Type uniline.
116
117       upstream_default value :
118           #
119
120   join_list_value
121       string to join list values before writing the entry in ini file.
122       Usually " " or ", "  Optional. Type uniline.
123
124   join_check_list_value
125       string to join checked items names before writing the entry in the ini
126       file. Usually " " or ", "  Optional. Type uniline.
127
128   write_boolean_as
129       Specify how to write a boolean value in config file. Suggested values
130       are "no","yes".  Optional. Type list of uniline.
131
132   force_lc_section
133       force section to be lowercase.  Optional. Type boolean.
134
135       upstream_default value :
136           0
137
138   force_lc_key
139       force key names to be lowercase.  Optional. Type boolean.
140
141       upstream_default value :
142           0
143
144   force_lc_value
145       force values to be lowercase.  Optional. Type boolean.
146
147       upstream_default value :
148           0
149
150   full_dump
151       Also dump default values in the data structure. Useful if the dumped
152       configuration data will be used by the application. (default is yes)
153       Optional. Type boolean.
154
155       upstream_default value :
156           1
157
158   comment_delimiter
159       list of characters that start a comment. When more that one character
160       is used. the first one is used to write back comment. For instance,
161       value "#;" indicate that a comments can start with "#" or ";" and that
162       all comments are written back with "#".  Optional. Type uniline.
163
164       upstream_default value :
165           #
166
167   auto_delete - Delete empty configuration file
168       Delete configuration files when no information is left in there. This
169       may happen when data is removed by user. This is mostly useful when the
170       configuration of an application is made of several files.  Optional.
171       Type boolean.
172
173       upstream_default value :
174           0
175

SEE ALSO

177       ·   cme
178
179       ·   Config::Model::models::Itself::ConfigReadWrite::DefaultLayer
180
181
182
183perl v5.28.1                 Confi2g0:1:9M-o0d2e-l0:2:models::Itself::ConfigReadWrite(3)
Impressum