summaryrefslogtreecommitdiff
path: root/doc/tofi.5.md
diff options
context:
space:
mode:
authorPhil Jones <philj56@gmail.com>2022-11-19 14:33:50 +0000
committerPhil Jones <philj56@gmail.com>2022-11-19 14:43:03 +0000
commitd04ca544d6845fc655cd4ba55e134de6bead6a2d (patch)
tree7fd444b1f0a28d46c46775bd7266381906dd3a1f /doc/tofi.5.md
parent2c7735f2bac4d35d13c315eb8e5eee1af980b19a (diff)
Add --history-file option.
Diffstat (limited to 'doc/tofi.5.md')
-rw-r--r--doc/tofi.5.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/doc/tofi.5.md b/doc/tofi.5.md
index ff616ff..a534676 100644
--- a/doc/tofi.5.md
+++ b/doc/tofi.5.md
@@ -40,10 +40,33 @@ options.
**history**=*true\|false*
-> Sort results by number of usages in run and drun modes.
+> Sort results by number of usages. By default, this is only effective
+> in the run and drun modes - see the **history-file** option for more
+> information.
>
> Default: true
+**history-file**=*path*
+
+> Specify an alternate file to read and store history information from /
+> to. This shouldn't normally be needed, and is intended to facilitate
+> the creation of custom modes. The default value depends on the current
+> mode.
+>
+> Defaults:
+>
+> > > ·
+> > >
+> > > tofi: None (no history file)
+> >
+> > > ·
+> > >
+> > > tofi-run: *\$XDG_STATE_HOME/tofi-history*
+> >
+> > > ·
+> > >
+> > > tofi-drun: *\$XDG_STATE_HOME/tofi-drun-history*
+
**fuzzy-match**=*true\|false*
> If true, searching is performed via a simple fuzzy matching algorithm.