summaryrefslogtreecommitdiff
path: root/doc/en/autogen
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2010-11-06 11:38:48 +0100
committerSebastien Helleu <flashcode@flashtux.org>2010-11-06 11:38:48 +0100
commite001c057108a573d9e67cc37c0c5f8462e1fbdf6 (patch)
treed5e153942e4c8b08a870ee49325e3d953f887770 /doc/en/autogen
parenta56dc00b2f7a01ee3c52fcb49bea2638c877d1ff (diff)
downloadweechat-e001c057108a573d9e67cc37c0c5f8462e1fbdf6.zip
Add IRC command /notify, new options for notify and infolist "irc_notify" (task #5441)
This commit provides: - new IRC command /notify - new options: irc.look.notify_tags_ison, irc.look.notify_tags_whois, irc.network.notify_check_ison, irc.network.notify_check_whois - new option "notify" in servers (but should not be changed, only /notify command should be used) - infolist "irc_notify" to get notify list (by server or for all servers).
Diffstat (limited to 'doc/en/autogen')
-rw-r--r--doc/en/autogen/plugin_api/completions.txt2
-rw-r--r--doc/en/autogen/plugin_api/infolists.txt2
-rw-r--r--doc/en/autogen/user/irc_commands.txt27
-rw-r--r--doc/en/autogen/user/irc_options.txt25
4 files changed, 54 insertions, 2 deletions
diff --git a/doc/en/autogen/plugin_api/completions.txt b/doc/en/autogen/plugin_api/completions.txt
index 85dc06699..f9ab6bc73 100644
--- a/doc/en/autogen/plugin_api/completions.txt
+++ b/doc/en/autogen/plugin_api/completions.txt
@@ -18,6 +18,8 @@
| irc | irc_msg_part | default part message for IRC channel
+| irc | irc_notify_nicks | nicks in notify list
+
| irc | irc_privates | privates on all IRC servers
| irc | irc_server | current IRC server
diff --git a/doc/en/autogen/plugin_api/infolists.txt b/doc/en/autogen/plugin_api/infolists.txt
index ddbd46de1..5fc908948 100644
--- a/doc/en/autogen/plugin_api/infolists.txt
+++ b/doc/en/autogen/plugin_api/infolists.txt
@@ -10,6 +10,8 @@
| irc | irc_nick | list of nicks for an IRC channel | nick pointer (optional) | server,channel,nick (channel and nick are optional)
+| irc | irc_notify | list of notify | notify pointer (optional) | server name (can start or end with "*" as wildcard) (optional)
+
| irc | irc_server | list of IRC servers | server pointer (optional) | server name (can start or end with "*" as wildcard) (optional)
| logger | logger_buffer | list of logger buffers | logger pointer (optional) | -
diff --git a/doc/en/autogen/user/irc_commands.txt b/doc/en/autogen/user/irc_commands.txt
index 97c9b2ab5..b225c4918 100644
--- a/doc/en/autogen/user/irc_commands.txt
+++ b/doc/en/autogen/user/irc_commands.txt
@@ -152,8 +152,8 @@
ignore nicks/hosts from servers or channels
list: list all ignores
- add: add a ignore
- del: del a ignore
+ add: add an ignore
+ del: delete an ignore
number: number of ignore to delete (look at list to find it)
-all: delete all ignores
nick/host: nick or host to ignore: syntax is "re:regex" or "mask" (a mask is a string with some "*" to replace one or more chars)
@@ -364,6 +364,29 @@
text: text to send
........................................
+&bull; *`/notify`* `[add nick [server [-away]]] | [del nick|-all [server]]`::
+
+........................................
+ add a notification for presence or away status of nicks on servers
+
+ add: add a notification
+ nick: nickname
+ server: internal server name (by default current server)
+ -away: notify when away message is changed (by doing whois on nick)
+ del: delete a notification
+ -all: delete all notifications
+
+ Without argument, this command displays notifications for current server (or all servers if command is issued on core buffer).
+
+ Examples:
+ notify when "toto" joins/quits current server:
+ /notify add toto
+ notify when "toto" joins/quits freenode server:
+ /notify add toto freenode
+ notify when "toto" is away or back on freenode server:
+ /notify add toto freenode -away
+........................................
+
&bull; *`/op`* `nickname [nickname]`::
........................................
diff --git a/doc/en/autogen/user/irc_options.txt b/doc/en/autogen/user/irc_options.txt
index 7020680a0..85be17fca 100644
--- a/doc/en/autogen/user/irc_options.txt
+++ b/doc/en/autogen/user/irc_options.txt
@@ -218,6 +218,16 @@
** type: integer
** values: auto, never, always (default value: `auto`)
+* *irc.look.notify_tags_ison*
+** description: `comma separated list of tags used in messages printed by notify when a nick joins or quits server (result of command ison), for example: "notify_highglight", "notify_message" or "notify_private"`
+** type: string
+** values: any string (default value: `"notify_message"`)
+
+* *irc.look.notify_tags_whois*
+** description: `comma separated list of tags used in messages printed by notify when a nick away status changes (result of command whois), for example: "notify_highglight", "notify_message" or "notify_private"`
+** type: string
+** values: any string (default value: `"notify_message"`)
+
* *irc.look.part_closes_buffer*
** description: `close buffer when /part is issued on a channel`
** type: boolean
@@ -298,6 +308,16 @@
** type: integer
** values: 1 .. 3600 (default value: `1`)
+* *irc.network.notify_check_ison*
+** description: `interval between two checks for notify with IRC command "ison" (in minutes)`
+** type: integer
+** values: 1 .. 10080 (default value: `1`)
+
+* *irc.network.notify_check_whois*
+** description: `interval between two checks for notify with IRC command "whois" (in minutes)`
+** type: integer
+** values: 1 .. 10080 (default value: `5`)
+
* *irc.network.send_unknown_commands*
** description: `send unknown commands to server`
** type: boolean
@@ -398,6 +418,11 @@
** type: string
** values: any string (default value: `""`)
+* *irc.server_default.notify*
+** description: `notify list for server (you should not change this option but use /notify command instead)`
+** type: string
+** values: any string (default value: `""`)
+
* *irc.server_default.password*
** description: `password for server`
** type: string