From b400448fc163f601fc6ea9b1a672c3380d7951f4 Mon Sep 17 00:00:00 2001 From: Sebastien Helleu Date: Fri, 31 Oct 2008 13:15:54 +0100 Subject: Update doc --- doc/en/autogen/irc_commands.xml | 4 +- doc/en/autogen/irc_options.xml | 98 ++++++++++++++++--------------------- doc/en/autogen/logger_commands.xml | 39 +++++++++++++++ doc/en/autogen/logger_options.xml | 48 ++++++++++++++++++ doc/en/autogen/weechat_commands.xml | 16 +++--- 5 files changed, 139 insertions(+), 66 deletions(-) create mode 100644 doc/en/autogen/logger_commands.xml (limited to 'doc/en/autogen') 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 give half channel operator status to nickname(s) -ignore [list] | [add nick/host [server [channel]]] | [del number|-all] +ignore [list] | [add [re:]nick/host [server [channel]]] | [del number|-all] 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 --> -irc.log.auto_log_channel - - - description: automatically log channel chats - - - type: boolean - - - values: on, off - - - default value: off - - - -irc.log.auto_log_private - - - description: automatically log private chats - - - type: boolean - - - values: on, off - - - default value: off - - - -irc.log.auto_log_server +irc.look.display_away - description: automatically log server messages + description: display message when (un)marking as away - type: boolean + type: integer - values: on, off + values: off, local, channel - default value: off + default value: local -irc.log.hide_nickserv_pwd +irc.look.display_channel_modes - description: hide password displayed by nickserv + description: display channel modes in "buffer_name" bar item type: boolean @@ -70,26 +38,10 @@ -irc.look.display_away +irc.look.hide_nickserv_pwd - description: display message when (un)marking as away - - - type: integer - - - values: off, local, channel - - - default value: local - - - -irc.look.display_channel_modes - - - description: display channel modes in "buffer_name" bar item + description: hide password displayed by nickserv type: boolean @@ -230,6 +182,38 @@ +irc.look.smart_filter + + + 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") + + + type: boolean + + + values: on, off + + + default value: off + + + +irc.look.smart_filter_delay + + + description: delay for filtering join/part/quit messages (in minutes) + + + type: integer + + + values: 1 .. 10080 + + + default value: 5 + + + irc.network.anti_flood 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 @@ + + + +logger [list | set level | disable] + +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 + 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 @@ +logger.file.mask + + + 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 + + + type: string + + + values: any string + + + default value: '$plugin.$name.weechatlog' + + + logger.file.name_lower_case @@ -86,6 +102,22 @@ +logger.level.irc + + + description: niveau d'enregistrement log pour ce tampon (0 = pas d'enregistrement, 1 = quelques messages (les plus importants) .. 9 = tous les messages) + + + type: integer + + + values: 0 .. 9 + + + default value: 9 + + + logger.look.backlog @@ -102,3 +134,19 @@ +logger.mask.irc + + + description: masque de fichier pour le fichier de log; les variables locales du tampon sont permises + + + type: string + + + values: any string + + + default value: '' + + + 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) -filter [list] | [enable|disable|toggle] | [add buffer tags regex] | [del number|-all] +filter [list] | [enable|disable|toggle [name]] | [add name buffer tags regex] | [del name|-all] 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 help [command | option] -- cgit v1.2.3