summaryrefslogtreecommitdiff
path: root/doc/en/weechat_user.en.adoc
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2016-08-09 21:05:34 +0200
committerSébastien Helleu <flashcode@flashtux.org>2016-08-09 21:05:34 +0200
commit810077fc12401eba106bd8fa90128bea790b1d73 (patch)
tree48a91a88ca7fc9838e6a4cd34579adc7acf1b049 /doc/en/weechat_user.en.adoc
parent9d53fe9b0fcb1509aa293bca0cf1cf887f894604 (diff)
parent1d3a75333eb1b22fef74b8e0e32cdc9a85e97b00 (diff)
downloadweechat-810077fc12401eba106bd8fa90128bea790b1d73.zip
Merge remote-tracking branch 'origin/pr/509'
Diffstat (limited to 'doc/en/weechat_user.en.adoc')
-rw-r--r--doc/en/weechat_user.en.adoc7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc
index a13c0dbac..878326d3f 100644
--- a/doc/en/weechat_user.en.adoc
+++ b/doc/en/weechat_user.en.adoc
@@ -2985,6 +2985,11 @@ A trigger has the following options (names are
| return_code | `ok`, `ok_eat`, `error` |
The return code of callback (default is `ok`, which should be used in almost
all triggers, the other values are rarely used).
+
+| once_action | `none`, `disable`, `delete` |
+ Action to take with the trigger after the trigger executes once (default is
+ `none` which should be used in almost all triggers, the other values are
+ rarely used).
|===
For example, the default _beep_ trigger has following options:
@@ -2997,6 +3002,7 @@ trigger.trigger.beep.conditions = "${tg_highlight} || ${tg_msg_pv}"
trigger.trigger.beep.regex = ""
trigger.trigger.beep.command = "/print -beep"
trigger.trigger.beep.return_code = ok
+trigger.trigger.beep.once_action = none
----
[[trigger_execution]]
@@ -3009,6 +3015,7 @@ order, if triggers are globally enabled and if the trigger itself is enabled:
. replace text in trigger using regular expression(s)
. execute command(s)
. exit with a return code (except for hooks _modifier_ and _focus_).
+. perform once action (when not `none`)
[[trigger_hook_arguments]]
==== Hook arguments