From 8e45592c5703451563eaf4edcd7033f80ce23b53 Mon Sep 17 00:00:00 2001
From: Phil Jones <philj56@gmail.com>
Date: Fri, 12 Aug 2022 23:14:32 +0100
Subject: Add --fuzzy_match option.

This enables some simple fuzzy matching logic for searches.
---
 doc/config     | 3 +++
 doc/tofi.5.md  | 8 ++++++++
 doc/tofi.5.scd | 7 +++++++
 3 files changed, 18 insertions(+)

(limited to 'doc')

diff --git a/doc/config b/doc/config
index 8d9d743..f65b86d 100644
--- a/doc/config
+++ b/doc/config
@@ -121,6 +121,9 @@
 	# Sort results by number of usages in run and drun modes.
 	history = true
 
+	# Use fuzzy matching for searches.
+	fuzzy-match = false
+
 	# If true, directly launch applications on selection when in drun mode.
 	# Otherwise, just print the command line to stdout.
 	drun-launch = false
diff --git a/doc/tofi.5.md b/doc/tofi.5.md
index 23f4cb2..446ec8e 100644
--- a/doc/tofi.5.md
+++ b/doc/tofi.5.md
@@ -240,6 +240,14 @@ options.
 >
 > Default: true
 
+**fuzzy-match**=*true\|false*
+
+> 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.
+>
+> Default: false
+
 **drun-launch**=*true\|false*
 
 > If true, directly launch applications on selection when in drun mode.
diff --git a/doc/tofi.5.scd b/doc/tofi.5.scd
index c36f98c..2cb4dad 100644
--- a/doc/tofi.5.scd
+++ b/doc/tofi.5.scd
@@ -208,6 +208,13 @@ options.
 
 	Default: true
 
+*fuzzy-match*=_true|false_
+	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.
+
+	Default: false
+
 *drun-launch*=_true|false_
 	If true, directly launch applications on selection when in drun mode.
 	Otherwise, just print the path of the .desktop file to stdout.
-- 
cgit v1.2.3