aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4929509..086f64a 100644
--- a/README.md
+++ b/README.md
@@ -24,9 +24,11 @@
- [Ubuntu/Debian](#ubuntudebian)
- [Void Linux](#void-linux)
- [Usage](#usage)
+ - [CLI for citekey formatting](#cli-for-citekey-formatting)
- [Configuration](#configuration)
- [Location of Config File](#location-of-config-file)
- [General Configuration](#general-configuration)
+ - [Citekey formatting](#citekey-formatting)
- [Color Configuration](#color-configuration)
- [Features](#features)
- [Keybindings](#keybindings)
@@ -196,6 +198,13 @@ bibman tests/multi-files/
bibiman tests/biblatex-test.bib tests/multi-files/
```
+### CLI for citekey formatting<a name="cli-for-citekey-formatting"></a>
+
+Beside the TUI `bibiman` can format and replace citekeys. To make use of this
+feature run the program with the `format-citekeys` subcommand. For more
+information use `bibiman format-citekeys --help` and the see
+[docs](./CITEKEYS.md).
+
## Configuration<a name="configuration"></a>
### Location of Config File<a name="location-of-config-file"></a>
@@ -268,6 +277,11 @@ note_symbol = "󰧮"
## Possible values are "journaltitle", "organization", "instituion", "publisher"
## and "pubtype" (which is the default)
custom_column = "pubtype"
+
+[citekey_formatter]
+fields = []
+ascii_only = true
+case = "lowercase"
```
`bibfiles`
@@ -326,6 +340,12 @@ custom_column = "pubtype"
good advice to use a rather wide terminal window when using a value like
`journaltitle`.
+### Citekey formatting<a name="citekey-formatting"></a>
+
+`bibiman` now also offers a citekey generating feature. This enables to reformat
+all citekeys based on an elaborated pattern matching syntax. For furthter
+information and examples see the [docs](CITEKEYS.md).
+
### Color Configuration<a name="color-configuration"></a>
Furthermore, it is now possible to customize the colors. The following values