From f137fac71923e38225c079267640da1d3fd16e85 Mon Sep 17 00:00:00 2001 From: deadc0de6 Date: Sat, 30 Oct 2021 14:41:43 +0200 Subject: [PATCH] update doc --- docs/config-format.md | 2 +- docs/usage.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/config-format.md b/docs/config-format.md index 10ea38c..36ea314 100644 --- a/docs/config-format.md +++ b/docs/config-format.md @@ -15,7 +15,7 @@ Entry | Description | Default `banner` | Display the banner | true `check_version` | Check if a new version of dotdrop is available on github | false `chmod_on_import` | Always add a chmod entry on newly imported dotfiles (see `--preserve-mode`) | false -`clear_workdir` | Clear the `workdir` before install | false +`clear_workdir` | On `install` clear the `workdir` before installing dotfiles (see `--workdir-clear`) | false `cmpignore` | List of patterns to ignore when comparing, applied to all dotfiles (enclose in quotes when using wildcards; see [ignore patterns](config.md#ignore-patterns)) | - `create` | Create a directory hierarchy when installing dotfiles if it doesn't exist | true `default_actions` | List of action keys to execute for all installed dotfiles (See [actions](config-details.md#actions-entry)) | - diff --git a/docs/usage.md b/docs/usage.md index 69bd2dc..298a810 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -87,6 +87,7 @@ Some available options: Note that actions are not executed in this mode. * `-a`/`--force-actions`: Force the execution of actions even if the dotfiles are not installed * `-f`/`--force`: Do not ask for any confirmation +* `-W`/`--workdir-clear`: Clear the `workdir` before installing dotfiles (see config entry `clear_workdir`) To ignore specific patterns during installation, see [the ignore patterns](config.md#ignore-patterns).