cme (1p)

Contents

NAME
SYNOPSIS
DESCRIPTION
Commands
list
edit
check
migrate
fix
modify
search
dump
fusefs
Global options
Advanced options
Embedding cme
cme extensions
Logging
BUGS
Configuration models can lag behind the target application
SUPPORT
FEEDBACKS
AUTHOR
SEE ALSO

NAME

cme - Edit data of configuration managed by Config::Model

SYNOPSIS

  # general synopsis
  cme [ global_options ] command application [ options ] arguments

  # edit dpkg config with GUI
  cme edit dpkg 

  # edit /etc/sshd_config (requires Config::Model::OpenSsh)
  sudo cme edit sshd
  
  # edit ~/.ssh/config (requires Config::Model::OpenSsh)
  cme edit ssh
  
  # just check the validity of a file 
  cme check multistrap file.conf 
  
  # check dpkg files, update deprecated parameters and save
  cme migrate dpkg 
  
  # like migrate, but also apply all suggested fixes
  cme fix dpkg 
  
  # modify configuration with command line
  cme modify dpkg source 'format="quilt (3.0)"'

  # edit a file (file name specification is mandatory here)
  cme edit multistrap my.conf 

  # map conf data to a fuse file system
  cme fusefs multistrap my.conf -d fuse_dir
  
  # likewise for dpkg data
  cme fusefs dpkg -d fuse_dir
  
  # list all available applications (depends on your installation)
  cme list

DESCRIPTION

"cme" program will use Config::Model configuration descriptions to check or modify or fix configuration files.

Commands

list

Show a list all applications where a model is available. This list depends on installed Config::Model modules.

edit

Edit a configuration. By default, a Tk GUI will be opened If Config::Model::TkUI is installed. You can choose another user interface with the "-ui" option:
•
"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.

check

Checks the content of the configuration file of an application. Prints warnings and errors on STDOUT.

Example: 

 cme check fstab

migrate

Checks the content of the configuration file of an application (and show warnings if needed), update deprecated parameters (old value are saved to new parameters) and save the new configuration.

For more details, see ``Upgrade'' in Config::Model::Value

fix

A bit like "migrate" command, except that warnings are fixed. The configuration is saved if anything was changed. Options are:
from
Use option "-from" to fix only a subset of a configuration tree. Example: 

 cme fix dpkg -from 'control binary:foo Depends'

This option can be repeated: 

 cme fix dpkg -from 'control binary:foo Depends' -from 'control source Build-Depends'
filter
Filter the leaf according to a pattern. The pattern is applied to the element name to be fixed Example: 

 cme fix dpkg -from control -filter Build # will fix all Build-Depends and Build-Depend-Indep

or 

 cme fix dpkg -filter Depend

modify

Modify a configuration file with the values passed on the command line. These command must follow the syntax defined in Config::Model::Loader (which is similar to the output of cme dump command)

Example: 

   cme modify dpkg source format="quilt (3.0)"
   cme modify multistrap my_mstrap.conf sections:base source="http://ftp.fr.debian.org"

This example restores the default value of the text of all GPL like licenses: 

   cme modify dpkg-copyright 'License=~/GPL/ text~'

search

You can search the configuration with the following options
-search
Specifies a string or pattern to search. "cme" will a list of path pointing to the matching tree element and their value. See ``grab(...)'' in Config::Model::AnyThing for details on the path syntax.
-narrow-search
Narrows down the search to:
element
value
key
summary
Summary text
description
description text
help
value help text

Example: 

 $ cme search multistrap my_mstrap.conf -search http -narrow value
 sections:base source -> 'http://ftp.fr.debian.org'
 sections:debian source -> 'http://ftp.uk.debian.org/debian'
 sections:toolchains source -> 'http://www.emdebian.org/debian'

dump

Dump configuration content on STDOUT with Config::Model syntax.

By default, dump only custom values, i.e. different from application built-in values or model default values. You can use the "-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)

fusefs

Map the configuration file content to a FUSE virtual file system on a directory specified with option "-fuse-dir". To stop (and write the configuration data back to the configuration file), run "fusermount -u <mounted_fuse_dir>".

Options:

-fuse-dir
Mandatory. Directory where the virtual file system will be mounted.
-dfuse
Use this option to debug fuse problems.
-dir-char
Fuse will fail if an element name or key name contains '/'. You can specify a subsitution string to replace '/' in the fused dir. Default is "<slash>".

Global options

The following options are available for all commands:
-experience
Change the experience level. By default only parameters with ``beginner'' experience are shown or modifiable. You can choose "advanced" or "master" level to get access to more parameters. Note that experience level can be changed in the GUI with the options menu.
-create
Perform the operation even if the configuration file is missing. This may be used to create a minimal configuration file. This option is disabled by default as a missing configuration file often indicates an error during the installation of the application.
-force-load
Load file even if error are found in data. Bad data are discarded
-backup
Create a backup of configuration files before saving. By default, "old" will be appended to the backup file. I.e. "foo.conf" will be backed up as "foo.conf.old". You can specify an alternate suffix. For instance "-backup dpkg-old".

Advanced options

-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.
-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.
-stack-trace
Provides a full stack trace when exiting on error.
-backend
Specify a read/write backend. The actual backend name depends on the model passed to "-model" option. See Config::Model::BackendMgr for details.
-try-app-as-model
When set, try to load a model using directly the application name specified as 3rd parameter on the command line. Experimental.

Embedding cme

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

cme extensions

New "cme" subcommands can be placed in extensions directory (i.e. in "Config/Model/extensions". When a cme command matched one of this extension, the extension will be run. For instance, if you have: 

 .../Config/Model/extensions/cme-foo

Running "cme foo" will run this program (who must be written in Perl) with the same arguments as "cme".

Logging

All Config::Model logging is now based on Log::Log4perl. Logging can be configured in the following files:
•

 ~/.log4config-model
•

 /etc/log4config-model.conf

A sample of a ".log4config-model" is provided in contrib directory in "Config::Model" distribution of on github <https://github.com/dod38fr/config-model/blob/master/contrib/log4config-model>

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:

Anything
Anything::Change
Trace change notification through configuration tree and instance.
Backend
Backend::Debian::Dpkg
Backend::Debian::Dpkg::Control
Backend::Debian::Dpkg::Copyright
Backend::Fstab
Backend::IniFile
Backend::PlainFile
Backend::ShellVar
Backend::Yaml
FuseUI
Instance
Loader
Model::Searcher
Tree::Element::CheckList
Tree::Element::Id
Tree::Element::Id::Hash
Tree::Element::Id::List
Tree::Element::Value
Tree::Element::Value::Dependency
Tree::Node
Tree::Node::Warped
ValueComputer
Warper
Wizard::Helper
Model

More categories will come.

BUGS

Configuration models can lag behind the target application

If a configuration model is not up-to-date, you will get errors complaining about unknown parameters. In such a case, please file a bug on request tracked <http://rt.cpan.org/> or fix the model and send a pull request. You can see this example from OpenSsh <https://github.com/dod38fr/config-model/wiki/New-parameter-for-openssh-example> to learn how to fix a model.

SUPPORT

For support, please check the following resources:
•
The config-model users mailing list: 

 config-model-users at lists.sourceforge.net
•
The config-model wiki: <http://github.com/dod38fr/config-model/wiki>

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.

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