aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-10-08 17:55:32 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-10-08 17:55:32 +0000
commit7c6686221f328e9399eb679c246662c801b2356b (patch)
tree027ccece5f9d7c96af5025c740606155f19c8bc6 /doc
parentdoc: foot.1: remove ‘--’ from example command line (diff)
bell: optionally render margins in red when receiving BEL
Add anew config option, ‘bell=none|set-urgency’. When set to ‘set-urgency’, the margins will be painted in red (if the window did not have keyboard focus). This is intended as a cheap replacement for the ‘urgency’ hint, that doesn’t (yet) exist on Wayland. Closes #157
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.ini.5.scd16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd
index 60da2d67..22b2adde 100644
--- a/doc/foot.ini.5.scd
+++ b/doc/foot.ini.5.scd
@@ -91,6 +91,22 @@ in this order:
(including SMT). Note that this is not always the best value. In
some cases, the number of physical _cores_ is better.
+*bell*
+ Action to perform when receiving a *BEL* character. Can be set to
+ either *set-urgency* 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).
+
+ When set to *none*, no special action is taken when receiving *BEL*.
+
+ Default: _none_.
+
# SECTION: scrollback