aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-12-11 18:44:32 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-12-11 18:44:32 +0000
commit934466bc84c007a3935f57079df1036c132c3393 (patch)
tree34d9ab652f1c24399f098aafc5b80ad4de9e6016 /doc
parentMerge branch 'remove-deprecated-things' (diff)
parentconfig: add ‘notify’ to possible values for ‘bell’ in foot.ini (diff)
Merge branch 'osc777-notify'
Closes #224
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.ini.5.scd16
1 files changed, 15 insertions, 1 deletions
diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd
index 14cd6d16..8397b118 100644
--- a/doc/foot.ini.5.scd
+++ b/doc/foot.ini.5.scd
@@ -120,7 +120,7 @@ in this order:
*bell*
Action to perform when receiving a *BEL* character. Can be set to
- either *set-urgency* or *none*.
+ 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
@@ -136,6 +136,9 @@ in this order:
_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 (see
+ the *notify* option).
+
When set to *none*, no special action is taken when receiving *BEL*.
Default: _none_.
@@ -145,6 +148,17 @@ in this order:
text. Note that whitespace characters are _always_ word
delimiters, regardless of this setting. Default: _,│`|:"'()[]{}<>_
+*notify*
+ Command to execute to display a notification. _${title}_ and
+ _${body}_ will be replaced with the notification's actual _title_
+ and _body_ (message content).
+
+ Applications can trigger notifications in the following ways:
+
+ - OSC 777: *\\e]777;notify;<title>;<body>\\e\\\\*
+
+ Default: _notify-send -a foot -i foot ${title} ${body}_.
+
# SECTION: scrollback