diff options
| -rw-r--r-- | doc/tofi.5.md | 108 | ||||
| -rw-r--r-- | doc/tofi.5.scd | 94 |
2 files changed, 103 insertions, 99 deletions
diff --git a/doc/tofi.5.md b/doc/tofi.5.md index a16ca82..ee711ca 100644 --- a/doc/tofi.5.md +++ b/doc/tofi.5.md @@ -20,7 +20,61 @@ case-insensitive, except where not possible (e.g. paths). Later options override earlier options, and command line options override config file options. -# OPTIONS +# BEHAVIOUR OPTIONS + +**hide-cursor**=*true\|false* + +> Hide the cursor. +> +> Default: false + +**history**=*true\|false* + +> Sort results by number of usages in run and drun modes. +> +> 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 + +**require-match**=*true\|false* + +> If true, require a match to allow a selection to be made. If false, +> making a selection with no matches will print input to stdout. In drun +> mode, this is always true. +> +> Default: true + +**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. +> +> Default: false + +**drun-print-exec**=*true\|false* + +> **WARNING**: In the current version of tofi, this option has changed +> to always be true and has no effect, as it should have been from the +> start. It may be removed in a future version of tofi. +> +> Default: true. + +**late-keyboard-init**=*true\|false* + +> Delay keyboard initialisation until after the first draw to screen. +> This option is experimental, and will cause tofi to miss keypresses +> for a short time after launch. The only reason to use this option is +> performance on slow systems. +> +> Default: false + +# STYLE OPTIONS **font**=*font* @@ -240,55 +294,12 @@ options. > > Default: 8 -**hide-cursor**=*true\|false* - -> Hide the cursor. -> -> Default: false - **horizontal**=*true\|false* > List results horizontally. > > Default: false -**history**=*true\|false* - -> Sort results by number of usages in run and drun modes. -> -> 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 - -**require-match**=*true\|false* - -> If true, require a match to allow a selection to be made. If false, -> making a selection with no matches will print input to stdout. In drun -> mode, this is always true. -> -> Default: true - -**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. -> -> Default: false - -**drun-print-exec**=*true\|false* - -> **WARNING**: In the current version of tofi, this option has changed -> to always be true and has no effect, as it should have been from the -> start. It may be removed in a future version of tofi. -> -> Default: true. - **hint-font**=*true\|false* > Perform font hinting. Only applies when a path to a font has been @@ -298,15 +309,6 @@ options. > > Default: true -**late-keyboard-init**=*true\|false* - -> Delay keyboard initialisation until after the first draw to screen. -> This option is experimental, and will cause tofi to miss keypresses -> for a short time after launch. The only reason to use this option is -> performance on slow systems. -> -> Default: false - # COLORS Colors can be specified in the form *RGB*, *RGBA*, *RRGGBB* or diff --git a/doc/tofi.5.scd b/doc/tofi.5.scd index 8801799..dd92f39 100644 --- a/doc/tofi.5.scd +++ b/doc/tofi.5.scd @@ -22,7 +22,54 @@ case-insensitive, except where not possible (e.g. paths). Later options override earlier options, and command line options override config file options. -# OPTIONS +# BEHAVIOUR OPTIONS + +*hide-cursor*=_true|false_ + Hide the cursor. + + Default: false + +*history*=_true|false_ + Sort results by number of usages in run and drun modes. + + 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 + +*require-match*=_true|false_ + If true, require a match to allow a selection to be made. If false, + making a selection with no matches will print input to stdout. + In drun mode, this is always true. + + Default: true + +*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. + + Default: false + +*drun-print-exec*=_true|false_ + *WARNING*: In the current version of tofi, this option has changed to + always be true and has no effect, as it should have been from the + start. It may be removed in a future version of tofi. + + Default: true. + +*late-keyboard-init*=_true|false_ + Delay keyboard initialisation until after the first draw to screen. + This option is experimental, and will cause tofi to miss keypresses + for a short time after launch. The only reason to use this option is + performance on slow systems. + + Default: false + +# STYLE OPTIONS *font*=_font_ Font to use. If _font_ is a path to a font file, *tofi* will not have @@ -209,48 +256,11 @@ options. Default: 8 -*hide-cursor*=_true|false_ - Hide the cursor. - - Default: false - *horizontal*=_true|false_ List results horizontally. Default: false -*history*=_true|false_ - Sort results by number of usages in run and drun modes. - - 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 - -*require-match*=_true|false_ - If true, require a match to allow a selection to be made. If false, - making a selection with no matches will print input to stdout. - In drun mode, this is always true. - - Default: true - -*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. - - Default: false - -*drun-print-exec*=_true|false_ - *WARNING*: In the current version of tofi, this option has changed to - always be true and has no effect, as it should have been from the - start. It may be removed in a future version of tofi. - - Default: true. - *hint-font*=_true|false_ Perform font hinting. Only applies when a path to a font has been specified via *font*. Disabling font hinting speeds up text @@ -259,14 +269,6 @@ options. Default: true -*late-keyboard-init*=_true|false_ - Delay keyboard initialisation until after the first draw to screen. - This option is experimental, and will cause tofi to miss keypresses - for a short time after launch. The only reason to use this option is - performance on slow systems. - - Default: false - # COLORS Colors can be specified in the form _RGB_, _RGBA_, _RRGGBB_ or _RRGGBBAA_, |