diff options
author | Phil Jones <philj56@gmail.com> | 2022-10-05 14:35:12 +0100 |
---|---|---|
committer | Phil Jones <philj56@gmail.com> | 2022-10-05 14:35:12 +0100 |
commit | 4f13d9c88e8a00ccb9ba8d5380db2f93d3f67908 (patch) | |
tree | 91506378e4d30edad5178238267d9a3132dcf146 /doc | |
parent | 803b0d14b7ac8ea03105613fa25849d460073357 (diff) |
Add options to hide input for passwords etc.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/config | 9 | ||||
-rw-r--r-- | doc/tofi.5.md | 15 | ||||
-rw-r--r-- | doc/tofi.5.scd | 28 |
3 files changed, 45 insertions, 7 deletions
@@ -135,6 +135,15 @@ # In drun mode, this is always true. require-match = true + # If true, typed input will be hidden, and what is displayed (if + # anything) is determined by the hidden-character option. + hide-input = false + + # Replace displayed input characters with a character. If the empty + # string is given, input will be completely hidden. + # This option only has an effect when hide-input is set to true. + hidden-character = "*" + # 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 b330278..319171d 100644 --- a/doc/tofi.5.md +++ b/doc/tofi.5.md @@ -60,6 +60,21 @@ options. > > Default: true +**hide-input**=*true\|false* + +> If true, typed input will be hidden, and what is displayed (if +> anything) is determined by the **hidden-character** option. +> +> Default: false + +**hidden-character**=*char* + +> Replace displayed input characters with *char*. If *char* is set to +> the empty string, input will be completely hidden. This option only +> has an effect when **hide-input** is set to true. +> +> Default: \* + **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 e0faa2d..cad1dbb 100644 --- a/doc/tofi.5.scd +++ b/doc/tofi.5.scd @@ -25,10 +25,11 @@ options. # SPECIAL OPTIONS *include*=_path_ - Include the contents of another config file. If _path_ is a relative path, - it is interpreted as relative to this config file's path (or the current - directory if *--include* is passed on the command line). Inclusion happens - immediately, before the rest of the current file's contents are parsed. + Include the contents of another config file. If _path_ is a relative + path, it is interpreted as relative to this config file's path (or the + current directory if *--include* is passed on the command line). + Inclusion happens immediately, before the rest of the current file's + contents are parsed. # BEHAVIOUR OPTIONS @@ -56,6 +57,19 @@ options. Default: true +*hide-input*=_true|false_ + If true, typed input will be hidden, and what is displayed (if + anything) is determined by the *hidden-character* option. + + Default: false + +*hidden-character*=_char_ + Replace displayed input characters with _char_. If _char_ is set to the + empty string, input will be completely hidden. + This option only has an effect when *hide-input* is set to true. + + Default: \* + *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. @@ -206,9 +220,9 @@ options. *scale*=_true|false_ Scale the window by the output's scale factor. - *WARNING*: In the current version of tofi, the default value has changed to - true, so you may need to update your config. Additionally, font scaling will - no longer occur when this is set to _false_. + *WARNING*: In the current version of tofi, the default value has + changed to true, so you may need to update your config. Additionally, + font scaling will no longer occur when this is set to _false_. Default: true |