diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config | 5 | ||||
| -rw-r--r-- | doc/tofi.5.md | 25 | ||||
| -rw-r--r-- | doc/tofi.5.scd | 16 |
3 files changed, 44 insertions, 2 deletions
@@ -143,6 +143,11 @@ # Sort results by number of usages in run and drun modes. history = true + # 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. + # history-file = /path/to/histfile + # Use fuzzy matching for searches. fuzzy-match = false 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. diff --git a/doc/tofi.5.scd b/doc/tofi.5.scd index f809103..13b8c13 100644 --- a/doc/tofi.5.scd +++ b/doc/tofi.5.scd @@ -39,10 +39,24 @@ options. Default: false *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. If false, substring matching is used, weighted to favour matches closer |