.\" 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-EDIT 1p"
.TH CONFIG-EDIT 1p "2014-09-24" "perl v5.20.0" "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\-edit \- Deprecated, use cme
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  config\-edit [options] ( \-application popcon | \-model Popcon ) [ ... ] [ commands  ... ]
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`config\-edit\*(C'\fR program will use Config::Model configuration
descriptions to validate or modify the configuration file of an application.
.PP
You can specify commands as arguments that will be run on the
configuration root before launching the \s-1UI.\s0 These command follow the
syntax defined in Config::Model::Loader.
.PP
\&\f(CW\*(C`config\-edit\*(C'\fR can be run in several modes depending on your needs.
.SS "Graphical interface"
.IX Subsection "Graphical interface"
.Vb 1
\&  config\-edit \-application popcon
.Ve
.PP
Provides a user interface so user can easily and
securely modify the configuration of their system.
.SS "Curses interface"
.IX Subsection "Curses interface"
.Vb 1
\&  config\-edit \-ui curses \-application popcon
.Ve
.PP
Provides a curses user interface
.SS "Shell like interface"
.IX Subsection "Shell like interface"
.Vb 1
\&  config\-edit \-ui shell \-application popcon
.Ve
.PP
Provides a shell like interface
.SS "upgrade mode"
.IX Subsection "upgrade mode"
.Vb 1
\&  config\-edit \-ui none \-application popcon \-save
.Ve
.PP
Loads configuration date, perform validation and migration of old data 
(if specified by the model) and save the new configuration file.
.SS "Direct modification of configuration data"
.IX Subsection "Direct modification of configuration data"
.Vb 1
\&  config\-edit \-ui none \-application popcon PARTICIPATE=yes
.Ve
.PP
Loads old configuration data, update \f(CW\*(C`PARTICIPATE\*(C'\fR data, checks the modification 
and save the configuration back. Option \f(CW\*(C`\-save\*(C'\fR is not needed as the data was modified
by the command line.
.SS "Generation of configuration documentation"
.IX Subsection "Generation of configuration documentation"
.Vb 1
\&  config\-edit \-model Popcon \-gen\-pod [ output_dir ]
.Ve
.PP
Generate pod documentation on \s-1STDOUT\s0 or write them in the specified directory. Note that
one pod file will be created per class.
.PP
To get man pages or text docuement, you can pipe the output of the command:
.PP
.Vb 1
\& config\-edit \-model Popcon \-doc  | pod2man > popcon\-conf.3
.Ve
.SH "Options"
.IX Header "Options"
.IP "application" 4
.IX Item "application"
Application name to be configured. Specify \f(CW\*(C`help\*(C'\fR to get a list of available 
applications.
.IP "file" 4
.IX Item "file"
Configuration file name. Used only for models without standard configuration 
file name. (e.g. multistrap)
.IP "\-model" 4
.IX Item "-model"
Specifies the model used to edit configuration data. Specify \f(CW\*(C`help\*(C'\fR to
get a list of available applications. This option is ignored when \f(CW\*(C`\-
application\*(C'\fR is specified
.IP "\-ui" 4
.IX Item "-ui"
Specify the user interface type.
.RS 4
.IP "\(bu" 4
\&\f(CW\*(C`tk\*(C'\fR: provides a Tk graphical interface (If Config::Model::TkUI is
installed).
.IP "\(bu" 4
\&\f(CW\*(C`curses\*(C'\fR: provides a curses user interface (If
Config::Model::CursesUI is installed).
.IP "\(bu" 4
\&\f(CW\*(C`shell\*(C'\fR: provides a shell like interface.  See Config::Model::TermUI
for details.
.IP "\(bu" 4
\&\f(CW\*(C`fuse\*(C'\fR: provides an interface through a \s-1FUSE\s0 virtual file system. You must give a directory where
the virtual file system will be mounted with option \f(CW\*(C`\-fuse_dir\*(C'\fR. 
To stop (and write the configuration data back to the configuration file), 
run \f(CW\*(C`fusermount \-u <mounted_fuse_dir>\*(C'\fR. (This is experimental. Mount point 
specification may change in the future)
.IP "\(bu" 4
\&\f(CW\*(C`none\*(C'\fR: No \s-1UI\s0 provided. Only command line arguments are handled.
.RE
.RS 4
.RE
.IP "\-dev" 4
.IX Item "-dev"
Use this option if you want to test a model under development. This
option will add \f(CW\*(C`lib\*(C'\fR in \f(CW@INC\fR and use \f(CW\*(C`lib/Config/Model/models\*(C'\fR
as model directory. This option is ignored when run as root.
.IP "\-model\-dir" 4
.IX Item "-model-dir"
Specify an alternate directory to find model files. Mostly useful for
tests.
.IP "\-instance\-name" 4
.IX Item "-instance-name"
Specify an instance name. By default the instance name is copied from
model name.
.IP "\-root\-dir" 4
.IX Item "-root-dir"
Specify a pseudo root directory to read and write the configuration
files. (Actual default directory and file names depends on the model
(See \f(CW\*(C`\-model\*(C'\fR option). For instance, if you specify \f(CW\*(C`~/mytest\*(C'\fR, the
\&\f(CW\*(C`/etc/ssh/sshd_config\*(C'\fR files will be written in \f(CW\*(C`~/mytest/etc/ssh/\*(C'\fR
directory.
.IP "\-config\-file" 4
.IX Item "-config-file"
Specify the configuration file to edit (which may override the file specified by the model).
 Note that some applicaitions (like multistrap)
will require this option. For other models (like Debian::Dpkg), this option may not make sense
as several files are used.
.IP "\-verbose" 4
.IX Item "-verbose"
Be (very) verbose
.IP "\-debug" 4
.IX Item "-debug"
Provide debug infos.
.IP "\-trace" 4
.IX Item "-trace"
Provides a full stack trace when exiting on error.
.IP "\-force\-load" 4
.IX Item "-force-load"
Load file even if error are found in data. Bad data are discarded
.IP "\-apply\-fixes" 4
.IX Item "-apply-fixes"
Apply fixes mentioned in model description. 
For details, see \f(CW\*(C`warn_if_match\*(C'\fR or \f(CW\*(C`warn_unless_match\*(C'\fR 
in "" in Config::Model::Value. Configuration files will be saved if 
invoked with \f(CW\*(C`\-ui none\*(C'\fR .
.IP "\-backend" 4
.IX Item "-backend"
Specify a read/write backend. The actual backend name depends on the model
passed to \f(CW\*(C`\-model\*(C'\fR option. See Config::Model::AutoRead for details.
.IP "\-dump [ file ]" 4
.IX Item "-dump [ file ]"
Dump configuration content on \s-1STDOUT\s0 or in the specified with
Config::Model syntax.
.Sp
By default, dump only custom values, i.e. different from application
built-in values or model default values. See \-dumptype option for
other types of dump
.IP "\-dumptype [ full | preset | custom ]" 4
.IX Item "-dumptype [ full | preset | custom ]"
Choose to dump every values (full), only preset values or only
customized values (default)
.IP "\-load <cds_file_to_load>" 4
.IX Item "-load <cds_file_to_load>"
Load configuration data in model from cds file (using Config::Model
serialisation format, typically done with \-dump option). When this
option is used, the usual configuration files will not be read.
.Sp
If used with \f(CW\*(C`\-ui none\*(C'\fR, this option will load configuration data, 
validate it and save it in configuration file (if no error was found).
.IP "\-save" 4
.IX Item "-save"
Force re-writing the configuration. (useful for configuration upgrade)
.IP "\-open\-item 'path'" 4
.IX Item "-open-item 'path'"
In graphical mode, force the \s-1UI\s0 to open the node specified. E.g.
.Sp
.Vb 1
\& \-open\-item \*(Aqfoo bar\*(Aq
.Ve
.IP "\-fuse\-dir" 4
.IX Item "-fuse-dir"
Directory where the \s-1FUSE\s0 virtual file system will be mounted (with \f(CW\*(C`\-ui fuse\*(C'\fR)
.SH "Search"
.IX Header "Search"
You can search the configuration with the following options
.IP "\-search" 4
.IX Item "-search"
Specifies a string or pattern to search. \f(CW\*(C`config\-edit\*(C'\fR will a list of path pointing 
to the matching tree element and their value. 
See \*(L"grab(...)\*(R" in Config::Model::AnyThing for details
on the path syntax.
.IP "\-narrow\-search" 4
.IX Item "-narrow-search"
Narrows down the search to:
.RS 4
.IP "element" 4
.IX Item "element"
.PD 0
.IP "value" 4
.IX Item "value"
.IP "key" 4
.IX Item "key"
.IP "summary" 4
.IX Item "summary"
.PD
Summary text
.IP "description" 4
.IX Item "description"
description text
.IP "help" 4
.IX Item "help"
value help text
.RE
.RS 4
.RE
.SH "Embedding config-edit"
.IX Header "Embedding config-edit"
You can use config-edit from another program by using \f(CW\*(C`\-ui simple\*(C'\fR
option. This way you will be able to send command on the standard input
of \f(CW\*(C`config\-edit\*(C'\fR and get the results from the standard output.
.SH "Saving configuration data"
.IX Header "Saving configuration data"
Configuration data are saved only when :
.IP "\(bu" 4
Requested through the user interface
.IP "\(bu" 4
When commands are specified with arguments
.IP "\(bu" 4
When \f(CW\*(C`\-load\*(C'\fR option is used
.IP "\(bu" 4
When \f(CW\*(C`\-save\*(C'\fR option is used
.PP
You can run safely \f(CW\*(C`config\-edit \-ui none\*(C'\fR to test a configuration,
configuration files will not be modified in this case.
.SH "Logging"
.IX Header "Logging"
All Config::Model logging is now based on Log::Log4perl. 
Logging can be configured in the following files:
.IP "\(bu" 4

.Sp
.Vb 1
\& ~/.log4config\-model
.Ve
.IP "\(bu" 4

.Sp
.Vb 1
\& /etc/log4config\-model.conf
.Ve
.PP
Without these files, the following Log4perl config is used:
.PP
.Vb 5
\& log4perl.logger=WARN, Screen
\& log4perl.appender.Screen        = Log::Log4perl::Appender::Screen
\& log4perl.appender.Screen.stderr = 0
\& log4perl.appender.Screen.layout = Log::Log4perl::Layout::PatternLayout
\& log4perl.appender.Screen.layout.ConversionPattern = %d %m %n
.Ve
.PP
Log4perl uses the following categories:
.IP "Anything" 4
.IX Item "Anything"
.PD 0
.IP "Backend" 4
.IX Item "Backend"
.IP "Backend::Debian::Dpkg" 4
.IX Item "Backend::Debian::Dpkg"
.IP "Backend::Debian::Dpkg::Control" 4
.IX Item "Backend::Debian::Dpkg::Control"
.IP "Backend::Debian::Dpkg::Copyright" 4
.IX Item "Backend::Debian::Dpkg::Copyright"
.IP "Backend::Fstab" 4
.IX Item "Backend::Fstab"
.IP "Backend::IniFile" 4
.IX Item "Backend::IniFile"
.IP "Backend::PlainFile" 4
.IX Item "Backend::PlainFile"
.IP "Backend::ShellVar" 4
.IX Item "Backend::ShellVar"
.IP "Backend::Yaml" 4
.IX Item "Backend::Yaml"
.IP "FuseUI" 4
.IX Item "FuseUI"
.IP "Instance" 4
.IX Item "Instance"
.IP "Loader" 4
.IX Item "Loader"
.IP "Model::Searcher" 4
.IX Item "Model::Searcher"
.IP "Tree::Element::CheckList" 4
.IX Item "Tree::Element::CheckList"
.IP "Tree::Element::Id" 4
.IX Item "Tree::Element::Id"
.IP "Tree::Element::Id::Hash" 4
.IX Item "Tree::Element::Id::Hash"
.IP "Tree::Element::Id::List" 4
.IX Item "Tree::Element::Id::List"
.IP "Tree::Element::Value" 4
.IX Item "Tree::Element::Value"
.IP "Tree::Element::Value::Dependency" 4
.IX Item "Tree::Element::Value::Dependency"
.IP "Tree::Node" 4
.IX Item "Tree::Node"
.IP "Tree::Node::Warped" 4
.IX Item "Tree::Node::Warped"
.IP "ValueComputer" 4
.IX Item "ValueComputer"
.IP "Warper" 4
.IX Item "Warper"
.IP "Wizard::Helper" 4
.IX Item "Wizard::Helper"
.IP "Model" 4
.IX Item "Model"
.PD
.PP
More categories will come.
.SH "SUPPORT"
.IX Header "SUPPORT"
For support, please check the following resources:
.IP "\(bu" 4
The config-model users mailing list:
.Sp
.Vb 1
\& config\-model\-users at lists.sourceforge.net
.Ve
.IP "\(bu" 4
The config-model wiki: <http://config\-model.wiki.sourceforge.net/>
.SH "FEEDBACKS"
.IX Header "FEEDBACKS"
Feedback from users are highly desired. If you find this module useful, please
share your use cases, success stories with the author or with the config\-model\-
users mailing list.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dominique Dumont, ddumont at cpan dot org
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Config::Model::Model, 
Config::Model::Instance, 
Config::Model::Node, 
Config::Model::HashId,
Config::Model::ListId,
Config::Model::WarpedNode,
Config::Model::Value