diff options
| author | Canop <cano.petrole@gmail.com> | 2019-03-07 20:54:06 +0100 |
|---|---|---|
| committer | Canop <cano.petrole@gmail.com> | 2019-03-07 20:54:06 +0100 |
| commit | c30ad3106ada0835c6a9260088a4678e548037be (patch) | |
| tree | 69d8d5b64ad843def0cbb3c30eba3931bf3aa265 | |
| parent | f7f1ca0dc436ed9e0a9129f9444f174a82777bcb (diff) | |
precisions on verb configuration in documentation
| -rw-r--r-- | website/docs/documentation/configuration.md | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/website/docs/documentation/configuration.md b/website/docs/documentation/configuration.md index 6433ac9..46b2253 100644 --- a/website/docs/documentation/configuration.md +++ b/website/docs/documentation/configuration.md @@ -14,6 +14,8 @@ Currently, you can configure # Verbs +## Verb Definition Attributes + You can define a new verb in the TOML configuration file with a `[[verbs]]` section similar to this one: [[verbs]] @@ -21,7 +23,7 @@ You can define a new verb in the TOML configuration file with a `[[verbs]]` sect shortcut = "e" execution = "/usr/bin/nvim {file}" -## Verb Definition Attributes +The possible attributes are: name | mandatory | role -|-|- @@ -52,8 +54,15 @@ Its interest is that if you do `:p`, then `enter`, it is executed even while the Use shortcuts for verbs you frequently use. +### Verbs not leaving broot + +If you set `leave_broot = false`, broot won't quit when executing your command, but it will update the tree. + +This is useful for commands modifying the tree (like creating or moving files). + +There's currently a limitation: terminal based programs don't properly run if broot isn't closed before. It means you can't for example set `leave_broot = false` in verbs launching `vi` or `emacs`. -### Arguments +## Verb Arguments The execution of a verb can take one or several arguments. |