mirror of
https://github.com/deadc0de6/dotdrop.git
synced 2026-02-07 20:19:23 +00:00
add doc
This commit is contained in:
16
docs/config/config-config.md
vendored
16
docs/config/config-config.md
vendored
@@ -4,7 +4,7 @@ The **config** entry (mandatory) contains global settings.
|
|||||||
|
|
||||||
Entry | Description | Default
|
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
|
`banner` | Display the banner | true
|
||||||
`check_version` | Check if a new version of dotdrop is available on github | false
|
`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
|
`chmod_on_import` | Always add a chmod entry on newly imported dotfiles (see `--preserve-mode`) | false
|
||||||
@@ -212,4 +212,16 @@ profiles:
|
|||||||
hostname:
|
hostname:
|
||||||
dotfiles:
|
dotfiles:
|
||||||
- f_vimrc
|
- f_vimrc
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 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)),
|
||||||
15
docs/usage.md
vendored
15
docs/usage.md
vendored
@@ -234,6 +234,21 @@ dotdrop. It will:
|
|||||||
|
|
||||||
For more options, see the usage with `dotdrop --help`.
|
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
|
## Concurrency
|
||||||
|
|
||||||
The command line switch `-w`/`--workers`, if set to a value greater than one, enables the use
|
The command line switch `-w`/`--workers`, if set to a value greater than one, enables the use
|
||||||
|
|||||||
Reference in New Issue
Block a user