mirrors/dotdrop
1
0
Fork 0
mirror of https://github.com/deadc0de6/dotdrop.git synced 2026-02-04 18:34:48 +00:00
Code Activity

doc fix links

Browse Source
This commit is contained in:
deadc0de6
2020-09-12 15:06:36 +02:00
parent 7be2eeff45
commit fecf2adaa9
12 changed files with 82 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/config/config-variables.md
View File

@@ -1,6 +1,6 @@
# Config variables
* [Config available variables](available-variables)
* [Config available variables](#available-variables)
* [Variables entry](#variables-entry)
* [Profile variables](#profile-variables)
* [Config variables in templates](#config-variables-in-templates)
@@ -8,12 +8,12 @@
---
# Config available variables
# Available variables
Multiple variables can be used within the config file to
parametrize following elements of the config:
* dotfiles `src` and `dst` paths (see [Dynamic dotfile paths](config#dynamic-dotfile-paths))
* dotfiles `src` and `dst` paths (see [Dynamic dotfile paths](config.md#dynamic-dotfile-paths))
* external path specifications
* `import_variables`
* `import_actions`
@@ -22,8 +22,8 @@ parametrize following elements of the config:
`actions` and `transformations` also support the use of variables
but those are resolved when the action/transformation is executed
(see [Dynamic actions](config#dynamic-actions),
[Dynamic transformations](config#dynamic-transformations) and [Templating](templating)).
(see [Dynamic actions](config.md#dynamic-actions),
[Dynamic transformations](config.md#dynamic-transformations) and [Templating](../template/templating.md)).
Following variables are available in the config files:
@@ -31,9 +31,9 @@ Following variables are available in the config files:
* [interpreted variables defined in the config](#interpreted-variables-entry)
* [profile variables defined in the config](#profile-variables)
* environment variables: `{{@@ env['MY_VAR'] @@}}`
* dotdrop header: `{{@@ header() @@}}` (see [Dotdrop header](templating#dotdrop-header))
* dotdrop header: `{{@@ header() @@}}` (see [Dotdrop header](../template/templating.md#dotdrop-header))
As well as all template methods (see [Available methods](templating#available-methods))
As well as all template methods (see [Available methods](../template/templating.md#available-methods))
# Variables entry
@@ -89,7 +89,7 @@ profiles:
# Config variables in templates
`variables` and `dynvariables` are also made available in templates
(see [Template variables](templating#template-variables)).
(see [Template variables](../template/templating.md#template-variables)).
Variables in the config file
```yaml

56
docs/config/config.md
View File

@@ -49,18 +49,18 @@ Content Format:
one that will be installed by dotdrop (default *true*)
* `banner`: display the banner (default *true*)
* `cmpignore`: list of patterns to ignore when comparing, apply to all dotfiles
(enclose in quotes when using wildcards, see [ignore patterns](ignore-pattern))
(enclose in quotes when using wildcards, see [ignore patterns](ignore-pattern.md))
* `create`: create directory hierarchy when installing dotfiles if
it doesn't exist (default *true*)
* `default_actions`: list of action's keys to execute for all installed dotfile
(see [Use actions](usage-actions))
(see [Use actions](usage-actions.md))
* `diff_command`: the diff command to use for diffing files (default `diff -r -u {0} {1}`)
* `dotpath`: path to the directory containing the dotfiles to be managed (default `dotfiles`)
by dotdrop (absolute path or relative to the config file location)
* `filter_file`: list of paths to load templating filters from
(see [Templating available filters](templating#available-filters))
(see [Templating available filters](../template/templating.md#available-filters))
* `func_file`: list of paths to load templating functions from
(see [Templating available methods](templating#available-methods))
(see [Templating available methods](../template/templating.md#available-methods))
* `ignoreempty`: do not deploy template if empty (default *false*)
* `import_actions`: list of paths to load actions from
(absolute path or relative to the config file location,
@@ -72,7 +72,7 @@ Content Format:
(absolute path or relative to the config file location,
see [Import variables from file](#import-variables-from-file))
* `instignore`: list of patterns to ignore when installing, apply to all dotfiles
(enclose in quotes when using wildcards, see [ignore patterns](ignore-pattern))
(enclose in quotes when using wildcards, see [ignore patterns](ignore-pattern.md))
* `keepdot`: preserve leading dot when importing hidden file in the `dotpath` (default *false*)
* `link_dotfile_default`: set dotfile's `link` attribute to this value when undefined.
Possible values: *nolink*, *link*, *link_children* (default: *nolink*,
@@ -81,11 +81,11 @@ Content Format:
Possible values: *nolink*, *link*, *link_children* (default: *nolink*,
see [Symlinking dotfiles](#symlinking-dotfiles))
* `longkey`: use long keys for dotfiles when importing (default *false*,
see [Import dotfiles](usage#import-dotfiles))
see [Import dotfiles](../usage.md#import-dotfiles))
* `minversion`: (*for internal use, do not modify*) provides the minimal dotdrop version to use
* `showdiff`: on install show a diff before asking to overwrite (see `--showdiff`) (default *false*)
* `upignore`: list of patterns to ignore when updating, apply to all dotfiles
(enclose in quotes when using wildcards, see [ignore patterns](ignore-pattern))
(enclose in quotes when using wildcards, see [ignore patterns](ignore-pattern.md))
* `workdir`: path to the directory where templates are installed before being symlinked
when using `link:link` or `link:link_children`
(absolute path or relative to the config file location, defaults to *~/.config/dotdrop*)
@@ -102,18 +102,18 @@ Content Format:
Possible values: *nolink*, *link*, *link_children* (default: `link_dotfile_default`,
see [Symlinking dotfiles](#symlinking-dotfiles))
* `actions`: list of action keys that need to be defined in the **actions** entry below
(see [Use actions](usage-actions))
(see [Use actions](usage-actions.md))
* `cmpignore`: list of patterns to ignore when comparing (enclose in quotes when using wildcards,
see [ignore patterns](ignore-pattern))
see [ignore patterns](ignore-pattern.md))
* `ignoreempty`: if true empty template will not be deployed (defaults to the value of `ignoreempty` above)
* `instignore`: list of patterns to ignore when installing (enclose in quotes when using wildcards,
see [ignore patterns](ignore-pattern))
see [ignore patterns](ignore-pattern.md))
* `trans_read`: transformation key to apply when installing this dotfile
(must be defined in the **trans_read** entry below, see [Use transformations](usage-transformations))
(must be defined in the **trans_read** entry below, see [Use transformations](usage-transformations.md))
* `trans_write`: transformation key to apply when updating this dotfile
(must be defined in the **trans_write** entry below, see [Use transformations](usage-transformations))
(must be defined in the **trans_write** entry below, see [Use transformations](usage-transformations.md))
* `upignore`: list of patterns to ignore when updating (enclose in quotes when using wildcards,
see [ignore patterns](ignore-pattern))
see [ignore patterns](ignore-pattern.md))
* DEPRECATED `link_children`: replaced by `link: link_children`
* DEPRECATED `trans`: replaced by `trans_read`
@@ -149,7 +149,7 @@ Content Format:
* `dynvariables`: profile specific interpreted variables
(see [Interpreted variables](#interpreted-variables))
* `actions`: list of action keys that need to be defined in the **actions** entry below
(see [Use actions](usage-actions))
(see [Use actions](usage-actions.md))
```yaml
<some-profile-name-usually-the-hostname>:
@@ -173,21 +173,21 @@ Content Format:
- ...
```
* **actions** entry (optional): a list of actions (see [Use actions](usage-actions))
* **actions** entry (optional): a list of actions (see [Use actions](usage-actions.md))
```yaml
actions:
<action-key>: <command-to-execute>
```
* **trans_read** entry (optional): a list of transformations (see [Use transformations](usage-transformations))
* **trans_read** entry (optional): a list of transformations (see [Use transformations](usage-transformations.md))
```yaml
trans_read:
<trans-key>: <command-to-execute>
```
* **trans_write** entry (optional): a list of write transformations (see [Use transformations](usage-transformations))
* **trans_write** entry (optional): a list of write transformations (see [Use transformations](usage-transformations.md))
```yaml
trans_write:
@@ -211,19 +211,19 @@ dynvariables:
# Actions
see [Actions](usage-actions)
see [Actions](usage-actions.md)
# Transformations
see [Transformations](usage-transformations)
see [Transformations](usage-transformations.md)
# Variables
see [Variables](config-variables)
see [Variables](config-variables.md)
# Interpreted variables
see [Interpreted variables](config-variables)
see [Interpreted variables](config-variables.md)
# Symlinking dotfiles
@@ -234,7 +234,7 @@ which are controlled by the `link` attribute of each dotfile:
* `link: link`: the dotfile (file or directory) is symlinked to its destination
* `link: link_children`: the files/directories found under the dotfile (directory) are symlinked to their destination
For more see [this how-to](symlinked-dotfiles)
For more see [this how-to](../howto/symlinked-dotfiles.md)
# All dotfiles for a profile
@@ -282,7 +282,7 @@ profiles:
Here profile *host1* contains all the dotfiles defined for *host2* plus `f_xinitrc`.
For more advanced use-cases variables
([variables](config-variables) and [dynvariables](config-variables))
([variables](config-variables.md) and [dynvariables](config-variables.md))
can be used to specify the profile to include in a profile
For example:
@@ -498,7 +498,7 @@ import_configs:
# Dynamic dotfile paths
Dotfile source (`src`) and destination (`dst`) can be dynamically constructed using
defined variables ([variables and dynvariables](config-variables)).
defined variables ([variables and dynvariables](config-variables.md)).
For example to have a dotfile deployed on the unique firefox profile where the
profile path is dynamically found using a shell oneliner stored in a dynvariable:
@@ -519,8 +519,8 @@ Make sure to quote the path in the config file.
# Dynamic actions
Variables ([config variables and dynvariables](config-variables)
and [template variables](templating#template-variables)) can be used
Variables ([config variables and dynvariables](config-variables.md)
and [template variables](../template/templating.md#template-variables)) can be used
in actions for more advanced use-cases.
```yaml
@@ -553,8 +553,8 @@ Make sure to quote the actions using variables.
# Dynamic transformations
As for [dynamic actions](#dynamic-actions), transformations support
the use of variables ([variables and dynvariables](config-variables)
and [template variables](templating#template-variables)).
the use of variables ([variables and dynvariables](config-variables.md)
and [template variables](../template/templating.md#template-variables)).
A very dumb example:
```yaml

12
docs/config/ignore-pattern.md
View File

@@ -8,13 +8,13 @@
It is possible to ignore specific patterns when using dotdrop. For example for `compare` when temporary
files don't need to appear in the output.
* for [install](usage#install-dotfiles)
* using `instignore` in [the config file](config)
* for [compare](usage#compare-dotfiles)
* using `cmpignore` in [the config file](config)
* for [install](../usage.md#install-dotfiles)
* using `instignore` in [the config file](config.md)
* for [compare](../usage.md#compare-dotfiles)
* using `cmpignore` in [the config file](config.md)
* using the command line switch `-i --ignore`
* for [update](usage#update-dotfiles)
* using `upignore` in [the config file](config)
* for [update](../usage.md#update-dotfiles)
* using `upignore` in [the config file](config.md)
* using the command line switch `-i --ignore`
The ignore pattern must follow Unix shell-style wildcards like for example `*/path/to/file`.

10
docs/config/usage-transformations.md
View File

@@ -11,14 +11,14 @@ This can be useful when working with sensitive data containing passwords for exa
There are two types of transformations available:
* **read transformations**: used to transform dotfiles before they are installed ([Config](config) key `trans_read`)
* **read transformations**: used to transform dotfiles before they are installed ([Config](config.md) key `trans_read`)
* Used for commands `install` and `compare`
* They have two arguments:
* **{0}** will be replaced with the dotfile to process
* **{1}** will be replaced with a temporary file to store the result of the transformation
* Happens **before** the dotfile is templated with jinja2 (see [templating](templating))
* Happens **before** the dotfile is templated with jinja2 (see [templating](../template/templating.md))
* **write transformations**: used to transform files before updating a dotfile ([Config](config) key `trans_write`)
* **write transformations**: used to transform files before updating a dotfile ([Config](config.md) key `trans_write`)
* Used for command `update`
* They have two arguments:
* **{0}** will be replaced with the file path to update the dotfile with
@@ -54,5 +54,5 @@ will result in `abc; f_abc; p1; lastarg`
See
* [Store compressed directories](store-compressed-directories)
* [Sensitive dotfiles](sensitive-dotfiles)
* [Store compressed directories](../howto/store-compressed-directories.md)
* [Sensitive dotfiles](../howto/sensitive-dotfiles.md)