Add docs for transient rules

This commit is contained in:
Benedikt Heine 2017-08-02 15:56:10 +02:00
parent d4f6726944
commit 2da6730e5a
2 changed files with 9 additions and 5 deletions

View File

@ -7,6 +7,8 @@
## Changed ## Changed
- transient hints are now handled - transient hints are now handled
An additional rule option (`match_transient` and `set_transient`) is added
to optionally reset the transient setting
## 1.2.0 - 2017-07-12 ## 1.2.0 - 2017-07-12

View File

@ -235,6 +235,7 @@ Don't timeout notifications if user is idle longer than this value (in seconds).
Set to 0 to disable. Set to 0 to disable.
Transient notifications will ignore this setting and timeout anyway. Transient notifications will ignore this setting and timeout anyway.
Use a rule overwriting with 'set_transient = no' to disable this behavior.
=item B<font> (default: "Monospace 8") =item B<font> (default: "Monospace 8")
@ -558,9 +559,10 @@ matched.
=item B<filtering> =item B<filtering>
Notifications can be matched for any of the following attributes: appname, Notifications can be matched for any of the following attributes: appname,
summary, body, icon, category and msg_urgency where each is the respective summary, body, icon, category, match_transient and msg_urgency where each is
notification attribute to be matched and 'msg_urgency' is the urgency of the the respective notification attribute to be matched and 'msg_urgency' is the
notification, it is named so to not conflict with trying to modify the urgency. urgency of the notification, it is named so to not conflict with trying to
modify the urgency.
To define a matching rule simply assign the specified value to the value that To define a matching rule simply assign the specified value to the value that
should be matched, for example: should be matched, for example:
@ -576,8 +578,8 @@ Shell-like globing is supported.
=item B<modifying> =item B<modifying>
The following attributes can be overridden: timeout, urgency, foreground, The following attributes can be overridden: timeout, urgency, foreground,
background, new_icon, format where, as with the filtering attributes, each one background, new_icon, set_transient, format where, as with the filtering attributes,
corresponds to the respective notification attribute to be modified. each one corresponds to the respective notification attribute to be modified.
As with filtering, to make a rule modify an attribute simply assign it in the As with filtering, to make a rule modify an attribute simply assign it in the
rule definition. rule definition.