From d04ca544d6845fc655cd4ba55e134de6bead6a2d Mon Sep 17 00:00:00 2001
From: Phil Jones <philj56@gmail.com>
Date: Sat, 19 Nov 2022 14:33:50 +0000
Subject: Add --history-file option.

---
 doc/tofi.5.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

(limited to 'doc/tofi.5.md')

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.
-- 
cgit v1.2.3