6.3. config:edit, edit

Abstract

begins an editing session for a configuration. If the configuration does not exist a new configuration is created.

Synopsis

config:edit [ --help ] [ --force ] [[ -f ] | [ --use-file ]] { pid }

Details

The config:edit command is the first step in editing a container configuration. It opens the configuration so that calls to the config:* editing commands will update the selected configuration. The edits made by the config:* editing commands are placed in a buffer associated with the selected configuration and not propagated to the container, or the file system, until the editing session is ended by the config:update command.
If you use the config:edit command before saving the changes to a configuration that is open for editing, the changes to the previously open configuration are abandoned. The pending edits cleared without being saved.

Arguments

Table 6.3, “config:edit Arguments” describes the command's arguments.

Table 6.3. config:edit Arguments

OptionInterpretation
--help Displays the online help for this command
--force Forces the editing of this configuration, even if another configuration was being edited
-f, --use-fileUse a filename instead of the PID to locate the configuration
pid The persistent identifier of the configuration