.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Config::Model::models::Itself::ConfigWrite 3pm"
.TH Config::Model::models::Itself::ConfigWrite 3pm "2014-10-23" "perl v5.20.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Config::Model::models::Itself::ConfigWrite \- Configuration class Itself::ConfigWrite
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Configuration classes used by Config::Model
.SH "Elements"
.IX Header "Elements"
.SS "syntax"
.IX Subsection "syntax"
Deprecated parameter that specified the file syntax to store permanently configuration data. Replaced by \*(L"backend\*(R"\fBDeprecated\fR \fIOptional. Type enum. choice: 'cds', 'perl', 'ini', 'custom'.\fR
.SS "backend"
.IX Subsection "backend"
specifies the backend to store permanently configuration data.\fIOptional. Type enum. choice: 'cds_file', 'perl_file', 'ini_file', 'custom'.\fR
.PP
Here are some explanations on the possible values:
.IP "'cds_file'" 4
.IX Item "'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
.IP "'custom'" 4
.IX Item "'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
.IP "'ini_file'" 4
.IX Item "'ini_file'"
Ini file format. Beware that the structure of your model must match the limitations of the \s-1INI\s0 file format, i.e only a 2 levels hierarchy. Configuration filename is made with instance name
.IP "'perl_file'" 4
.IX Item "'perl_file'"
file with a perl data structure. Configuration filename is made with instance name
.PP
Note: backend is migrated with '\f(CW$old\fR' and with \f(CW$old\fR => "\f(CW\*(C`\- syntax\*(C'\fR" and '\f(CW$replace{perl}\fR' => "\f(CW\*(C`perl_file\*(C'\fR", '\f(CW$replace{cds}\fR' => "\f(CW\*(C`cds_file\*(C'\fR", '\f(CW$replace{ini}\fR' => "\f(CW\*(C`ini_file\*(C'\fR"
.SS "config_dir"
.IX Subsection "config_dir"
\&\fIOptional. Type uniline.\fR
.SS "os_config_dir \- configuration file directory for specific \s-1OS\s0"
.IX Subsection "os_config_dir - configuration file directory for specific OS"
Specify and alternate location of a configuration directory depending on the \s-1OS \s0(as returned by \f(CW$^O\fR or \f(CW$Config{\*(Aqosname\*(Aq}\fR, see \*(L"\s-1PLATFORMS\*(R"\s0 in perlport) Common values for \f(CW$^O\fR are 'linux', 'MSWin32', 'darwin'\fIOptional. Type hash of uniline.\fR
.SS "file \- target configuration file name"
.IX Subsection "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.\fIOptional. Type uniline.\fR
.SS "default_layer \- How to find default values in a global config file"
.IX Subsection "default_layer - How to find default values in a global config file"
Specifies where to find a global configuration file that specifies default values. For instance, this is used by OpenSSH to specify a global configuration file (\f(CW\*(C`/etc/ssh/ssh_config\*(C'\fR) that is overridden by user's file. \fIOptional. Type node of class Itself::ConfigWR::DefaultLayer .\fR
.SS "class"
.IX Subsection "class"
\&\fIOptional. Type uniline.\fR
.SS "store_class_in_hash"
.IX Subsection "store_class_in_hash"
Specify element hash name that will contain all \s-1INI\s0 classes. See \*(L"Arbitrary class name\*(R" in Config::Model::Backend::IniFile\fIOptional. Type uniline.\fR
.SS "section_map"
.IX Subsection "section_map"
Specify element name that will contain one \s-1INI\s0 class. E.g. to store \s-1INI\s0 class [foo] in element Foo, specify { foo => \*(L"Foo\*(R" } \fIOptional. Type hash of uniline.\fR
.SS "split_list_value"
.IX Subsection "split_list_value"
Regexp to split values stored in list element. Usually \*(L"\es+\*(R" or \*(L"[,\es]\*(R"\fIOptional. Type uniline.\fR
.SS "join_list_value"
.IX Subsection "join_list_value"
string to join values from list element. Usually \*(L" \*(R" or \*(L", \*(R"\fIOptional. Type uniline.\fR
.SS "write_boolean_as"
.IX Subsection "write_boolean_as"
Specify how to write a boolean value in config file. Suggested values are \*(L"no\*(R",\*(L"yes\*(R". \fIOptional. Type list of uniline.\fR
.SS "force_lc_section"
.IX Subsection "force_lc_section"
force section to be lowercase. \fIOptional. Type boolean. upstream_default: '0'.\fR
.SS "force_lc_key"
.IX Subsection "force_lc_key"
force key names to be lowercase. \fIOptional. Type boolean. upstream_default: '0'.\fR
.SS "force_lc_value"
.IX Subsection "force_lc_value"
force values to be lowercase. \fIOptional. Type boolean. upstream_default: '0'.\fR
.SS "full_dump"
.IX Subsection "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)\fIOptional. Type boolean. upstream_default: '1'.\fR
.SS "comment_delimiter"
.IX Subsection "comment_delimiter"
comment starts with this character. \fIOptional. Type uniline. upstream_default: '#'.\fR
.SS "function"
.IX Subsection "function"
\&\fIOptional. Type uniline.\fR
.SS "auto_create \- Creates configuration files as needed"
.IX Subsection "auto_create - Creates configuration files as needed"
\&\fIOptional. Type boolean. upstream_default: '0'.\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
cme
.IP "\(bu" 4
Config::Model::models::Itself::ConfigWR::DefaultLayer