document config-override enhancement

This commit is contained in:
Suhas 2021-01-29 20:11:13 -05:00
parent 7df83aa44a
commit 40f93a9322
2 changed files with 49 additions and 0 deletions

View file

@ -61,6 +61,28 @@ and can be edited with a plain text editor.
Or use the built-in prompt or an external editor to compose your
entries.
### Modifying Configurations from the Command line
You can override a configuration field for the current instance of `jrnl` using `--config-override CONFIG_KEY:CONFIG_VALUE` where `CONFIG_KEY` is a valid configuration field, specified in dot-notation and `CONFIG_VALUE` is the (valid) desired override value.
You can specify multiple overrides as a comma-separated list.
!!! note
These overrides allow you to modify ***any*** field of your jrnl configuration. We trust that you know what you are doing.
#### Examples:
``` sh
#Create an entry using the `stdin` prompt, for rapid logging
jrnl --config-override editor:""
#Populate a project's log
jrnl --config-override journal:"$(git rev-parse --show-toplevel)/todo.txt"
#Pass multiple overrides
jrnl --config-override display_format:fancy,linewrap:20,colors.title:green
```
## Multiple journal files
You can configure `jrnl`to use with multiple journals (eg.