aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index ed620e8..c8ea715 100644
--- a/README.md
+++ b/README.md
@@ -193,6 +193,8 @@ set through the CLI, `bibiman` will offer to create a default config file at the
standard location. This will very likely happen on the first run of `bibiman`
after installation. If rejected, you probably will be asked again next time.
+The created config contains all values which are set as default by `bibiman`.
+
### General Configuration<a name="general-configuration"></a>
The following general values can be set through the config file:
@@ -202,19 +204,25 @@ The following general values can be set through the config file:
# Default files/dirs which are loaded on startup
# Use absolute paths (~ for HOME works). Otherwise, loading might not work.
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"
+
# Prefix which is prepended to the filepath from the `file` field
# Use absolute paths (~ for HOME works). Otherwise, loading might not work.
file_prefix = "/some/path/prefix"
+
# Path to folder (with subfolders) containing PDF files with the basename
# of the format "citekey.pdf". Other PDF basenames are not accepted.
# Use absolute paths (~ for HOME works). Otherwise, loading might not work.
pdf_path = "/path/to/pdf-folder"
+
## Path to folder (with subfolders) containing note files with the basename of
## the format "citekey.extension". Other basenames are not accepted. The possible
## extensions can be set through the "note_extensions" array.
@@ -222,9 +230,9 @@ note_path = "path/to/note-files"
note_extensions = [ "md", "txt" ]
## Symbols/chars to show if not has specific attachement
- file_symbol = " "
- link_symbol = "󰌹 "
- note_symbol = "󰧮"
+file_symbol = " "
+link_symbol = "󰌹 "
+note_symbol = "󰧮"
```
`bibfiles`