CONFIG-EDIT(1p)

NAME
config-edit - Edit data of configuration managed by Config::Model

SYNOPSIS
  config-edit [options] -model Fstab [ commands  ... ]

DESCRIPTION
Config-model is a general purpose configuration framework.

The config-edit program will use Config::Model configuration descriptions to provide a user interface so user can easily and securely modify the configuration of their system.

You can specify commands as arguments that will be run on the configuration root before launching the UI. These command follow the syntax defined in Config::Model::Loader.

Options

-model
    Mandatory option that specifies the configuration data to be edited. The model must be available in "/etc/config-model.d/" directory in a ".pl" file. E.g. this command:

      config-edit -model Fstab

    will look for "/etc/config-model.d/Fstab.pl" model file. See Config::Model for more details.

-ui Specify the user interface type.

    •   "tk": provides a Tk graphical interface (If Config::Model::TkUI is installed).

    •   "curses": provides a curses user interface (If Config::Model::CursesUI is installed).

    •   "shell": provides a shell like interface. See Config::Model::TermUI for details.

    •   "none": No UI provided. Only command line arguments are handled.

-dev
    Use this option if you want to test a model under development. This option will add "lib" in @INC and use "lib/Config/Model/models" as model directory. This option is ignored when run as root.

-model_dir
    Specify an alternate directory to find model files. Mostly useful for tests.

-instance_name
    Specify an instance_name. By default the instance name is copied from model name.

-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 "-model" option). For instance, if you specify "~/mytest", the "/etc/ssh/sshd_config" files will be written in "~/mytest/etc/ssh/" directory.

-verbose
    Be (very) verbose

-debug
    Provide debug infos.

-trace
    Provides a full stack trace when exiting on error.

-force-load
    Load file even if error are found in data. Bad data are discarded

-backend
    Specify a read/write backend. The actual backend name depends on the model passed to "-model" option. See Config::Model::AutoRead for details.

-dump [ file ]
    Dump configuration content on STDOUT or in the specified with Config::Model syntax.

    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

-dumptype [ full | preset | custom ]
    Choose to dump every values (full), only preset values or only customized values (default)

-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.

    If used with "-ui none", this option will load configuration data, validate it and save it in configuration file (if no error was found).

-save
    Force re-writing the configuration. (useful for configuration upgrade)

Embedding config-edit
You can use config-edit from another program by using "-ui simple" option. This way you will be able to send command on the standard input of "config-edit" and get the results from the standard output.

Saving configuration data
Configuration data are saved only when :

•   Requested through the user interface

•   When commands are specified with arguments

•   When "-load" option is used

•   When "-save" option is used

You can run safely "config-edit -ui none" to test a configuration, configuration files will not be modified in this case.

LOGGING
All Config::Model logging is (slowly) moved from klunky debug and verbose prints to Log::Log4perl. Logging can be configured in the following files:

•

     ~/.log4config-model

•

     /etc/log4config-model.conf

Without these files, the following Log4perl config is used:

 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

Log4perl uses the following categories:

Model
Model::Load
Data
Data::Read
Data::Write
Model::Searcher
Instance
Tree::Element::Value
Tree::Element::Id
Tree::Element::Id::Hash
Tree::Element::Id::List
Tree::Element::Warper
Tree::Element::Warped
Tree::Element::CheckList
Tree::Node
Loader
Backend::Yaml
Wizard::Helper

More categories will come.

SUPPORT
For support, please check the following ressources:

•   The config-model wiki: <http://config-model.wiki.sourceforge.net/>

•   The config-model users mailing list: <http://lists.sourceforge.net/mailman/listinfo/config-model-users>

AUTHOR
Dominique Dumont, ddumont at cpan dot org

SEE ALSO
Config::Model::Model, Config::Model::Instance, Config::Model::Node, Config::Model::HashId, Config::Model::ListId, Config::Model::WarpedNode, Config::Model::Value