diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 55 |
1 files changed, 37 insertions, 18 deletions
@@ -1,6 +1,6 @@ <div align="center"> -# Bibiman +# Bibiman<a name="bibiman"></a> <!-- [](https://nogithub.codeberg.page/) --> @@ -8,9 +8,28 @@ </div> -<!-- mdformat-toc start --> - -## TL;DR +<!-- mdformat-toc start --slug=github --maxlevel=6 --minlevel=1 --> + +- [Bibiman](#bibiman) + - [TL;DR](#tldr) + - [Installation](#installation) + - [Usage](#usage) + - [Configuration](#configuration) + - [Location of Config File](#location-of-config-file) + - [General Configuration](#general-configuration) + - [Color Configuration](#color-configuration) + - [Features](#features) + - [Keybindings](#keybindings) + - [Search](#search) + - [Edit bib entry](#edit-bib-entry) + - [Open connected files or links](#open-connected-files-or-links) + - [Issues and code improvement](#issues-and-code-improvement) + - [Alternatives](#alternatives) + - [Comparison](#comparison) + +<!-- mdformat-toc end --> + +## TL;DR<a name="tldr"></a> `bibiman` is a simple terminal user interface for handling your BibLaTeX database as part of a terminal-based scientific workflow. @@ -19,7 +38,7 @@ Here's a small impression how it looks and works: [](https://postimg.cc/zyj2JsXt) -## Installation +## Installation<a name="installation"></a> You can install `bibiman` directly from `crates.io` using `cargo`: @@ -43,7 +62,7 @@ cargo install --path=. --locked ``` -## Usage +## Usage<a name="usage"></a> The following arguments are possible: @@ -89,9 +108,9 @@ bibman tests/multi-files/ bibiman tests/biblatex-test.bib tests/multi-files/ ``` -## Configuration +## Configuration<a name="configuration"></a> -### Location of Config File +### Location of Config File<a name="location-of-config-file"></a> `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: @@ -111,7 +130,7 @@ which takes precedence over the standard one for the active session: bibiman --config-file="/path/to/temporary/config" ``` -### General Configuration +### General Configuration<a name="general-configuration"></a> The following general values can be set through the config file: @@ -133,7 +152,7 @@ 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. -### Color Configuration +### Color Configuration<a name="color-configuration"></a> Furthermore, it is now possible to customize the colors. The following values can be changed: @@ -168,7 +187,7 @@ selected_row_bg_color = "#3a3a3a" # HEX code To run `bibiman` with some default values for a light-colored terminal use the `--light-terminal` flag. -## Features +## Features<a name="features"></a> These are the current features, the list will be updated: @@ -196,7 +215,7 @@ These are the current features, the list will be updated: **Please feel free to suggest further features through the issue functionality.** -## Keybindings +## Keybindings<a name="keybindings"></a> Use the following keybindings to manage the TUI: @@ -220,7 +239,7 @@ Use the following keybindings to manage the TUI: | `ESC` | Abort search / Reset current list | | `q`, `Ctrl-c` | Quit TUI | -## Search +## Search<a name="search"></a> The search mode uses the `nucleo-matcher` crate. Thus, _fuzzy searching_ is enabled by default. You can use some special chars to alter pattern matching: @@ -229,7 +248,7 @@ enabled by default. You can use some special chars to alter pattern matching: - `...$` matches literally at end of the string. - `'...` matches literally everywhere in string. -## Edit bib entry +## Edit bib entry<a name="edit-bib-entry"></a> The main editor can be set through the [config file](#general-configuration). Otherwise, the environment variables `VISUAL` and `EDITOR` will be used in this @@ -253,7 +272,7 @@ While this behaviour is most likely supported on UNIX-based systems (Linux, MacOS), it might not work under Windows. I can't test it on a Windows machine, thus, there might be unexpected errors with it. -## Open connected files or links +## Open connected files or links<a name="open-connected-files-or-links"></a> `bibiman` also provides the possibility to open PDFs (as value of the `file` BibLaTeX field), as well as DOIs and URLs. @@ -269,12 +288,12 @@ Furthermore, DOIs have to begin with either `https://doi...` as full URL or `10.(...)` as regular DOI style. URLs work if they begin with either `http...` or with `www...`. -## Issues and code improvement +## Issues and code improvement<a name="issues-and-code-improvement"></a> This is my first Rust project and, thus, also a learning process. If you find any issues or code flaws, please open an issue. -## Alternatives +## Alternatives<a name="alternatives"></a> `bibiman` is a project tailored to my personal needs. I use a single main file for all my bib entries and want to use `bibiman` mainly as kind of @@ -301,7 +320,7 @@ Maybe one of these might fit _your_ personal needs better: - [papis](https://github.com/papis/papis): Powerful CLI tool for managing bibliographies and documents. Has also some TUI features. -### Comparison +### Comparison<a name="comparison"></a> I compared `bibiman` only free-hand to `bibman` (Haskell) and `bibman` (Perl), since there is no simple benchmark test for TUIs. At least, I couldn't find one. |