summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/README.md b/README.md
index 00094aa..ca7242d 100644
--- a/README.md
+++ b/README.md
@@ -303,7 +303,9 @@ Clean commands are specified as an array of directories to be cleaned.
Clean commands support an extended configuration syntax. In this type of
configuration, commands are specified as directory paths mapping to options. If
the `force` option is set to `true`, dead links are removed even if they don't
-point to a file inside the dotfiles directory.
+point to a file inside the dotfiles directory. If `recursive` is set to `true`,
+the directory is traversed recursively (not recommended for `~` because it will
+be slow).
#### Example
@@ -311,8 +313,10 @@ point to a file inside the dotfiles directory.
- clean: ['~']
- clean:
- ~/.config:
+ ~/:
force: true
+ ~/.config:
+ recursive: true
```
### Defaults