diff options
| author | Daniel Eklöf <daniel@ekloef.se> | 2021-05-07 14:47:53 +0000 |
|---|---|---|
| committer | Daniel Eklöf <daniel@ekloef.se> | 2021-05-07 14:47:53 +0000 |
| commit | 63572e4223a329f6942041d8ca8fce5016fc3a1f (patch) | |
| tree | 519a249b6809b3dc5ce1cd2ce622e53d2cae5654 /doc | |
| parent | Merge branch 'bump-fcft-to-2-4-0' (diff) | |
| parent | consistent booleans in config, reset legacy bell (diff) | |
Merge branch 'bell-enhancement'
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/foot.ini.5.scd | 59 |
1 files changed, 33 insertions, 26 deletions
diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd index 9b4e3f7b..1030c841 100644 --- a/doc/foot.ini.5.scd +++ b/doc/foot.ini.5.scd @@ -211,32 +211,6 @@ in this order: Default: _no_. -*bell* - Action to perform when receiving a *BEL* character. Can be set to - either *set-urgency*, *notify* or *none*. - - When set to *set-urgency*, the margins will be painted in red - whenever *BEL* is received while the window does *not* have - keyboard focus. Note that Wayland currently does not have an - _urgency_ hint like X11. The value *set-urgency* was chosen for - forward-compatibility in the hopes that a corresponding Wayland - protocol is added in the future (in which case foot will use that - instead of painting its margins red). - - Applications can enable/disable this feature programmatically with - the *CSI ? 1042 h* and *CSI ? 1042 l* escape sequences. - - _Note_: expect this feature to be *replaced* with proper - compositor urgency support once/if that gets implemented. - - When set to *notify*, foot will emit a desktop notification using - the command specified in the *notify* option, but only if the foot - window does *not* have keyboard focus. - - When set to *none*, no special action is taken when receiving *BEL*. - - Default: _none_. - *word-delimiters* String of characters that act as word delimiters when selecting text. Note that whitespace characters are _always_ word @@ -288,6 +262,39 @@ in this order: Default: _url-mode_ +# SECTION: bell + +*urgent* + When set to _yes_, the margins will be painted in red + whenever *BEL* is received while the window does *not* have + keyboard focus. Note that Wayland currently does not have an + _urgency_ hint like X11. The name *urgent* was chosen for + forward-compatibility in the hopes that a corresponding Wayland + protocol is added in the future (in which case foot will use that + instead of painting its margins red). + + Applications can enable/disable this feature programmatically with + the *CSI ? 1042 h* and *CSI ? 1042 l* escape sequences. + + _Note_: expect this feature to be *replaced* with proper + compositor urgency support once/if that gets implemented. + Default: _no_ + +*notify* + When set to _yes_, foot will emit a desktop notification using + the command specified in the *notify* option whenever *BEL* is + received and the window does *not* have keyboard focus. Default: + _no_ + +*command* + When set, foot will execute this command when *BEL* is received. + Default: none + +*command-focused* + Whether to run the command on *BEL* even while focused. Default: + _no_ + + # SECTION: scrollback *lines* |
