aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorlukeflo2025-02-19 21:42:57 +0100
committerlukeflo2025-02-19 21:42:57 +0100
commitf60be8b6b1e5987613081c9ad8d63a26a1a1bac9 (patch)
treeccab6a52dd2112f070e5ce6526bd942b54be2806 /README.md
parentdc5ded8160177864963a31476c2a7afe8ca8e834 (diff)
downloadbibiman-f60be8b6b1e5987613081c9ad8d63a26a1a1bac9.tar.gz
bibiman-f60be8b6b1e5987613081c9ad8d63a26a1a1bac9.zip
remove some comments, update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/README.md b/README.md
index 47d57de..d62c847 100644
--- a/README.md
+++ b/README.md
@@ -56,7 +56,7 @@ POSITIONAL ARGS:
FLAGS:
-h, --help Show this help and exit
-v, --version Show the version and exit
- -c, --config-file Path to config file for current session
+ -c, --config-file= Path to config file for current session needed as argument.
Takes precedence over standard config file
--light-terminal Enable color mode for light terminal background
@@ -129,10 +129,17 @@ At the moment, the following values can be set through the config file:
bibfiles = [ "/path/to/bibfile", "path/to/dir/with/bibfiles" ]
# Default editor to use when editing files. Arguments are possible
editor = "vim" # with args: "vim -y"
+# Default app to open PDFs/Epubs
+pdf_opener = "xdg-open"
+# Default app to open URLs/DOIs
+url_opener = "xdg-open"
```
-Paths to bibfiles/dirs passed through the CLI will be added to the ones provided
-by the config file.
+No value *needs* to be set. For every one exists a default value. Only exception
+is the `bibfiles` key. If no file or dir is set, you *have to* add a path via
+CLI interface. If the `bibfiles` value is set *and* a further path (or multiple)
+is provided through the CLI call, the entries of all those files will be opened
+in the started `bibiman` session.
## Features