summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2008-10-31 13:15:54 +0100
committerSebastien Helleu <flashcode@flashtux.org>2008-10-31 13:15:54 +0100
commitb400448fc163f601fc6ea9b1a672c3380d7951f4 (patch)
tree45600b8bd949c8fc5e7faac9c2c3a7b996fefa79 /doc/en
parentf766dc2f11d7b18285eec8f177dfdaeb4aeea2b5 (diff)
downloadweechat-b400448fc163f601fc6ea9b1a672c3380d7951f4.zip
Update doc
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/autogen/irc_commands.xml4
-rw-r--r--doc/en/autogen/irc_options.xml98
-rw-r--r--doc/en/autogen/logger_commands.xml39
-rw-r--r--doc/en/autogen/logger_options.xml48
-rw-r--r--doc/en/autogen/weechat_commands.xml16
5 files changed, 139 insertions, 66 deletions
diff --git a/doc/en/autogen/irc_commands.xml b/doc/en/autogen/irc_commands.xml
index 21dd4e5c1..e1cdbaf06 100644
--- a/doc/en/autogen/irc_commands.xml
+++ b/doc/en/autogen/irc_commands.xml
@@ -100,7 +100,7 @@ servername: server name to disconnect
<programlisting>
give half channel operator status to nickname(s)
</programlisting>
-<command>ignore [list] | [add nick/host [server [channel]]] | [del number|-all]</command>
+<command>ignore [list] | [add [re:]nick/host [server [channel]]] | [del number|-all]</command>
<programlisting>
ignore nicks/hosts from servers or channels
@@ -109,7 +109,7 @@ ignore nicks/hosts from servers or channels
del: del a ignore
number: number of ignore to delete (look at list to find it)
-all: delete all ignore
-nick/host: nick or host to ignore (regular expression allowed)
+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)
server: internal server name where ignore is working
channel: channel name where ignore is working
diff --git a/doc/en/autogen/irc_options.xml b/doc/en/autogen/irc_options.xml
index ca2ca4c09..b7c054075 100644
--- a/doc/en/autogen/irc_options.xml
+++ b/doc/en/autogen/irc_options.xml
@@ -6,58 +6,26 @@
docgen.pl builds XML doc files to include in many languages
-->
-<command>irc.log.auto_log_channel</command>
-<itemizedlist>
- <listitem>
- <para>description: automatically log channel chats</para>
- </listitem>
- <listitem>
- <para>type: boolean</para>
- </listitem>
- <listitem>
- <para>values: on, off</para>
- </listitem>
- <listitem>
- <para>default value: off</para>
- </listitem>
-</itemizedlist>
-
-<command>irc.log.auto_log_private</command>
-<itemizedlist>
- <listitem>
- <para>description: automatically log private chats</para>
- </listitem>
- <listitem>
- <para>type: boolean</para>
- </listitem>
- <listitem>
- <para>values: on, off</para>
- </listitem>
- <listitem>
- <para>default value: off</para>
- </listitem>
-</itemizedlist>
-
-<command>irc.log.auto_log_server</command>
+<command>irc.look.display_away</command>
<itemizedlist>
<listitem>
- <para>description: automatically log server messages</para>
+ <para>description: display message when (un)marking as away</para>
</listitem>
<listitem>
- <para>type: boolean</para>
+ <para>type: integer</para>
</listitem>
<listitem>
- <para>values: on, off</para>
+ <para>values: off, local, channel</para>
</listitem>
<listitem>
- <para>default value: off</para>
+ <para>default value: local</para>
</listitem>
</itemizedlist>
-<command>irc.log.hide_nickserv_pwd</command>
+<command>irc.look.display_channel_modes</command>
<itemizedlist>
<listitem>
- <para>description: hide password displayed by nickserv</para>
+ <para>description: display channel modes in "buffer_name" bar item</para>
</listitem>
<listitem>
<para>type: boolean</para>
@@ -70,26 +38,10 @@
</listitem>
</itemizedlist>
-<command>irc.look.display_away</command>
+<command>irc.look.hide_nickserv_pwd</command>
<itemizedlist>
<listitem>
- <para>description: display message when (un)marking as away</para>
- </listitem>
- <listitem>
- <para>type: integer</para>
- </listitem>
- <listitem>
- <para>values: off, local, channel</para>
- </listitem>
- <listitem>
- <para>default value: local</para>
- </listitem>
-</itemizedlist>
-
-<command>irc.look.display_channel_modes</command>
-<itemizedlist>
- <listitem>
- <para>description: display channel modes in "buffer_name" bar item</para>
+ <para>description: hide password displayed by nickserv</para>
</listitem>
<listitem>
<para>type: boolean</para>
@@ -230,6 +182,38 @@
</listitem>
</itemizedlist>
+<command>irc.look.smart_filter</command>
+<itemizedlist>
+ <listitem>
+ <para>description: filter join/part/quit messages for a nick if not speaking for some minutes on channel (you must create a filter on tag "irc_smart_filter")</para>
+ </listitem>
+ <listitem>
+ <para>type: boolean</para>
+ </listitem>
+ <listitem>
+ <para>values: on, off</para>
+ </listitem>
+ <listitem>
+ <para>default value: off</para>
+ </listitem>
+</itemizedlist>
+
+<command>irc.look.smart_filter_delay</command>
+<itemizedlist>
+ <listitem>
+ <para>description: delay for filtering join/part/quit messages (in minutes)</para>
+ </listitem>
+ <listitem>
+ <para>type: integer</para>
+ </listitem>
+ <listitem>
+ <para>values: 1 .. 10080</para>
+ </listitem>
+ <listitem>
+ <para>default value: 5</para>
+ </listitem>
+</itemizedlist>
+
<command>irc.network.anti_flood</command>
<itemizedlist>
<listitem>
diff --git a/doc/en/autogen/logger_commands.xml b/doc/en/autogen/logger_commands.xml
new file mode 100644
index 000000000..8ff74f27e
--- /dev/null
+++ b/doc/en/autogen/logger_commands.xml
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ********* WARNING! *********
+
+ This file is autogenerated with docgen.pl script. *** DO NOT EDIT! ***
+ docgen.pl builds XML doc files to include in many languages
+-->
+
+<command>logger [list | set level | disable]</command>
+<programlisting>
+logger plugin configuration
+
+ list: show logging status for open buffers
+ set: set logging level on current buffer
+ level: level for messages to be logged (0 = logging disabled, 1 = a few messages (most important) .. 9 = all messages)
+disable: disable logging on current buffer (set level to 0)
+
+Options "logger.level.*" and "logger.mask.*" can be used to set level or mask for a buffer, or buffers beginning with name.
+
+Examples:
+ set level to 5 for current buffer:
+ /logger set 5
+ disable logging for current buffer:
+ /logger disable
+
+ set level to 3 for all IRC buffers:
+ /set logger.level.irc = 3
+ disable logging for main WeeChat buffer:
+ /set logger.level.core.weechat = 0
+ use a directory per IRC server and a file per channel inside:
+ /set logger.mask.irc = $server/$channel.weechatlog
+
+Log levels used by IRC plugin:
+ 1: user message, notice, private
+ 2: nick change
+ 3: server message
+ 4: join/part/quit
+ 9: all other messages
+</programlisting>
diff --git a/doc/en/autogen/logger_options.xml b/doc/en/autogen/logger_options.xml
index ca769bab8..6c27a5d70 100644
--- a/doc/en/autogen/logger_options.xml
+++ b/doc/en/autogen/logger_options.xml
@@ -38,6 +38,22 @@
</listitem>
</itemizedlist>
+<command>logger.file.mask</command>
+<itemizedlist>
+ <listitem>
+ <para>description: default file name mask for log files (format is 'directory/to/file' or 'file', without first '/' because 'path' option is used to build complete path to file); local buffer variables are permitted</para>
+ </listitem>
+ <listitem>
+ <para>type: string</para>
+ </listitem>
+ <listitem>
+ <para>values: any string</para>
+ </listitem>
+ <listitem>
+ <para>default value: '$plugin.$name.weechatlog'</para>
+ </listitem>
+</itemizedlist>
+
<command>logger.file.name_lower_case</command>
<itemizedlist>
<listitem>
@@ -86,6 +102,22 @@
</listitem>
</itemizedlist>
+<command>logger.level.irc</command>
+<itemizedlist>
+ <listitem>
+ <para>description: niveau d'enregistrement log pour ce tampon (0 = pas d'enregistrement, 1 = quelques messages (les plus importants) .. 9 = tous les messages)</para>
+ </listitem>
+ <listitem>
+ <para>type: integer</para>
+ </listitem>
+ <listitem>
+ <para>values: 0 .. 9</para>
+ </listitem>
+ <listitem>
+ <para>default value: 9</para>
+ </listitem>
+</itemizedlist>
+
<command>logger.look.backlog</command>
<itemizedlist>
<listitem>
@@ -102,3 +134,19 @@
</listitem>
</itemizedlist>
+<command>logger.mask.irc</command>
+<itemizedlist>
+ <listitem>
+ <para>description: masque de fichier pour le fichier de log; les variables locales du tampon sont permises</para>
+ </listitem>
+ <listitem>
+ <para>type: string</para>
+ </listitem>
+ <listitem>
+ <para>values: any string</para>
+ </listitem>
+ <listitem>
+ <para>default value: ''</para>
+ </listitem>
+</itemizedlist>
+
diff --git a/doc/en/autogen/weechat_commands.xml b/doc/en/autogen/weechat_commands.xml
index ad6d1f7d6..06d197f2f 100644
--- a/doc/en/autogen/weechat_commands.xml
+++ b/doc/en/autogen/weechat_commands.xml
@@ -86,7 +86,7 @@ launch explicit WeeChat or plugin command
plugin: plugin name ('weechat' for WeeChat internal command)
command: command to execute (a '/' is automatically added if not found at beginning of command)
</programlisting>
-<command>filter [list] | [enable|disable|toggle] | [add buffer tags regex] | [del number|-all]</command>
+<command>filter [list] | [enable|disable|toggle [name]] | [add name buffer tags regex] | [del name|-all]</command>
<programlisting>
filter messages in buffers, to hide/show them according to tags or regex
@@ -94,23 +94,25 @@ filter messages in buffers, to hide/show them according to tags or regex
enable: enable filters (filters are enabled by default)
disable: disable filters
toggle: toggle filters
+ name: filter name
add: add a filter
del: delete a filter
- number: number of filter to delete (look at list to find it)
-all: delete all filters
buffer: buffer where filter is active: it may be a name or "*" for all buffers
tags: comma separated list of tags, for example: "irc_join,irc_part,irc_quit"
regex: regular expression to search in line (use \t to separate prefix from message)
Examples:
- filter IRC join/part/quit messages:
- /filter add * irc_join,irc_part,irc_quit *
+ use IRC smart filter for join/part/quit messages:
+ /filter add irc_smart * irc_smart_filter *
+ filter all IRC join/part/quit messages:
+ /filter add joinquit * irc_join,irc_part,irc_quit *
filter nick "toto" on channel #weechat:
- /filter add freenode.#weechat * toto\t
+ /filter add toto freenode.#weechat * toto\t
filter lines containing word "spam":
- /filter add * * spam
+ /filter add filterspam * * spam
filter lines containing "weechat sucks" on channel #weechat:
- /filter add freenode.#weechat * weechat sucks
+ /filter add sucks freenode.#weechat * weechat sucks
</programlisting>
<command>help [command | option]</command>
<programlisting>