Skip to content

Commit

Permalink
Improve documentation of chezmoi edit
Browse files Browse the repository at this point in the history
  • Loading branch information
twpayne committed Jun 23, 2021
1 parent ef49f6a commit 32d4a92
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -929,7 +929,15 @@ $ chezmoi dump --format=yaml
### `edit` [*target*...]

Edit the source state of *target*s, which must be files or symlinks. If no
targets are given the the source directory itself is opened with `$EDITOR`.
targets are given the the source directory itself is opened.

The editor used is the first non-empty string of the `edit.command`
configuration variable, the `$VISUAL` environment variable, the `$EDITOR`
environment variable. If none are set then chezmoi falls back to `notepad.exe`
on Windows systems and `vi` on non-Windows systems.

When the `edit.command` configuration variable is used, extra arguments can be
passed to the editor with the `editor.args` configuration variable.

#### `-a`, `--apply`

Expand Down

0 comments on commit 32d4a92

Please sign in to comment.