aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-10-09 05:41:39 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-10-09 05:41:39 +0000
commitb10d93b0efe657d25e6615e45d5d6b84f069a06c (patch)
treed5612e8d8fe89006f3c634d64cbd4c8d921ea71a /doc
parentdoc: foot.1: remove ‘--’ from example command line (diff)
parentdoc: foot.ini: bell/urgency: add note about this getting replaced in the future (diff)
Merge branch 'bell-triggers-faked-urgency' into master
Closes #157
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.ini.5.scd19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd
index 60da2d67..496162e8 100644
--- a/doc/foot.ini.5.scd
+++ b/doc/foot.ini.5.scd
@@ -91,6 +91,25 @@ 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).
+
+ _Note_: expect this feature to be *replaced* with proper
+ compositor urgency support once/if that gets implemented.
+
+ When set to *none*, no special action is taken when receiving *BEL*.
+
+ Default: _none_.
+
# SECTION: scrollback