diff --git a/docs/config/config-config.md b/docs/config/config-config.md index 80747bd..761f174 100644 --- a/docs/config/config-config.md +++ b/docs/config/config-config.md @@ -4,7 +4,7 @@ The **config** entry (mandatory) contains global settings. Entry | Description | Default -------- | ------------- | ------------ -`backup` | Create a backup of the dotfile in case it differs from the one that will be installed by dotdrop | true +`backup` | Create a backup of the existing destination; see [backup entry](config-config.md#backup-entry)) | true `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 @@ -212,4 +212,16 @@ profiles: hostname: dotfiles: - f_vimrc -``` \ No newline at end of file +``` + +## backup entry + +When set to `true`, existing files that would be replaced +by a dotdrop `install`, are backed up with the +extension `.dotdropbak` if their content differ. + +Note: +* directories will **not** be backed up, only files +* when using a different `link` value than `nolink` with directories, + the files under the directory will **not** be backed up + (See [Symlinking dotfiles](config-file.md#symlinking-dotfiles)), \ No newline at end of file diff --git a/docs/usage.md b/docs/usage.md index 75c6d42..50de1f5 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -234,6 +234,21 @@ dotdrop. It will: For more options, see the usage with `dotdrop --help`. +## Uninstall dotfiles + +The `uninstall` command removes dotfiles installed by dotdrop +```bash +$ dotdrop uninstall +``` + +It will remove the installed dotfiles related to the provided key +(or all dotfiles if not provided) of the selected profile. + +If a backup exists ([backup entry](config/config-config.md#backup-entry)), +the file will be restored. + +For more options, see the usage with `dotdrop --help`. + ## Concurrency The command line switch `-w`/`--workers`, if set to a value greater than one, enables the use