summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2014-01-09 17:21:19 +0100
committerSebastien Helleu <flashcode@flashtux.org>2014-01-09 17:21:19 +0100
commit73eb2564f363848d379261fd68da9fc16b80e00f (patch)
tree9bd2e98a00ce52c081b308a242ec92cd0b151fbd /doc/en
parent7e540dc5fb7dfb31f1b9c39002c63e62fdf429af (diff)
downloadweechat-73eb2564f363848d379261fd68da9fc16b80e00f.zip
core: add "POSIX extended" in description of options/commands/functions using regular expressions
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/autogen/user/irc_commands.txt4
-rw-r--r--doc/en/autogen/user/relay_options.txt4
-rw-r--r--doc/en/autogen/user/rmodifier_commands.txt2
-rw-r--r--doc/en/autogen/user/weechat_commands.txt6
-rw-r--r--doc/en/autogen/user/weechat_options.txt4
-rw-r--r--doc/en/weechat_plugin_api.en.txt18
6 files changed, 20 insertions, 18 deletions
diff --git a/doc/en/autogen/user/irc_commands.txt b/doc/en/autogen/user/irc_commands.txt
index 532a8a486..84bd86273 100644
--- a/doc/en/autogen/user/irc_commands.txt
+++ b/doc/en/autogen/user/irc_commands.txt
@@ -201,7 +201,7 @@ nick: nick or mask (can start or end with "*" as wildcard)
list: list all ignores
add: add an ignore
- nick: nick or hostname (can be regular expression if "re:" is given or a mask using "*" to replace one or more chars)
+ nick: nick or hostname (can be a POSIX extended regular expression if "re:" is given or a mask using "*" to replace one or more chars)
del: delete an ignore
number: number of ignore to delete (look at list to find it)
-all: delete all ignores
@@ -321,7 +321,7 @@ server_mask: list of servers must match this mask
channel: channel to list
server: server name
- regex: regular expression used to filter results (case insensitive, can start by "(?-i)" to become case sensitive)
+ regex: POSIX extended regular expression used to filter results (case insensitive, can start by "(?-i)" to become case sensitive)
Examples:
list all channels on server (can be very slow on large networks):
diff --git a/doc/en/autogen/user/relay_options.txt b/doc/en/autogen/user/relay_options.txt
index f8999d19c..114d257bd 100644
--- a/doc/en/autogen/user/relay_options.txt
+++ b/doc/en/autogen/user/relay_options.txt
@@ -79,7 +79,7 @@
** values: 0 .. 65535 (default value: `256`)
* [[option_relay.network.allowed_ips]] *relay.network.allowed_ips*
-** description: `regular expression with IPs allowed to use relay (case insensitive, use "(?-i)" at beginning to make it case sensitive); if IPv6 is enabled and that connection is made using IPv4, it will be IPv4-mapped IPv6 address (like: "::ffff:127.0.0.1"), example: "^((::ffff:)?123.45.67.89|192.160.*)$"`
+** description: `POSIX extended regular expression with IPs allowed to use relay (case insensitive, use "(?-i)" at beginning to make it case sensitive); if IPv6 is enabled and that connection is made using IPv4, it will be IPv4-mapped IPv6 address (like: "::ffff:127.0.0.1"), example: "^((::ffff:)?123.45.67.89|192.160.*)$"`
** type: string
** values: any string (default value: `""`)
@@ -114,7 +114,7 @@
** values: any string (default value: `"%h/ssl/relay.pem"`)
* [[option_relay.network.websocket_allowed_origins]] *relay.network.websocket_allowed_origins*
-** description: `regular expression with origins allowed in websockets (case insensitive, use "(?-i)" at beginning to make it case sensitive), example: "^http://(www\.)?example\.(com|org)"`
+** description: `POSIX extended regular expression with origins allowed in websockets (case insensitive, use "(?-i)" at beginning to make it case sensitive), example: "^http://(www\.)?example\.(com|org)"`
** type: string
** values: any string (default value: `""`)
diff --git a/doc/en/autogen/user/rmodifier_commands.txt b/doc/en/autogen/user/rmodifier_commands.txt
index b27009d56..49c08f9bc 100644
--- a/doc/en/autogen/user/rmodifier_commands.txt
+++ b/doc/en/autogen/user/rmodifier_commands.txt
@@ -14,7 +14,7 @@ listdefault: list default rmodifiers
name: name of rmodifier
modifiers: comma separated list of modifiers
groups: action on groups captured in regular expression (inside parentheses): comma separated list of groups (from 1 to 9) with optional "*" after number to hide the group
- regex: regular expression (case insensitive, can start by "(?-i)" to become case sensitive)
+ regex: POSIX extended regular expression (case insensitive, can start by "(?-i)" to become case sensitive)
del: delete a rmodifier
-all: delete all rmodifiers
missing: add missing rmodifiers
diff --git a/doc/en/autogen/user/weechat_commands.txt b/doc/en/autogen/user/weechat_commands.txt
index 2cd0d742f..b2b1ea3a5 100644
--- a/doc/en/autogen/user/weechat_commands.txt
+++ b/doc/en/autogen/user/weechat_commands.txt
@@ -234,8 +234,8 @@ expression: expression to evaluate, variables with format ${variable} are replac
< less
>= greater or equal
> greater
- =~ is matching regex
- !~ is NOT matching regex
+ =~ is matching POSIX extended regex
+ !~ is NOT matching POSIX extended regex
An expression is considered as "true" if it is not NULL, not empty, and different from "0".
The comparison is made using integers if the two expressions are valid integers.
@@ -298,7 +298,7 @@ disable: disable filters
tags: comma separated list of tags, for example "irc_join,irc_part,irc_quit"
- logical "and": use "+" between tags (for example: "nick_toto+irc_action")
- tags can start or end with '*'
- regex: regular expression to search in line
+ regex: POSIX extended regular expression to search in line
- use '\t' to separate prefix from message, special chars like '|' must be escaped: '\|'
- if regex starts with '!', then matching result is reversed (use '\!' to start with '!')
- two regular expressions are created: one for prefix and one for message
diff --git a/doc/en/autogen/user/weechat_options.txt b/doc/en/autogen/user/weechat_options.txt
index e6a4b1b16..472a2bfd2 100644
--- a/doc/en/autogen/user/weechat_options.txt
+++ b/doc/en/autogen/user/weechat_options.txt
@@ -434,7 +434,7 @@
** values: on, off (default value: `off`)
* [[option_weechat.look.buffer_search_regex]] *weechat.look.buffer_search_regex*
-** description: `default text search in buffer: if enabled, search regular expression, otherwise search simple string`
+** description: `default text search in buffer: if enabled, search POSIX extended regular expression, otherwise search simple string`
** type: boolean
** values: on, off (default value: `off`)
@@ -539,7 +539,7 @@
** values: any string (default value: `""`)
* [[option_weechat.look.highlight_regex]] *weechat.look.highlight_regex*
-** description: `regular expression used to check if a message has highlight or not, at least one match in string must be surrounded by word chars (alphanumeric, "-", "_" or "|"), regular expression is case insensitive (use "(?-i)" at beginning to make it case sensitive), examples: "flashcode|flashy", "(?-i)FlashCode|flashy"`
+** description: `POSIX extended regular expression used to check if a message has highlight or not, at least one match in string must be surrounded by word chars (alphanumeric, "-", "_" or "|"), regular expression is case insensitive (use "(?-i)" at beginning to make it case sensitive), examples: "flashcode|flashy", "(?-i)FlashCode|flashy"`
** type: string
** values: any string (default value: `""`)
diff --git a/doc/en/weechat_plugin_api.en.txt b/doc/en/weechat_plugin_api.en.txt
index 82e04f0c8..9b1251a03 100644
--- a/doc/en/weechat_plugin_api.en.txt
+++ b/doc/en/weechat_plugin_api.en.txt
@@ -1048,7 +1048,7 @@ const char *weechat_string_regex_flags (const char *regex, int default_flags, in
Arguments:
-* 'regex': regular expression
+* 'regex': POSIX extended regular expression
* 'default_flags': combination of following values (see `man regcomp`):
** REG_EXTENDED
** REG_ICASE
@@ -1088,8 +1088,9 @@ This function is not available in scripting API.
_WeeChat ≥ 0.3.7._
-Compile a regular expression using optional flags at beginning of string (for
-format of flags, see <<_weechat_string_regex_flags,weechat_string_regex_flags>>).
+Compile a POSIX extended regular expression using optional flags at beginning
+of string (for format of flags, see
+<<_weechat_string_regex_flags,weechat_string_regex_flags>>).
Prototype:
@@ -1101,7 +1102,7 @@ int weechat_string_regcomp (void *preg, const char *regex, int default_flags)
Arguments:
* 'preg': pointer to 'regex_t' structure
-* 'regex': regular expression
+* 'regex': POSIX extended regular expression
* 'default_flags': combination of following values (see `man regcomp`):
** REG_EXTENDED
** REG_ICASE
@@ -1170,7 +1171,8 @@ highlight = weechat.string_has_highlight("my test string", "test,word2") # 1
_WeeChat ≥ 0.3.4._
-Check if a string has one or more highlights, using a regular expression.
+Check if a string has one or more highlights, using a POSIX extended regular
+expression. +
For at least one match of regular expression on string, it must be surrounded
by word chars (alphanumeric character, "-", "_" or "|").
@@ -1184,7 +1186,7 @@ int weechat_string_has_highlight_regex (const char *string, const char *regex);
Arguments:
* 'string': string
-* 'regex': regular expression
+* 'regex': POSIX extended regular expression
Return value:
@@ -9991,7 +9993,7 @@ Arguments:
** 'input': input text
** 'text_search_input': input saved before text search
** 'highlight_words': list of words to highlight
-** 'highlight_regex': regular expression for highlight
+** 'highlight_regex': POSIX extended regular expression for highlight
** 'highlight_tags_restrict': restrict highlights to messages with these tags
** 'highlight_tags': force highlight on messages with these tags
** 'hotlist_max_level_nicks': max hotlist level for some nicks
@@ -10164,7 +10166,7 @@ Properties:
Comma separated list of words to remove from highlighted words on buffer
| highlight_regex | any string |
- Regular expression for highlight
+ POSIX extended regular expression for highlight
| highlight_tags_restrict | comma separated list of tags |
Restrict highlights to messages with these tags in this buffer