add dry-run information to --help function

2 files changed, 26 insertions, 0 deletions

diff --git a/src/bibiman/citekeys.rs b/src/bibiman/citekeys.rs
index 7c06886..f7704fb 100644
--- a/src/bibiman/citekeys.rs
+++ b/src/bibiman/citekeys.rs
@@ -238,6 +238,17 @@ fn formatting_help() {
             ",
             "-h, --help".fg::<White>().bold()
         ),
+        formatdoc!(
+            "
+                \t{}
+                \tDon't apply any changes to the named files. Instead print all
+                \told citekeys and the formatted strings that would have been
+                \tapplied in the format: {} => {}
+            ",
+            "-d, --dry-run".fg::<White>().bold(),
+            "old_key".italic(),
+            "new_key".bold()
+        ),
         formatdoc! {"
                 \t{}
                 \tThe bibfile for which the citekey formatting should be processed.
diff --git a/src/config.rs b/src/config.rs
index a4e89be..b1c4b07 100644
--- a/src/config.rs
+++ b/src/config.rs
@@ -103,6 +103,21 @@ const DEFAULT_CONFIG: &str = r##"
 # author_color = "38"
 # title_color = "37"
 # year_color = "135"
+
+# [citekey_formatter]
+## Define the patterns for creating citekeys. Every item of the array consists of
+## five components separated by semicolons. Despite the field name every component
+## can be left blank:
+## - name of the biblatex field ("author", "title"...)
+## - number of max words from the given field
+## - number of chars used from each word
+## - delimiter to separate words of the same field
+## - trailing delimiter separating the current field from the following
+# fields = [ "author;2;;-;_", "title;3;6;_;_", "year" ]
+
+## Convert chars to specified case. Possible values:
+## "upper", "uppercase", "lower", "lowercase"
+# case = "lowercase"
 "##;
 
 /// Main struct of the config file. Contains substructs/headings in toml