summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/tofi.5.md14
-rw-r--r--doc/tofi.5.scd13
2 files changed, 27 insertions, 0 deletions
diff --git a/doc/tofi.5.md b/doc/tofi.5.md
index e976ef7..30ffb98 100644
--- a/doc/tofi.5.md
+++ b/doc/tofi.5.md
@@ -73,8 +73,22 @@ options.
> > >
> > > tofi-drun: *\$XDG_STATE_HOME/tofi-drun-history*
+**matching-algorithm**=*normal\|prefix\|fuzzy*
+
+> Select the matching algorithm used. If *normal*, substring matching is
+> used, weighted to favour matches closer to the beginning of the
+> string. If *prefix*, only substrings at the beginning of the string
+> are matched. If *fuzzy*, searching is performed via a simple fuzzy
+> matching algorithm.
+>
+> Default: normal
+
**fuzzy-match**=*true\|false*
+> **WARNING**: This option is deprecated, and may be removed in a future
+> version of tofi. You should use the **matching-algorithm** option
+> instead.
+>
> If true, searching is performed via a simple fuzzy matching algorithm.
> If false, substring matching is used, weighted to favour matches
> closer to the beginning of the string.
diff --git a/doc/tofi.5.scd b/doc/tofi.5.scd
index 29547e0..013dc57 100644
--- a/doc/tofi.5.scd
+++ b/doc/tofi.5.scd
@@ -61,8 +61,21 @@ options.
- tofi-run: _$XDG_STATE_HOME/tofi-history_
- tofi-drun: _$XDG_STATE_HOME/tofi-drun-history_
+*matching-algorithm*=_normal|prefix|fuzzy_
+ Select the matching algorithm used.
+ If _normal_, substring matching is used, weighted to favour matches
+ closer to the beginning of the string.
+ If _prefix_, only substrings at the beginning of the string are matched.
+ If _fuzzy_, searching is performed via a simple fuzzy matching
+ algorithm.
+
+ Default: normal
*fuzzy-match*=_true|false_
+ *WARNING*: This option is deprecated, and may be removed in a future
+ version of tofi. You should use the *matching-algorithm*
+ option instead.
+
If true, searching is performed via a simple fuzzy matching algorithm.
If false, substring matching is used, weighted to favour matches closer
to the beginning of the string.