Config::Model::models::Itself::ConfigWrite(3pm) User Contributed Perl Documentation Config::Model::models::Itself::ConfigWrite(3pm)
NAME
Config::Model::models::Itself::ConfigWrite - Configuration class Itself::ConfigWrite
DESCRIPTION
Configuration classes used by Config::Model
Elements
syntax
Deprecated parameter that specified the file syntax to store permanently configuration data. Replaced by "backend"Deprecated Optional. Type
enum. choice: 'cds', 'perl', 'ini', 'custom'.
backend
specifies the backend to store permanently configuration data.Optional. Type enum. choice: 'cds_file', 'perl_file', 'ini_file', 'augeas',
'custom'.
Here are some explanations on the possible values:
'augeas'
Experimental backend with RedHat's Augeas library. See http://augeas.net for details
'cds_file'
file with config data string. This is Config::Model own serialisation format, designed to be compact and readable. Configuration
filename is made with instance name
'custom'
Custom format. You must specify your own class and method to perform the read or write function. See Config::Model::AutoRead doc for
more details
'ini_file'
Ini file format. Beware that the structure of your model must match the limitations of the INI file format, i.e only a 2 levels
hierarchy. Configuration filename is made with instance name
'perl_file'
file with a perl data structure. Configuration filename is made with instance name
Note: backend is migrated with '$old' and with $old => ""- syntax"" and '$replace{cds}' => ""cds_file"", '$replace{perl}' => ""perl_file"",
'$replace{ini}' => ""ini_file""
file - target configuration file name
specify the configuration file name. This parameter may not be applicable depending on your application. It may also be hardcoded in a
custom backend. If not specified, the instance name will be used as base name for your configuration file.Optional. Type uniline.
Note: file is migrated with '$old' and with $old => ""- config_file""
class
Optional. Type uniline.
save
Specify how to save the configuration file. Either create a newfile (with extension .augnew, and do not overwrite the original file) or
move the original file into a backup file (.augsave extension). Configuration files are overwritten by default. Optional. Type enum.
choice: 'backup', 'newfile'.
store_class_in_hash
Specify element hash name that will contain all INI classes. See "Arbitrary class name" in Config::Model::Backend::IniFileOptional. Type
uniline.
section_map
Specify element name that will contain one INI class. E.g. to store INI class [foo] in element Foo, specify { foo => "Foo" } Optional. Type
hash of uniline.
split_list_value
Regexp to split values stored in list element. Usually "s+" or "[,s]"Optional. Type uniline.
join_list_value
string to join values from list element. Usually " " or ", "Optional. Type uniline.
write_boolean_as
Specify how to write a boolean value in config file. Suggested values are "no","yes". Optional. Type list of uniline.
force_lc_section
force section to be lowercase. Optional. Type boolean. upstream_default: '0'.
force_lc_key
force key names to be lowercase. Optional. Type boolean. upstream_default: '0'.
force_lc_value
force values to be lowercase. Optional. Type boolean. upstream_default: '0'.
config_file
Specify the configuration file (without path) that will store configuration information. Deprecated Optional. Type uniline.
full_dump
Also dump default values in the data structure. Useful if the dumped configuration data will be used by the application. (default is
yes)Optional. Type boolean. upstream_default: '1'.
comment_delimiter
comment starts with this character. Optional. Type uniline. upstream_default: '#'.
set_in
Sometimes, the structure of a file loaded by Augeas starts directly with a list of items. For instance, /etc/hosts structure starts with a
list of lines that specify hosts and IP addresses. This parameter specifies an element name in Config::Model root class that will hold the
configuration data retrieved by Augeas. Optional. Type reference.
sequential_lens
List of hash or list Augeas lenses where value are stored in sequential Augeas nodes. See Config::Model::Backend::Augeas for
details.Optional. Type list of uniline.
function
Optional. Type uniline.
config_dir
Mandatory. Type uniline.
Note: config_dir is migrated with '$old' and with $old => ""- - write_config_dir""
auto_create - Creates configuration files as needed
Optional. Type boolean. upstream_default: '0'.
SEE ALSO
o cme
perl v5.14.2 2012-06-22 Config::Model::models::Itself::ConfigWrite(3pm)