diff options
| -rw-r--r-- | README.md | 36 |
1 files changed, 23 insertions, 13 deletions
@@ -99,7 +99,8 @@ Here is how the light terminal scheme looks: ### Location of Config File -`bibiman` can be configured through a config file. The standard location is the user's config dir following the XDG scheme. On Linux systems this defaults to: +`bibiman` can be configured through a config file. The standard location is the +user's config dir following the XDG scheme. On Linux systems this defaults to: ```bash # XDG scheme: @@ -107,7 +108,13 @@ $XDG_CONFIG_HOME/bibiman/bibiman.toml # Fallback: $HOME/.config/bibiman/bibiman.toml +``` + +You can set a custom config file through the CLI (`-c`/`--config-file=` flag) +which takes precedence over the standard one for the active session: +```bash +bibiman --config-file="/path/to/temporary/config" ``` ### Values @@ -122,32 +129,33 @@ bibfiles = [ "/path/to/bibfile", "path/to/dir/with/bibfiles" ] editor = "vim" # with args: "vim -y" ``` -Paths to bibfiles/dirs passed through the CLI will be added to the ones provided by the config file. +Paths to bibfiles/dirs passed through the CLI will be added to the ones provided +by the config file. ## Features These are the current features, the list will be updated: - [x] **Browse** through the bib entries using _Vim-like keybindings_ and a - _fuzzy search_ mode. + _fuzzy search_ mode. - [x] **Filter** the bib entries by _keywords_ (and afterwards filter further by - fuzzy searching). + fuzzy searching). - [x] **Edit** the current entry by opening a _terminal-based editor_ at the - specific line. + specific line. - [x] **Yank/Copy** the citekey of the current entry to the system clipboard. - [x] **Open related PDF** file (`file` BibLaTeX key) with keypress. - [x] **Open related URL/DOI** with keypress. - [x] **Scrollbar** for better navigating. - [x] **Sort Entries** by column (`Authors`, `Title`, `Year`, `Pubtype`), or by - position in bibfile. + position in bibfile. - [x] **Load multiple files** into one session. - [x] **Add Entry via DOI**. - [x] **Implement config file** for setting some default values like main - bibfile, PDF-opener, or editor + bibfile, PDF-opener, or editor - [ ] **Open related notes file** for specific entry. - [ ] **Support Hayagriva(`.yaml`)** format as input (_on hold for now_, because - the Hayagriva Yaml style doesn't offer keywords; s. issue in - [Hayagriva repo](https://github.com/typst/hayagriva/issues/240)). + the Hayagriva Yaml style doesn't offer keywords; s. issue in + [Hayagriva repo](https://github.com/typst/hayagriva/issues/240)). **Please feel free to suggest further features through the issue functionality.** @@ -187,17 +195,19 @@ enabled by default. You can use some special chars to alter pattern matching: ## Edit bib entry -The main editor can be set through the [config file](#values). Otherwise, the environment variables -`VISUAL` and `EDITOR` will be used in this order. The last fallback solution is `vi`. +The main editor can be set through the [config file](#values). Otherwise, the +environment variables `VISUAL` and `EDITOR` will be used in this order. The last +fallback solution is `vi`. -I've tested the following editors (set as value of `VISUAL` and through the config file): +I've tested the following editors (set as value of `VISUAL` and through the +config file): - [x] **Helix**: `export VISUAL="hx"` - [x] **Vim/Neovim**: `export VISUAL="vim/nvim"` - [x] **Emacs (Terminal)**: `export VISUAL="emacs -nw"` - [x] **Nano**: `export VISUAL="nano"` - [x] **Emacs (GUI)**: `export VISUAL="emacs"` (open emacs in separate window, - blocks the terminal running `bibiman` as long as emacs is opened) + blocks the terminal running `bibiman` as long as emacs is opened) Feel free to try other editors and report. Important is that the editor supports the argument `+..` to set the line number that the cursor should be placed at. |