- Version 3.1 (under dev)
- Version 3.0.1 (2021-01-31)
- Version 3.0 (2020-11-11)
- Version 2.9 (2020-07-18)
- New background color for inactive bars
- New modifier_data for modifier "weechat_print"
- Move of API completion functions
- GnuTLS is now a required dependency
- The trigger "cmd_pass" does not hide any more values of /set command
- Evaluation of trigger command arguments
- Add of handshake and nonce in weechat relay protocol
- Version 2.8 (2020-03-29)
- Version 2.7.1 (2020-02-20)
- Version 2.7 (2019-12-08)
- Version 2.6 (2019-09-08)
- Version 2.5 (2019-06-06)
- Version 2.4 (2019-02-17)
- Version 2.3 (2018-10-21)
- Version 2.2 (2018-07-14)
- Version 2.1 (2018-03-18)
- Version 2.0.1 (2017-12-20)
- Version 2.0 (2017-12-03)
- Version 1.9.1 (2017-09-23)
- Version 1.9 (2017-06-25)
- Version 1.8 (2017-05-13)
- Version 1.7.1 (2017-04-22)
- Version 1.7 (2017-01-15)
- Version 1.6 (2016-10-02)
- Version 1.5 (2016-05-01)
- Version 1.4 (2016-01-10)
- Version 1.3 (2015-08-16)
- Version 1.2 (2015-05-10)
- Version 1.1.1 (2015-01-25)
- Version 1.1 (2015-01-11)
- Version 1.0.1 (2014-09-28)
- Version 1.0 (2014-08-15)
- Version 0.4.3 (2014-02-09)
- Version 0.4.2 (2013-10-06)
- Version 0.4.1 (2013-05-20)
- Version 0.4.0 (2013-01-20)
- Version 0.3.9.2 (2012-11-18)
- Version 0.3.9.1 (2012-11-09)
- Version 0.3.9 (2012-09-29)
- Version 0.3.8 (2012-06-03)
- Version 0.3.7 (2012-02-26)
- Version 0.3.6 (2011-10-22)
- Version 0.3.5 (2011-05-15)
- Version 0.3.4 (2011-01-16)
- Version 0.3.3 (2010-08-07)
- Version 0.3.2 (2010-04-18)
- Version 0.3.1.1 (2010-01-31)
- Version 0.3.1 (2010-01-23)
- Version 0.3.0 (2009-09-06)
- Version 0.2.6.3 (2009-06-13)
- Version 0.2.6.2 (2009-04-18)
- Version 0.2.6.1 (2009-03-14)
- Version 0.2.6 (2007-09-06)
- Version 0.2.5 (2007-06-07)
- Version 0.2.4 (2007-03-29)
- Version 0.2.3 (2007-01-10)
- Version 0.2.2 (2007-01-06)
- Version 0.2.1 (2006-10-01)
- Version 0.2.0 (2006-08-19)
- Version 0.1.9 (2006-05-25)
- Version 0.1.8 (2006-03-18)
- Version 0.1.7 (2006-01-14)
- Version 0.1.6 (2005-11-11)
- Version 0.1.5 (2005-09-24)
- Version 0.1.4 (2005-07-30)
- Version 0.1.3 (2005-07-02)
- Version 0.1.2 (2005-05-21)
- Version 0.1.1 (2005-03-20)
- Version 0.1.0 (2005-02-12)
- Version 0.0.9 (2005-01-01)
- Version 0.0.8 (2004-10-30)
- Version 0.0.7 (2004-08-08)
- Version 0.0.6 (2004-06-05)
- Version 0.0.5 (2004-02-07)
- Version 0.0.4 (2004-01-01)
- Version 0.0.3 (2003-11-03)
- Version 0.0.2 (2003-10-05)
- Version 0.0.1 (2003-09-27)
This document lists important changes for each version, that require manual
actions (the latest formatted version of this document can be found
here).
It is recommended to read it when upgrading to a new stable
version.
For a complete list of changes, please look at ChangeLog (file ChangeLog.adoc in sources).
The command /buffer localvar
has been renamed to /buffer listvar
.
The option localvar
is still supported to stay compatible with scripts
calling it or referencing it in the documentation.
It is deprecated and will be removed in a future release.
New options setvar
and delvar
were also added in command /buffer
,
see /help buffer
.
A new option has been added to allow the script plugin to download the list of scripts and the scripts themselves (on weechat.org by default).
This option is off
by default, so you must opt in if you want to use the
/script
command, even if you upgraded from an old WeeChat version:
/set script.scripts.download_enabled on
Note
|
When this option is enabled, WeeChat can sometimes download again the list of
scripts when you use the /script command, even if you don’t install a script.
|
The command and arguments given to commands /allchan
, /allpv
and /allserv
are now evaluated (see /help on the commands for more information).
Additionally, a breaking change has been introduced: the leading /
is now
required in these commands, so this allows to send text to buffers without
using the command /msg * xxx
.
So with previous releases, to say "hello" on all channels:
/allchan msg * hello
Now it can be done like this:
/allchan hello
If you want to use a command, you must add explicitly the leading /
:
/allchan /msg * hello
A new option has been added in bar: color_bg_inactive. It is used for window bars, when the window is not the active window.
By default this color is set to "default" for default bars, except for status and title: the color is set to "darkgray".
If you upgrade from a previous release, the color will be "default" for all bars, so if you want to use the new default settings, you can do:
/set weechat.bar.title.color_bg_inactive darkgray /set weechat.bar.status.color_bg_inactive darkgray
If you changed the option color_bg in some bars, you should also adjust the new option color_bg_inactive, depending on your needs.
The function "bar_new" in API is updated, so this is an incompatible change: all plugins and scripts calling this function must be updated.
The following scripts are updated consequently to be compatible with all WeeChat versions:
-
buddylist.pl 2.0
-
buffers.pl 5.7
-
chanmon.pl 2.6
-
chanop.py 0.3.2
-
highmon.pl 2.7
-
iset.pl 4.4
-
menu.pl 1.0
-
moc_control.py 1.9
-
newsbar.pl 0.19
-
pv_info.pl 0.0.6
-
rssagg.pl 1.2
-
urlbar.py 14
-
urlselect.lua 0.5
-
vimode.py 0.8
The modifier "weechat_print" has been fixed and the content of "modifier_data" sent to the callback has changed (see issue #42).
This is an incompatible change, therefore all plugins, scripts and triggers using this modifier and the "modifier_data" argument must be updated.
The old format contained plugin name + ";" + buffer name + ";" + tags:
irc;freenode.#weechat;tag1,tag2,tag3
The new format contains buffer pointer + ";" + tags:
0x123abc;tag1,tag2,tag3
The following scripts are updated consequently to be compatible with all WeeChat versions:
-
colorizer.rb 0.2
-
curiousignore.pl 0.4
-
format_lines.pl 1.6
-
identica.py 0.4.3
-
noirccolors.py 0.4
-
parse_relayed_msg.pl 1.9.3
-
unhighlight.py 0.1.3
-
weemoticons.py 0.3
Completion functions have been added in WeeChat 2.9, to allow relay clients or plugins/scripts to complete a string, without using the buffer input.
Therefore two functions have been renamed in API and moved to the new "completion" category:
-
function hook_completion_get_string renamed to completion_get_string
-
function hook_completion_list_add renamed to completion_list_add
Note
|
The old names are still valid for compatibility reasons, but it is recommended to use only the new names as the old ones may be removed in an upcoming release. |
The build options ENABLE_GNUTLS
(in CMake) and --disable-gnutls
(in autotools)
have been removed. That means now GnuTLS is always compiled and used in WeeChat.
Motivations:
-
communications encryption should be built-in, not optional
-
GnuTLS library should be available everywhere
-
reduce complexity of code and tests of builds.
The default trigger "cmd_pass" does not hide any more values of options in /set
command which contain "password" in the name.
The reason is that it was masking values of options that contains the word "password" but the value is not a password and does not contain sensitive data, for example these options were affected:
-
irc.look.nicks_hide_password
-
relay.network.allow_empty_password
-
relay.network.password_hash_algo
-
relay.network.password_hash_iterations
Since all real password options are now evaluated, it is recommended to use
secure data to store the passwords ciphered in config file.
By using secure data, the passwords are never displayed on screen (even with
/set
command) nor written in log files.
For example you can do that:
/secure passphrase my_secret_passphrase /secure set freenode my_password /set irc.server.freenode.sasl_password "${sec.data.freenode}"
This will be displayed like that in WeeChat, using the new regex value of cmd_pass trigger:
/secure passphrase ******************** /secure set freenode *********** /set irc.server.freenode.sasl_password "${sec.data.freenode}"
If you want to use the new trigger regex after upgrade, you can do:
/trigger restore cmd_pass
If ever you prefer the old trigger regex, you can change it like that:
/set trigger.trigger.cmd_pass.regex "==^((/(msg|m|quote) +(-server +[^ ]+ +)?nickserv +(id|identify|set +password|ghost +[^ ]+|release +[^ ]+|regain +[^ ]+|recover +[^ ]+) +)|/oper +[^ ]+ +|/quote +pass +|/set +[^ ]*password[^ ]* +|/secure +(passphrase|decrypt|set +[^ ]+) +)(.*)==${re:1}${hide:*,${re:+}}"
The arguments for a trigger command (except the command itself) are now evaluated.
That means you can use for example new lines in the command description, like that:
/trigger add test command "test;test command;arg1 arg2;arg1: description 1${\n}arg2: description 2"
The command /help test
will display this help in WeeChat:
[trigger] /test arg1 arg2 test command arg1: description 1 arg2: description 2
A handshake command has been added in weechat relay protocol.
The client should send this command before the init to negotiate the way to
authenticate with the relay server.
See the handshake command in Relay protocol doc for more information.
Furthermore, a "nonce" is now generated for each client connecting and must be
used by the client in case of hashed password in the init command.
The goal is to prevent replay attacks in case someone manages to read exchanges
between the client and relay.
When hashing the password, the client must use salt composed by this nonce
as binary (it is hexadecimal and must be base16-decoded), concatenated with
a client nonce after this one.
So the hash is computed on: (server nonce
+ client nonce
+ password
).
This salt is now mandatory even for algorithms SHA256
and SHA512
; this is
a breaking change in protocol, needed for security reasons.
See the init command in Relay protocol doc for more information.
The command line option -a
(or --no-connect
), which can also be used in the
/plugin
command, is now used to set a new info called auto_connect
(see the function "info_get" in the Plugin API reference).
Therefore, the option is not sent any more to the function weechat_plugin_init
of plugins.
The plugins using this option must now get the info auto_connect
and check
if the value is "1" (a string with just 1
).
The purpose of this change is to allow scripts as well to check this info on startup, and connect or not, depending on the value (see issue #1453).
To be compatible with WeeChat ≤ 2.7, the script can do this, for example in Python:
auto_connect = weechat.info_get("auto_connect", "") != "0"
The variable auto_connect
will be set like that, depending on the WeeChat
version:
-
WeeChat ≤ 2.7: always
True
because the info is an empty string (it does not exist), which is different from "0", -
WeeChat ≥ 2.8:
True
by default, andFalse
if-a
or--no-connect
is given by the user (either on command line or when loading the plugin).
When compiling WeeChat with CMake (which is the recommended way), errors are now displayed on any missing dependency, if the optional feature was enabled (most features are automatically enabled, except documentation, man page and tests).
Any error on a missing dependency is fatal, so WeeChat can not be compiled. This is a new behavior compared to old versions, where any missing dependency was silently ignored and the compilation was possible anyway.
For example if PHP is not installed on your system, CMake will display an error on missing PHP library:
-- checking for one of the modules 'php7' CMake Warning at cmake/FindPHP.cmake:57 (message): Could not find libphp7. Ensure PHP >=7.0.0 development libraries are installed and compiled with `--enable-embed`. Ensure `php-config` is in `PATH`. You may set `-DCMAKE_LIBRARY_PATH=...` to the directory containing libphp7. Call Stack (most recent call first): src/plugins/CMakeLists.txt:157 (find_package) CMake Error at src/plugins/CMakeLists.txt:161 (message): Php not found
Then you can either install PHP or explicitly disable PHP if you don’t need this plugin, using this cmake option:
cmake .. -DENABLE_PHP=OFF
The strings sent to script callbacks in Python 3 are now automatically converted according to the content:
-
if the string is valid UTF-8, it is sent as
str
(legacy behavior) -
if the string is not valid UTF-8, it is sent as
bytes
(new).
In some cases only, the string may not be valid UTF-8, so it is received as
bytes
in the callback, which must take care of that.
For more information, see the WeeChat scripting guide: chapter about strings received in callbacks (see also issue #1389).
Note: there are no changes for Python 2 (which is now deprecated and should not
be used any more), the strings sent to callbacks are always of type str
, and
may contain invalid UTF-8 data, in the cases mentioned in the WeeChat scripting
guide.
A new server option called "charset_message" has been added, replacing the option irc.network.channel_encode.
This new server option has three possible values:
-
message (default): the whole IRC message is decoded/encoded, this is the new default behavior; in case of problem with channel names, try to use text instead
-
channel: the message is decoded/encoded starting at the channel name (or the text if no channel is present); this is like setting the old option irc.network.channel_encode to on
-
text: the message is decoded/encoded starting from the text (for example the user message); this is like setting the old option irc.network.channel_encode to off (so this was the default behavior in previous versions)
Files received via DCC (xfer plugin) now have a suffix ".part" during the transfer. When the transfer is successful, the suffix is removed.
This suffix can be customized with the new option xfer.file.download_temporary_suffix.
If you prefer the legacy behavior (no suffix added), you can set an empty value in the new option:
/set xfer.file.download_temporary_suffix ""
Python 3 is now used by default to compile the "python" plugin (no fallback on Python 2).
The CMake option ENABLE_PYTHON3
has been renamed to ENABLE_PYTHON2
(configure option --enable-python2
). If this option is enabled, the "python"
plugin is built with Python 2 (no fallback on Python 3).
The function to compute the colors based on the nick letters has been fixed (now the function uses only a 64-bit integer even if the underlying architecture is 32-bit).
If you’re running WeeChat on a 32-bit architecture and want to keep same colors as the previous releases, you can use one of the two new hash values.
If you were using "djb2", you can switch to "djb2_32":
/set weechat.look.nick_color_hash djb2_32
If you were using "sum", you can switch to "sum_32":
/set weechat.look.nick_color_hash sum_32
The "aspell" plugin has been renamed to "spell", a more generic term, because it supports aspell and also enchant.
Consequently, the following things have been renamed as well:
-
file aspell.conf renamed to spell.conf; the content of the file has not changed, so you can just rename the file to keep your changes
-
options aspell.* renamed to spell.*
-
command
/aspell
renamed to/spell
-
default key kbd:[Alt+s] changed to
/mute spell toggle
-
bar item aspell_dict renamed to spell_dict
-
bar item aspell_suggest renamed to spell_suggest
-
info aspell_dict renamed to spell_dict
If you are upgrading from a previous release, you can copy the config file
before doing /upgrade
, in WeeChat:
/save aspell /exec -sh cp ~/.weechat/aspell.conf ~/.weechat/spell.conf /upgrade
If you already upgraded WeeChat:
/exec -sh cp ~/.weechat/aspell.conf ~/.weechat/spell.conf /reload spell
Once configuration is OK, you can delete the file ~/.weechat/aspell.conf.
Then you can search if you are using "aspell" in values of options:
/fset =aspell
If there are options displayed, replace "aspell" by "spell" in values.
The default key kbd:[Alt+s] can be changed to the new /spell
command:
/key bind meta-s /mute spell toggle
The option xfer.network.speed_limit has been renamed to xfer.network.speed_limit_send.
If you changed the value of this option, you must set it again after upgrade.
A new option xfer.network.speed_limit_recv has been added to limit the speed of received files.
The hook info callback now returns an allocated string, which must be freed after use (in previous versions, a pointer to a static string was returned).
Consequently, the function info_get returns an allocated string, which must be freed after use.
This affects only C code, no changes are required in scripts.
A space is not added automatically any more when you complete a nick at the
beginning of command line.
Purpose of this change is to be more flexible: you can choose whether the space
is added or not (it was always added in previous releases).
The default value of option weechat.completion.nick_completer
has been changed
to add the space by default, but the value of option is not changed automatically
on upgrade.
So you can run this command if you upgraded from an old version and want the space still added automatically:
/set weechat.completion.nick_completer ": "
The default value for option weechat.look.hotlist_add_conditions
has been
changed to take care about the number of connected clients on the relay
with weechat protocol: if at least one client is connected, the buffer is
always added to the hotlist.
The new value contains three conditions, if one of them is true, the buffer is added to the hotlist:
-
${away}
: true if you are away on the server matching the buffer, -
${buffer.num_displayed} == 0
: true if the buffer is not displayed in any window -
${info:relay_client_count,weechat,connected} > 0
: true if at least one client is connected on a weechat relay (new condition).
To use the new default value, you can reset the option with this command:
/unset weechat.look.hotlist_add_conditions
Or set explicitly the value:
/set weechat.look.hotlist_add_conditions "${away} || ${buffer.num_displayed} == 0 || ${info:relay_client_count,weechat,connected} > 0"
The existing triggers "cmd_pass" and "msg_auth" have been updated to hide
password in command /msg nickserv set password
and support the option
-server xxx
.
You can restore the default triggers with the following command:
/trigger restore cmd_pass msg_auth
The IRCv3 tags are now sent in these IRC signals for received messages (xxx is IRC server name, yyy is IRC command name):
-
xxx,irc_in_yyy
-
xxx,irc_in2_yyy
-
xxx,irc_raw_in_yyy
-
xxx,irc_raw_in2_yyy
This could break plugins or scripts that parse IRC messages and don’t expect to receive tags (even if tags are part of the IRC message, so this was a bug in the IRC signals).
See issue #787 for more information.
Note
|
It is recommended for plugins and scripts to use the WeeChat IRC parser: see the function "info_get_hashtable" in the Plugin API reference. |
Now the whole IRC message is received by the signal callback, for example:
@tag1=abc;tag2=def :nick!user@host PRIVMSG #test :this is a test
In older releases, this message was received:
:nick!user@host PRIVMSG #test :this is a test
A new option weechat.completion.partial_completion_templates has been added to
force partial completion on some templates. By default, the option name
completed in /set
and /help
commands are now using partial completion.
If you prefer old behavior, you can remove the templates from the new option with this command:
/set weechat.completion.partial_completion_templates ""
For more information about this feature, you can read help with:
/help weechat.completion.partial_completion_templates
A configuration file has been added for each script plugin: python.conf, perl.conf, ruby.conf, …
Therefore the option to check license of loaded scripts has been moved from plugins.var.<language>.check_license (type: string) to the plugin configuration file (type: boolean, default is off).
List of options moved:
-
plugins.var.python.check_license (string) moved to python.look.check_license (boolean)
-
plugins.var.perl.check_license (string) moved to perl.look.check_license (boolean)
-
plugins.var.ruby.check_license (string) moved to ruby.look.check_license (boolean)
-
plugins.var.lua.check_license (string) moved to lua.look.check_license (boolean)
-
plugins.var.tcl.check_license (string) moved to tcl.look.check_license (boolean)
-
plugins.var.guile.check_license (string) moved to guile.look.check_license (boolean)
-
plugins.var.javascript.check_license (string) moved to javascript.look.check_license (boolean)
-
plugins.var.php.check_license (string) moved to php.look.check_license (boolean)
A new plugin "fset" has been added, it replaces the script iset.pl and has many new features.
By default the fset plugin changes the behavior of /set
command when it is
used with only an option name: it opens the fset buffer if at least one option
is found.
The old behavior was to display the list of options in the core buffer.
If you prefer the old behavior, you can restore it with this command:
/set fset.look.condition_catch_set ""
For more information about this feature, you can read help with:
/help fset.look.condition_catch_set
The Debian packaging has changed (for now only on weechat.org repositories,
not in Debian official repositories).
The package weechat-plugins has been split into 9 packages:
-
weechat-plugins (with only the following plugins: aspell, exec, fifo, relay, script, trigger)
-
weechat-python
-
weechat-perl
-
weechat-ruby
-
weechat-lua
-
weechat-tcl
-
weechat-guile
-
weechat-javascript
-
weechat-php.
If you are using the packages from weechat.org, you will have to install manually the scripting packages (according to the languages you’ll use in WeeChat), for example Python/Perl only:
sudo apt-get install weechat-python weechat-perl
For development packages:
sudo apt-get install weechat-devel-python weechat-devel-perl
The evaluation of expressions in buflist options is not recursive any more,
to prevent too many evaluations, for example in buffer variables
(see issue #1060 for more information).
If you are using custom variables/options containing evaluated expressions,
like ${some.config.option}
, and if this option contains evaluated strings (${…}
),
you must evaluate them with: ${eval:${some.config.option}}
.
Note
|
The default buflist formats (${format_buffer} , ${format_name} ,
${format_hotlist} , …) are automatically evaluated in options buflist.format.buffer,
buflist.format.buffer_current and buflist.format.hotlist.
|
In scripts, the arguments status, gnutls_rc and sock sent to the callback
of hook_connect are now integers (they were strings in older releases).
To be compatible with all versions, it is recommended to convert the argument
to integer before using it, for example in Python: int(sock)
.
A new plugin called "buflist" has been added, it replaces the script "buffers.pl".
If the script is installed, you will see two sidebars with list of buffers.
If you fell in love with buflist and that the script buffers.pl is installed, you can uninstall the script and remove its bar with these commands:
/script remove buffers.pl /bar del buffers
If you don’t want the list of buffers, you can disable buflist:
/set buflist.look.enabled off
To save extra memory, you can even unload the buflist plugin, remove the bar and prevent the plugin from loading on next startup:
/plugin unload buflist /bar del buflist /set weechat.plugin.autoload "*,!buflist"
The option script.scripts.url_force_https has been removed because now the
site weechat.org can only be used with HTTPS.
Both HTTP and HTTPS protocols are allowed in the option script.scripts.url.
For http://weechat.org/ an automatic redirection to https://weechat.org/ will
occur, so you should check that the CA certificates are properly installed
on your machine.
Aspell option with color for suggestion on a misspelled word has been renamed:
-
aspell.color.suggestions has been renamed to aspell.color.suggestion
A new configuration file "fifo.conf" has been added and the old option plugins.var.fifo.fifo has been moved to fifo.file.enabled.
A new option fifo.file.path can be used to customize the FIFO pipe path/filename.
A new trigger "cmd_pass_register" has been added to hide only password and not
email in command /msg nickserv register password email
.
The existing trigger "cmd_pass" has been updated to hide password in all
commands except /msg nickserv register
.
You can add the new trigger and restore the other one with the following command:
/trigger restore cmd_pass_register cmd_pass
Server options with default messages for kick/part/quit have been renamed:
-
options by default for all servers:
-
irc.server_default.default_msg_kick has been renamed to irc.server_default.msg_kick
-
irc.server_default.default_msg_part has been renamed to irc.server_default.msg_part
-
irc.server_default.default_msg_quit has been renamed to irc.server_default.msg_quit
-
-
options in each server:
-
irc.server.xxx.default_msg_kick has been renamed to irc.server.xxx.msg_kick
-
irc.server.xxx.default_msg_part has been renamed to irc.server.xxx.msg_part
-
irc.server.xxx.default_msg_quit has been renamed to irc.server.xxx.msg_quit
-
If you changed the value of these options, you must set them again after upgrade.
Some "printf" functions have been removed from C API (there were not in scripting API):
-
printf_date
-
printf_tags
The function "printf_date_tags" must now be used instead of these functions (the two functions removed were just C macros on function "printf_date_tags" with tags set to NULL for "printf_date" and date set to 0 for "printf_tags").
The nick coloring feature has been moved from irc plugin to core.
Two options have been moved from irc plugin (irc.conf) to core (weechat.conf), and you must set new value if you customized them:
-
irc.look.nick_color_force moved to weechat.look.nick_color_force
-
irc.look.nick_color_hash moved to weechat.look.nick_color_hash
-
irc.look.nick_color_stop_chars moved to weechat.look.nick_color_stop_chars
The default value for option weechat.look.nick_color_hash is now djb2
instead of sum
.
The following info names (used by API function "info_get") are renamed as well:
-
irc_nick_color renamed to nick_color
-
irc_nick_color_name renamed to nick_color_name
Note
|
The old info irc_nick_color and irc_nick_color_name are kept for compatibility (especially scripts) and will be removed in an upcoming release. |
A pointer has been added in all callbacks used by scripts, so the callbacks will receive an extra const void *pointer before the void *data (in the C API only, not scripting API).
This is used to remove linked list of callbacks in scrips (improve speed, reduce memory usage).
Following functions are changed in the C API:
-
exec_on_files
-
config_new
-
config_new_section
-
config_new_option
-
hook_command
-
hook_command_run
-
hook_timer
-
hook_fd
-
hook_process
-
hook_process_hashtable
-
hook_connect
-
hook_print
-
hook_signal
-
hook_hsignal
-
hook_config
-
hook_completion
-
hook_modifier
-
hook_info
-
hook_info_hashtable
-
hook_infolist
-
hook_hdata
-
hook_focus
-
unhook_all
-
buffer_new
-
bar_item_new
-
upgrade_new
-
upgrade_read
The function unhook_all
has a new argument const char *subplugin
to remove
only hooks created by this "subplugin" (script).
The bar item "away" has been moved from irc plugin to core (so that away status can be displayed for any plugin, using the buffer local variable "away").
Two options have been moved from irc plugin (irc.conf) to core (weechat.conf):
-
irc.look.item_away_message moved to weechat.look.item_away_message
-
irc.color.item_away moved to weechat.color.item_away
The option irc.network.alternate_nick has been moved into servers (irc.server_default.nicks_alternate and irc.server.xxx.nicks_alternate).
If you disabled this option, you must switch it off again, globally or by server.
Globally (default value for all servers):
/set irc.server_default.nicks_alternate off
For a specific server:
/set irc.server.freenode.nicks_alternate off
If you are using exotic charsets in your channel names (anything different from UTF-8, like ISO charset), you should turn on a new option:
/set irc.network.channel_encode on
This will force WeeChat to decode/encode the channel name (like WeeChat 1.2 or older did).
See these issues for more information: issue #482, issue #218.
Note
|
It is highly recommended to use only UTF-8 in WeeChat (wherever you can), because everything is stored as UTF-8 internally. |
The command /alias
has been updated to list, add and remove aliases.
Therefore the command /unalias
has been removed.
To add an alias, the argument add
must be used in command /alias
before the
name, for example:
/alias add split /window splith
And the alias is removed with this command:
/alias del split
The word chars are now customizable with two options:
-
weechat.look.word_chars_highlight
-
weechat.look.word_chars_input
The behavior has changed for command line: now any non-word char is used as delimiter for keys to move to previous/next word or delete previous/next word.
You can restore the old behavior (only use spaces as delimiters) with this command:
/set weechat.look.word_chars_input "!\u00A0,!\x20,*"
A new format is used in regex replacement to use regex groups, this format is incompatible with version 1.0.
The existing triggers are NOT automatically updated.
Old format | New format | Examples (new format) |
---|---|---|
|
|
|
|
|
|
|
|
|
Moreover, default triggers used to hide passwords have been fixed for *BSD operating systems.
You can restore them with the following command:
/trigger restore cmd_pass msg_auth server_pass
If you added triggers with the old regex replacement format, you must update them manually.
The command of "beep" trigger is now executed only if the message is displayed (not filtered with /filter).
You can restore the default "beep" trigger with the following command:
/trigger restore beep
The API function weechat_command now sends the value returned return by command callback.
WeeChat does not display any more an error when a command returns WEECHAT_RC_ERROR. Consequently, all plugins/scripts should display an explicit error message before returning WEECHAT_RC_ERROR.
For C plugins, two macros have been added in weechat-plugin.h: WEECHAT_COMMAND_MIN_ARGS and WEECHAT_COMMAND_ERROR.
WeeChat now completes by default inline commands (not only at beginning of line).
When this feature is enabled, there is no more automatic completion of
absolute paths (except if you are completing a path inside a command argument,
like /dcc send <nick> <path>
).
To restore the old behavior (no completion of inline commands):
/set weechat.completion.command_inline off
The option relay.irc.backlog_tags is now a list separated by commas (it was separated by semicolons in older versions).
If you are using a list of tags in this option, you must adjust the value manually.
The string "::ffff:" has been removed from IPv4-mapped IPv6 client address in relay plugin.
If you are using "::ffff:" in option relay.network.allowed_ips, you can remove it.
Creating a temporary server with command /connect <address>
or
/connect irc://...
is now forbidden by default.
A new option has been added to unlock the feature, you can do that for
the old behavior in command /connect
:
/set irc.look.temporary_servers on
The channel type is not any more automatically added to a channel name on join
(for example /join weechat
will not send /join #weechat
).
If you are lazy and want to automatically add the channel type, you can turn on the new option:
/set irc.look.join_auto_add_chantype on
The option irc.look.item_channel_modes_hide_key has been renamed to
irc.look.item_channel_modes_hide_args and is now a string.
It can now hide arguments for multiple channel modes.
By default, a channel key (mode "k") will hide channel arguments. For old behavior (never hide arguments, even with a channel key), you can do:
/set irc.look.item_channel_modes_hide_args ""
The command /input jump_last_buffer
has been replaced by /buffer +
.
You can rebind the key kbd:[Alt+j], kbd:[Alt+l] (L
):
/key bind meta-jmeta-l /buffer +
Note
|
The command /input jump_last_buffer still works for compatibility reasons,
but it should not be used any more.
|
Similarly, a new key has been added to jump to first buffer: kbd:[Alt+j], kbd:[Alt+f]. You can add it with following command:
/key missing
A new option weechat.look.hotlist_add_conditions has been added. This option replaces the option weechat.look.hotlist_add_buffer_if_away, which has been removed.
Default conditions are ${away} || ${buffer.num_displayed} == 0
, which means
that a buffer is added in hotlist if you are away ("away" local variable is
set), or if the buffer is not visible on screen (not displayed in any window).
If you have set weechat.look.hotlist_add_buffer_if_away to off
(to not add
current buffer in hotlist when you are away), then you must manually change the
default conditions with the following command:
/set weechat.look.hotlist_add_conditions "${buffer.num_displayed} == 0"
The trigger plugin replaces the rmodifier plugin, which has been removed (and trigger has much more features than rmodifier).
Default triggers have same features as default rmodifiers (to hide passwords in commands and output).
If you added some custom rmodifiers, you must create similar triggers, see
/help trigger
and the complete trigger doc in the WeeChat User’s guide.
Note
|
If on startup you have an error about API mismatch in plugin rmodifier.so,
you can manually remove the file (the command make install does not remove
obsolete plugins).
|
A bare display mode has been added (for easy text selection and click on URLs),
the new default key is kbd:[Alt+l] (L
).
Use command /key missing
to add the key or /key listdiff
to see differences
between your current keys and WeeChat default keys.
In scripts, the arguments displayed and highlight sent to the callback of
hook_print are now integers (they were strings in older releases).
To be compatible with all versions, it is recommended to convert the argument
to integer before testing it, for example in Python: if int(highlight):
.
The color code for "reverse video" in IRC message has been fixed: now WeeChat
uses 0x16 like other clients (and not 0x12 any more).
The code 0x12 is not decoded any more, so if it is received (for example from
an old WeeChat version), it is not displayed as reverse video.
The color code for "underlined text" in input line has been fixed: now WeeChat uses 0x1F, the same code sent to IRC server.
The default keys for "reverse video" and "underlined text" have changed:
-
reverse video: key kbd:[Ctrl+c], kbd:[r] is replaced by kbd:[Ctrl+c], kbd:[v]
-
underlined text: key kbd:[Ctrl+c], kbd:[u] is replaced by kbd:[Ctrl+c], kbd:[_]
You can remove the old keys and add the new ones with these commands:
/key unbind ctrl-Cr /key unbind ctrl-Cu /key missing
The boolean option weechat.look.set_title has been renamed to weechat.look.window_title and is now a string.
The content is evaluated and the default value is WeeChat ${info:version}
.
Note
|
Only static content should be used in this option, because the title is refreshed only when the option is changed. |
The bar item buffer_count now displays the number of opened buffers (each merged buffer counts 1).
The new bar item buffer_last_number displays the highest buffer number currently used.
If you want to display last number in the status bar, replace buffer_count by buffer_last_number in your option weechat.bar.status.items.
A new bar item has been added: buffer_zoom. The default value for status bar items becomes:
/set weechat.bar.status.items "[time],[buffer_count],[buffer_plugin],buffer_number+:+buffer_name+(buffer_modes)+{buffer_nicklist_count}+buffer_zoom+buffer_filter,[lag],[hotlist],completion,scroll"
The names are not displayed any more by default on channel join (they are in nicklist anyway).
Names can be displayed with the value "353" in option
irc.look.display_join_message (which is not in default value).
The value "366" shows only names count on channel.
If you want to display all messages on join (including names), you can do:
/set irc.look.display_join_message "329,332,333,353,366"
The day change message is now dynamically displayed, and therefore is not stored as a line in buffer any more.
Option weechat.look.day_change_time_format has been split into two options
weechat.look.day_change_message{1date|2dates}_ (color codes are allowed in
these options, see /help eval
).
New color option weechat.color.chat_day_change has been added.
After /upgrade
from an old version, you will see two messages for each day
change. This is a normal behavior and will not happen again with the next day
changes.
Search with regular expression has been added, and therefore some keys in search context have been changed.
The key kbd:[Ctrl+r] in search context is now used to switch string/regex search (instead of searching exact text).
If you never changed keys in search context, you can reset them all with one command:
/key resetall -yes search
Or the manual method:
/key missing search /key bindctxt search ctrl-R /input search_switch_regex
To view keys in search context:
/key list search
For more information, see the chapter about keys in the WeeChat User’s guide.
A new rmodifier "secure" has been added to hide passphrase and passwords
displayed by command /secure
. Use command /rmodifier missing
to add it.
The format for color codes in some options has changed. The options are
evaluated with the function "string_eval_expression", which uses the format
${color:xxx}
.
Following options are affected:
-
weechat.look.buffer_time_format
-
weechat.look.prefix_action
-
weechat.look.prefix_error
-
weechat.look.prefix_join
-
weechat.look.prefix_network
-
weechat.look.prefix_quit
The options using old format ${xxx}
must be changed with new format
${color:xxx}
(where xxx is a color name or number, with optional color
attributes).
Example:
/set weechat.look.buffer_time_format "${color:251}%H${color:243}%M${color:238}%S"
WeeChat binary and man page have been renamed from weechat-curses
to
weechat
.
A symbolic link has been added for binary: weechat-curses
→ weechat
(so that the /upgrade from a old version will still work).
If you upgrade from an old version, it is recommended to force the use of the
new binary name with the command: /upgrade /path/to/weechat
(replace the path
accordingly).
Note
|
For packagers: you should create the link weechat-curses → weechat if it’s
not automatically created in the package (both CMake and configure are creating
this link on make install).
|
Documentation is not built by default any more, you have to use option
-DENABLE_DOC=ON
in cmake command to enable it.
The man page is now built with asciidoc and translated in several
languages. A new CMake option ENABLE_MAN
has been added to compile man page
(OFF
by default).
A new message with identifier "_nicklist_diff" has been added in relay (WeeChat protocol). WeeChat may decide to send full nicklist or this nicklist diff at any time (depending on size of message, the smaller is sent).
Clients using nicklist must implement it.
For more info about content of message, see document WeeChat Relay Protocol.
The nick prefix/suffix (for example: "<" and ">") are now dynamic and used on display (not stored any more in the line).
Options moved from irc plugin (irc.conf) to core (weechat.conf):
-
irc.look.nick_prefix moved to weechat.look.nick_prefix
-
irc.look.nick_suffix moved to weechat.look.nick_suffix
-
irc.color.nick_prefix moved to weechat.color.chat_nick_prefix
-
irc.color.nick_suffix moved to weechat.color.chat_nick_suffix
Types and default values for these four options remain unchanged.
Two new options to customize the truncature char (by default “+”):
-
weechat.look.prefix_align_more_after (boolean, on by default)
-
weechat.look.prefix_buffer_align_more_after (boolean, on by default)
When these options are enabled (default), the “`" is displayed after the text, replacing the space that should be displayed there. + When turned off, the "`” will replace last char of text.
Example for a nicks "FlashCode" and "fc" with different values for options weechat.look.prefix_align_max, weechat.look.prefix_align_more_after, weechat.look.nick_prefix and weechat.look.nick_suffix:
# align_max, more_after, prefix/suffix FlashCode │ test # 0, on fc │ test FlashCod+│ test # 8, on fc │ test FlashCo+ │ test # 8, off fc │ test <FlashCode> │ test # 0, on, < > <fc> │ test <FlashC>+│ test # 8, on, < > <fc> │ test <Flash+> │ test # 8, off, < > <fc> │ test
After /upgrade
, if you set new options to non-empty strings, and if old
options were set to non-empty strings too, you will see double prefix/suffix
on old messages, this is normal behavior (lines displayed before /upgrade
have prefix/suffix saved in prefix, but new lines don’t have them any more).
New options in logger plugin (logger.conf):
-
logger.file.nick_prefix: prefix for nicks in log files (default: empty string)
-
logger.file.nick_suffix: suffix for nicks in log files (default: empty string)
Option irc.network.lag_disconnect has been renamed to irc.network.lag_reconnect and value is now a number of seconds (instead of minutes).
If you changed the value of this option, you must set it again after upgrade.
IRC passwords hidden
IRC plugin is now using modifiers "irc_command_auth" and "irc_message_auth" to hide passwords.
The option irc.look.hide_nickserv_pwd has been removed, and a new option irc.look.nicks_hide_password has been added (by default passwords are hidden only for "nickserv").
A new rmodifier "message_auth" has been added to hide passwords displayed by
command /msg nickserv identify|register|ghost|release
and the rmodifier
"nickserv" has been renamed to "command_auth".
If you never added/changed rmodifiers, you can just reset all rmodifiers:
/rmodifier default -yes
If you added/changed some rmodifiers, do it manually with these commands:
/rmodifier del nickserv /rmodifier add command_auth history_add,input_text_display,irc_command_auth 1,4* ^(/(msg|quote) +nickserv +(id|identify|register|ghost \S+|release \S+) +)(.*) /rmodifier add message_auth irc_message_auth 1,3* ^(.*(id|identify|register|ghost \S+|release \S+) +)(.*)
For consistency with other supported languages, the API constants in Lua have been redefined as constants instead of functions.
Therefore, the use of a constant must be changed: the parentheses must be removed.
The old syntax was:
return weechat.WEECHAT_RC_OK()
The new syntax is:
return weechat.WEECHAT_RC_OK
Conditions in bars have changed, and now an expression is evaluated.
If you have a value with many conditions in a bar, like: nicklist,active
, you
must now use an expression like: ${nicklist} && ${active}
(see the chapter
about bars in the WeeChat User’s guide).
IPv6 is now used by default to connect to IRC servers, with fallback to IPv4. The option irc.server_default.ipv6 is now "on" by default. If IPv6 is not enabled or fails, IPv4 will be used. The "ipv6" option in server is now used to disable IPv6 and force IPv4 (if option is turned "off").
Relay plugin is now listening by default on an IPv6 socket (new option relay.network.ipv6, on by default), so connections with IPv4 will have IPv4-mapped IPv6 addresses, like: "::ffff:127.0.0.1" (for "127.0.0.1"); check that value of option relay.network.allowed_ips supports this mapping, or disable IPv6 in relay if you don’t plan to use it at all:
/set relay.network.ipv6 off
This version fixes a security vulnerability when a plugin/script gives untrusted command to API function "hook_process".
Options moved from core (weechat.conf) to irc plugin (irc.conf):
-
weechat.look.nickmode moved to irc.look.nick_mode (new type: integer with values: none/prefix/action/both)
-
weechat.look.nickmode_empty moved to irc.look.nick_mode_empty
A new bar item has been added: buffer_modes and irc option irc.look.item_channel_modes has been removed; to display irc channel modes in status bar (after channel name), you have to manually add the new item buffer_modes (this is now used by default in status bar items), default value for status bar items becomes:
/set weechat.bar.status.items "[time],[buffer_count],[buffer_plugin],buffer_number+:+buffer_name+(buffer_modes)+{buffer_nicklist_count}+buffer_filter,[lag],[hotlist],completion,scroll"
New options in command /aspell
:
-
enable
: enable aspell -
disable
: disable aspell -
toggle
: toggle aspell (new default key: kbd:[Alt+s])
Options renamed in command /aspell
:
-
enable
renamed tosetdict
(set dictionary for current buffer) -
disable
renamed todeldict
(delete dictionary used on current buffer) -
dictlist
renamed tolistdict
(show installed dictionaries)
An horizontal separator has been added between split windows, and two options have been added to toggle separators (both are enabled by default):
-
weechat.look.window_separator_horizontal
-
weechat.look.window_separator_vertical
Options weechat.look.prefix_align_more and weechat.look.prefix_buffer_align_more have been converted from type boolean to string:
-
If the value was on (default), new value is "+" and you can now customize this char.
-
If the value was off, you have to set " " (string with one space).
Option weechat.look.paste_max_lines can now be used with value 0 to detect paste with one line (only if terminal "bracketed paste mode" is enabled when option weechat.look.paste_bracketed is on); so now the value -1 is used to disable paste detection: if your value was 0, you should set it to -1:
/set weechat.look.paste_max_lines -1
Rmodifier "nickserv" has a new default regex which includes option "release"
for command /msg nickserv
.
If you never added/changed rmodifiers, you can just reset all rmodifiers:
/rmodifier default -yes
If you added/changed some rmodifiers, do it manually with these commands:
/rmodifier del nickserv /rmodifier add nickserv history_add,input_text_display 1,4* ^(/(msg|quote) +nickserv +(id|identify|ghost \S+|release \S+) +)(.*)
Option scroll_unread
has been moved from command /input
to /window
,
therefore default command of key kbd:[Alt+u] has been updated. To bind key with
new default value:
/key bind meta-u /window scroll_unread
Option weechat.history.max_lines has been renamed to weechat.history.max_buffer_lines_number.
If you changed the value of this option, you must set it again after upgrade.
Option weechat.plugin.extension now supports list of extensions, and new default value is ".so,.dll" (with this value, weechat.conf is compatible with Cygwin).
Extended regex is used in filters and irc ignore, so some chars that needed
escape in past do not need any more (for example [0-9]+
becomes [0-9]+
),
filters and ignore have to be manually fixed.
Option weechat.look.highlight_regex becomes case insensitive by default, to make it case sensitive, use "(?-i)" at beginning of string, for example: "(?-i)FlashCode|flashy".
Option weechat.look.hline_char has been renamed to weechat.look.separator_horizontal.
If you changed the value of this option, you must set it again after upgrade.
If you have some colors defined in section "palette" with version 0.3.4, you should remove all colors defined, and add new aliases (it’s not needed any more to add colors before using them).
Colors for nick prefixes (char for op, voice, ..) are defined in a single option irc.color.nick_prefixes, therefore following options will be lost: irc.color.nick_prefix_op, irc.color.nick_prefix_halfop, irc.color.nick_prefix_voice, irc.color.nick_prefix_user.
Count of messages have been added to hotlist by default, if you want to come back to old behavior, do that:
/set weechat.look.hotlist_count_max 0 /set weechat.look.hotlist_buffer_separator ","
If you are using /upgrade
from a previous release:
-
Some nick prefixes can be wrong, so it is recommended to do
/allchan names
. -
Nick colors are defined with a new option weechat.color.chat_nick_colors, therefore old options weechat.color.chat_nick_color1..10 will be lost when upgrading.
-
Nick colors in messages displayed will be wrong if you changed some nick colors (old default colors will be used).
Some IRC options have been renamed, before upgrading to this version, note value for old options, and set them again with new name:
-
options moved from network section to servers (with global value, and server value, like other server options):
-
irc.network.connection_timeout moved to irc.server_default.connection_timeout
-
irc.network.anti_flood_prio_high moved to irc.server_default.anti_flood_prio_high
-
irc.network.anti_flood_prio_low moved to irc.server_default.anti_flood_prio_low
-
irc.network.away_check moved to irc.server_default.away_check
-
irc.network.away_check_max_nicks moved to irc.server_default.away_check_max_nicks
-
irc.network.default_msg_part moved to irc.server_default.default_msg_part
-
irc.network.default_msg_quit moved to irc.server_default.default_msg_quit
-
-
other IRC options renamed:
-
irc.look.open_channel_near_server moved to irc.look.new_channel_position (old option was boolean, new is integer with value as string)
-
irc.look.open_pv_near_server moved to irc.look.new_pv_position (old option was boolean, new is integer with value as string)
-
If you are using /upgrade
from a previous release, then you must reconnect to
IRC servers in order to use new command /wallchops.
This version fixes crashes with SSL connection and purge of old DCC chats.
All users of version 0.3.1 should upgrade to this version.
This version brings MAJOR changes, especially for configuration files and plugin API and is not compatible with previous versions.
Major differences:
-
It is NOT POSSIBLE to use command
/upgrade
from a version 0.2.x to 0.3.x; you have to quit your old WeeChat, then run new version. -
New configuration files (
.conf
) are not compatible with old files (.rc
). -
Name of options is similar to old versions, but there is now one configuration file by plugin, and one file for WeeChat core; there is no automatic conversion for your old options to new configuration files, so you’ll have to setup again your IRC servers and all other options.
-
Plugin API has been rewritten and is not compatible with previous versions; accordingly, scripts and plugins must have been designed for version 0.3.x to be loaded into WeeChat.
This version fixes a major bug: crash with some special chars in IRC messages.
This version fixes several major bugs of version 0.2.2.
All users of version 0.2.2 should upgrade to this version.
For users of any previous version, all your charset settings in weechat.rc will be LOST! You should save your weechat.rc to keep your values and set them again with new charset plugin.
For ISO users: history of channels may be without accents (after /upgrade
),
this is not recoverable, but this is not a bug. All new messages should be OK.
Be careful, now default encode is UTF-8 for all channels (before it was terminal charset). If you still want to send messages as ISO-8859-1, you should set either global encode or server specific encode to ISO-8859-1.
For global encode:
/setp charset.global.encode = "ISO-8859-1"
For server encode (on server buffer):
/charset encode ISO-8859-1
New keys for topic scroll: kbd:[F9]/kbd:[F10].
Key kbd:[F10] was used for infobar_clear
in previous WeeChat versions, you
have to manually rebind this key (except for new WeeChat users):
/key <press alt+"k" then F10> scroll_topic_right
Which gives something like:
/key meta2-21~ scroll_topic_right
If you upgraded with /upgrade
in WeeChat, you should /disconnect
and then
/reconnect
on each server, to display properly channel/user modes.
Please close all DCC chat buffers before using /upgrade command, otherwise you may experience problems with DCC chats.
After installing 0.1.8 (or with /upgrade
), issue both commands (if you didn’t
redefine these keys (kbd:[Alt+Home] / kbd:[Alt+End]):
/key unbind meta-meta2-1~ /key unbind meta-meta2-4~
Then launch again WeeChat (or issue /upgrade
).
It is recommended for users of version 0.1.7 (or any older), to replace values in setup file (~/.weechat/weechat.rc):
-
option: log_path: replace ~/.weechat/logs by %h/logs
-
option: plugins_path: replace ~/.weechat/plugins by %h/plugins
The string %h is replaced by WeeChat home (default: ~/.weechat, may be
overridden by new command line argument --dir
).
Incompatibility with some old scripts: now all handlers have to return a code for completion, and to do some actions about message to ignore (please look at documentation for detail).
On OpenBSD, the new option plugins_extension should be set to .so.0.0 since the plugins names are ending by .so.0.0 and not .so.
With new and full UTF-8 support, the option look_charset_internal should be set to blank for most cases. Forces it only if your locale is not properly detected by WeeChat (you can set UTF-8 or ISO-8859-15 for example, depending on your locale). WeeChat is looking for UTF-8 in your locale name at startup.