Using cme

Dominique Dumont edited this page Nov 3, 2016 · 2 revisions

cme is the main command used to check or edit configuration files.

This command takes 2 main arguments:

  • the action to perform (check, edit, migrate ...)
  • the application whose configuration is to be edited

For instance:

cme edit lcdproc

To know which application are supported, run:

$ cme list
user:
  ssh
system:
  approx
  fstab
  lcdproc
  popcon
  sshd
  system-ssh
application:
  dpkg
  dpkg-control
  dpkg-copyright
  dpkg-patch
  dpkg-patches
  multistrap

The list of supported application is divided in 3 categories:

  • system: for system wide applications (e.g. daemon like sshd)
  • user: for user applications (e.g. ssh configuration)
  • application: misc application like multistrap or Debian packaging

This list depends on which Config::Model model (aka plugin) is installed.

To get the list of available cme commands, type:

$ cme help
cme <command> 

Available commands:
      commands: list the application's commands
          help: display a command's help screen

         check: Check the configuration of an application
          dump: Dump the configuration of an application
          edit: Edit the configuration of an application
           fix: Fix the configuration of an application
        fusefs: Edit the configuration of an application with fuse
 gen-class-pod: Generates pod doc from model files
          list: List applications handled by cme
       migrate: Migrate the configuration of an application
        modify: Modify the configuration of an application
        search: Search the configuration of an application
         shell: Edit the configuration of an application with a shell
        update: Update the configuration of an application

To get more help on each command, you can run cme help <subcmd>. For instance:

$ cme help fix
cme fix [long options...] [application] [ file ]

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 fix warnings are fixed. The configuration
is saved if anything was changed. If no changes are done, the file is
not saved.

Options:

        --from STR...           fix only a subset of a configuration tree
        --filter STR            pattern to select the element name to be fixed
[...snip...]

Available system applications

Available user applications