weechat/ReleaseNotes.adoc

2100 lines
60 KiB
Plaintext

= WeeChat Release Notes
:author: Sébastien Helleu
:email: flashcode@flashtux.org
:lang: en
:toc: left
:docinfo1:
This document lists important changes for each version, that require manual
actions (the latest formatted version of this document can be found
https://weechat.org/files/releasenotes/ReleaseNotes-devel.html[here]). +
It is recommended to read it when upgrading to a new stable
version.
For a complete list of changes, please look at
https://weechat.org/files/changelog/ChangeLog-devel.html[ChangeLog]
(file _ChangeLog.adoc_ in sources).
[[v2.9]]
== Version 2.9 (under dev)
[[v2.9_relay_weechat_protocol_handshake_nonce]]
=== Add of handshake and nonce in weechat relay protocol
==== Handshake
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 link:weechat_relay_protocol.en.html#command_handshake[handshake command]
in Relay protocol doc for more information.
==== Server "nonce"
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 link:weechat_relay_protocol.en.html#command_init[init command]
in Relay protocol doc for more information.
[[v2.9_trigger_command_eval]]
=== Evaluation of trigger command arguments
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
----
[[v2.8]]
== Version 2.8 (2020-03-29)
[[v2.8_auto_connection_to_servers]]
=== Auto connection to servers
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:
[source,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, and `False` if `-a` or `--no-connect` is
given by the user (either on command line or when loading the plugin).
[[v2.7.1]]
== Version 2.7.1 (2020-02-20)
Bug fix and maintenance release.
[[v2.7]]
== Version 2.7 (2019-12-08)
[[v2.7_cmake_errors]]
=== CMake errors on missing dependencies
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
----
[[v2.7_python3_callbacks_strings]]
=== Strings received in Python 3 callbacks
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.
[[v2.7_irc_message_decoding]]
=== IRC message decoding/encoding
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)
[[v2.7_xfer_file_receive_suffix]]
=== Suffix for files received via DCC
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 ""
----
[[v2.6]]
== Version 2.6 (2019-09-08)
[[v2.6_python3_default]]
=== Python 3 by default
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).
[[v2.6_nick_colors]]
=== Nick colors
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
----
[[v2.5]]
== Version 2.5 (2019-06-06)
[[v2.5_aspell_plugin_renamed]]
=== Aspell plugin renamed to Spell
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
----
[[v2.5_xfer_option_speed_limit]]
=== Speed limit option for DCC files
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.
[[v2.5_hook_info_allocated_string]]
=== Allocated string in hook info and function info_get
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.
[[v2.4]]
== Version 2.4 (2019-02-17)
[[v2.4_nick_completer]]
=== Nick completer
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 ": "
----
[[v2.4_api_base64_functions]]
=== Base64 API functions
The functions to encode/decode base64 strings have been renamed and now support
base 16, 32, and 64.
New functions in C API, supporting base 16, 32, and 64:
* string_base_encode
* string_base_decode
Functions removed from C API:
* string_encode_base64
* string_decode_base64
[[v2.3]]
== Version 2.3 (2018-10-21)
No release note.
[[v2.2]]
== Version 2.2 (2018-07-14)
[[v2.2_default_hotlist_conditions]]
=== Default conditions for hotlist
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"
----
[[v2.2_default_triggers]]
=== Default triggers
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
----
[[v2.2_irc_signals_tags]]
=== Tags in IRC "in" signals
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
----
[[v2.2_debian_headless_package]]
=== New Debian package for headless version
A new Debian package has been added: _weechat-headless_ which contains the
binary _weechat-headless_ and its man page.
In version 2.1, this binary was in the package _weechat-curses_.
[[v2.1]]
== Version 2.1 (2018-03-18)
[[v2.1_option_name_completion]]
=== Completion for /set and /help commands
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
----
[[v2.1_script_plugin_check_license]]
=== Option to check license of scripts loaded
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)
[[v2.0.1]]
== Version 2.0.1 (2017-12-20)
Bug fix and maintenance release.
[[v2.0]]
== Version 2.0 (2017-12-03)
[[v2.0_fset_plugin]]
=== Fset plugin
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
----
[[v2.0_debian_packaging]]
=== Split of scripting Debian packages
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
----
[[v2.0_buflist_eval]]
=== Evaluation in buflist
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_.
[[v2.0_hook_connect]]
=== Function hook_connect
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)`.
[[v2.0_hook_fd]]
=== Function hook_fd
In scripts, the argument _fd_ sent to the callback of _hook_fd_ is now
an integer (it was a string 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(fd)`.
[[v1.9.1]]
== Version 1.9.1 (2017-09-23)
Bug fix and maintenance release.
[[v1.9]]
== Version 1.9 (2017-06-25)
No release note.
[[v1.8]]
== Version 1.8 (2017-05-13)
[[v1.8_buflist_plugin]]
=== Buflist plugin
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"
----
[[v1.8_options]]
=== Options
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_
[[v1.7.1]]
== Version 1.7.1 (2017-04-22)
Bug fix and maintenance release.
[[v1.7]]
== Version 1.7 (2017-01-15)
[[v1.7_fifo_options]]
=== FIFO options
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.
[[v1.7_default_triggers]]
=== Default triggers
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
----
[[v1.6]]
== Version 1.6 (2016-10-02)
[[v1.6_irc_server_default_msg]]
=== IRC kick/part/quit default messages
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.
[[v1.6_api_printf]]
=== Printf API functions
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").
[[v1.5]]
== Version 1.5 (2016-05-01)
[[v1.5_nick_coloring]]
=== Nick coloring moved to core
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.
[[v1.5_callbacks_pointer]]
=== Pointer in callbacks
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).
[[v1.5_bar_item_away]]
=== Bar item "away"
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_
[[v1.5_default_triggers]]
=== Default triggers
The default triggers "cmd_pass" and "msg_auth" have been updated to include
nickserv commands "recover" and "regain".
You can restore them with the following command:
----
/trigger restore cmd_pass msg_auth
----
[[v1.4]]
== Version 1.4 (2016-01-10)
[[v1.4_irc_alternate_nicks]]
=== IRC alternate nicks
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
----
[[v1.3]]
== Version 1.3 (2015-08-16)
[[v1.3_irc_channels_encoding]]
=== IRC channels encoding
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.
[[v1.3_alias_command]]
=== Alias command
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
----
[[v1.3_script_path]]
=== Script path
The option _script.scripts.dir_ has been renamed to _script.scripts.path_
(and the content is now evaluated, see `/help eval`).
If you changed the value of this option, you must set it again after upgrade.
[[v1.2]]
== Version 1.2 (2015-05-10)
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,*"
----
[[v1.1.1]]
== Version 1.1.1 (2015-01-25)
Bug fix and maintenance release.
[[v1.1]]
== Version 1.1 (2015-01-11)
[[v1.1_triggers_regex_format]]
=== New format for regex replacement in triggers
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*.
[width="60%",cols="2,2,3",options="header"]
|===
| Old format | New format | Examples (new format)
| `$0` ... `$99` | `${re:0}` ... `${re:99}` | `${re:1}`
| `$+` | `${re:+}` | `${re:+}`
| `$.*N` | `${hide:*,${re:N}}` | `${hide:*,${re:2}}` +
`${hide:-,${re:+}}`
|===
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.
[[v1.1_trigger_beep]]
=== Default "beep" trigger
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
----
[[v1.1_commands_return_code]]
=== Return code of commands
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_.
[[v1.1_inline_commands_completion]]
=== Completion of inline commands
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
----
[[v1.1_relay_irc_backlog_tags]]
=== Relay option relay.irc.backlog_tags
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.
[[v1.1_relay_ipv6_ipv4]]
=== IPv4-mapped IPv6 client address in relay
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.
[[v1.1_irc_temporary_servers]]
=== Temporary servers disabled by default with /connect
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
----
[[v1.1_timeval_microseconds]]
=== Microseconds in API timeval functions
The API functions using timeval are now using or returning microseconds,
instead of milliseconds:
* function _util_timeval_diff_: returns microseconds
* function _util_timeval_add_: the argument _interval_ is now expressed in
microseconds.
[[v1.0.1]]
== Version 1.0.1 (2014-09-28)
Bug fix and maintenance release.
[[v1.0]]
== Version 1.0 (2014-08-15)
[[v1.0_irc_channel_type]]
=== Channel type not added by default on /join
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
----
[[v1.0_irc_channel_modes_arguments]]
=== Hide IRC channel modes arguments
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 ""
----
[[v1.0_jump_first_last_buffer]]
=== Jump to first/last buffer
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
----
[[v1.0_hotlist_conditions]]
=== Hotlist conditions
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"
----
[[v1.0_trigger_plugin]]
=== Rmodifier replaced by Trigger plugin
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).
[[v1.0_bare_display]]
=== Bare display
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.
[[v1.0_hook_print]]
=== Function hook_print
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):`.
[[v0.4.3]]
== Version 0.4.3 (2014-02-09)
[[v0.4.3_colors_messages]]
=== Colors in messages
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
----
[[v0.4.3_terminal_title]]
=== Terminal title
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.
[[v0.4.3_bar_item_buffer_last_number]]
=== New bar item buffer_last_number
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_.
[[v0.4.3_bar_item_buffer_zoom]]
=== New bar item buffer_zoom
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"
----
[[v0.4.3_irc_messages_channel_join]]
=== IRC messages on channel join
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"
----
[[v0.4.3_irc_maximum_lag]]
=== Maximum lag in IRC
Option _irc.network.lag_max_ has been added.
The value of option _irc.network.lag_reconnect_ (if set to non-zero value) must
be less than or equal to _irc.network.lag_max_, otherwise the reconnection will
never occur.
You should check the value of both options and fix them if needed.
[[v0.4.2]]
== Version 0.4.2 (2013-10-06)
[[v0.4.2_day_change_message]]
=== Day change message
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.
[[v0.4.2_buffer_regex_search]]
=== Regex search in buffer
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_.
[[v0.4.2_rmodifier]]
=== New rmodifier
A new rmodifier "secure" has been added to hide passphrase and passwords
displayed by command `/secure`. Use command `/rmodifier missing` to add it.
[[v0.4.2_color_codes_options]]
=== Color codes in options
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"
----
[[v0.4.2_binary_man_page]]
=== Binary and man page
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).
[[v0.4.2_man_page_documentation]]
=== Man page / documentation
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).
[[v0.4.2_aspell_colors]]
=== Aspell colors
Option _aspell.look.color_ has been renamed to _aspell.color.misspelled_.
If you changed the value of this option, you must set it again after upgrade.
[[v0.4.1]]
== Version 0.4.1 (2013-05-20)
[[v0.4.1_relay_nicklist_diff]]
=== Nicklist diff in relay
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_.
[[v0.4.1_dynamic_nick_prefix_suffix]]
=== Dynamic nick prefix/suffix
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)
[[v0.4.1_irc_reconnection_lag]]
=== IRC reconnection on important lag
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.
[[v0.4.1_irc_passwords_hidden]]
=== 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+) +)(.*)
----
[[v0.4.1_lua_constants]]
=== Lua constants
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:
[source,lua]
----
return weechat.WEECHAT_RC_OK()
----
The new syntax is:
[source,lua]
----
return weechat.WEECHAT_RC_OK
----
[[v0.4.1_guile_callbacks]]
=== Guile callbacks
The way to give arguments for guile callbacks has been fixed: now arguments are
sent individually (instead of a list with all arguments inside).
Therefore, existing guile scripts must be modified accordingly. Moreover,
WeeChat now requires Guile ≥ 2.0 to compile.
[[v0.4.0]]
== Version 0.4.0 (2013-01-20)
[[v0.4.0_bars_conditions]]
=== Conditions in bars
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_).
[[v0.4.0_ipv6_default]]
=== IPv6 by default
==== IRC
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
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
----
[[v0.3.9.2]]
== Version 0.3.9.2 (2012-11-18)
This version fixes a security vulnerability when a plugin/script gives
untrusted command to API function "hook_process".
[[v0.3.9.1]]
== Version 0.3.9.1 (2012-11-09)
This version fixes crash when decoding IRC colors in strings.
[[v0.3.9]]
== Version 0.3.9 (2012-09-29)
[[v0.3.9_options_moved]]
=== Options moved
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_
[[v0.3.9_bar_item_buffer_modes]]
=== New bar item buffer_modes
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"
----
[[v0.3.9_command_aspell]]
=== Command /aspell
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 to `setdict` (set dictionary for current buffer)
* `disable` renamed to `deldict` (delete dictionary used on current buffer)
* `dictlist` renamed to `listdict` (show installed dictionaries)
[[v0.3.9_horizontal_separator]]
=== Horizontal separator
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_
[[v0.3.9_new_keys]]
=== New keys
New keys were added, use command `/key missing` to add them or `/key listdiff`
to see differences between your current keys and WeeChat default keys.
[[v0.3.8]]
== Version 0.3.8 (2012-06-03)
[[v0.3.8_options]]
=== Options
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).
[[v0.3.8_paste_detection]]
=== Paste detection
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
----
[[v0.3.8_rmodifier]]
=== Rmodifier
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+) +)(.*)
----
[[v0.3.7]]
== Version 0.3.7 (2012-02-26)
[[v0.3.7_options]]
=== Options
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).
[[v0.3.7_extended_regex]]
=== Extended regex
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".
[[v0.3.6]]
== Version 0.3.6 (2011-10-22)
[[v0.3.6_options]]
=== Options
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.
[[v0.3.6_colors_bold]]
=== Bold in colors
Bold is not used any more for basic colors (used only if terminal has less than
16 colors), a new option has been added to force bold if needed:
_weechat.look.color_basic_force_bold_.
[[v0.3.5]]
== Version 0.3.5 (2011-05-15)
[[v0.3.5_colors]]
=== Colors
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_.
[[v0.3.5_hotlist]]
=== Hotlist
[[v0.3.5_hotlist_counters]]
==== Counters
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 ","
----
[[v0.3.5_hotlist_away_current_buffer]]
==== Away and current buffer
When you are away, all buffers are now added to hotlist by default (even if
they are displayed in a window), if you want to come back to old behavior, do
that:
----
/set weechat.look.hotlist_add_buffer_if_away off
----
[[v0.3.5_new_keys]]
=== New keys
New keys were added, use command `/key missing` to add them or `/key listdiff`
to see differences between your current keys and WeeChat default keys.
[[v0.3.4]]
== Version 0.3.4 (2011-01-16)
[[v0.3.4_after_upgrade]]
=== After /upgrade
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).
[[v0.3.4_options]]
=== Options
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)
[[v0.3.3]]
== Version 0.3.3 (2010-08-07)
[[v0.3.3_after_upgrade]]
=== After /upgrade
If you are using `/upgrade` from a previous release, then you must reconnect to
IRC servers in order to use new command /wallchops.
[[v0.3.3_options]]
=== Options
Option _irc.look.show_away_once_ has been renamed to
_irc.look.display_pv_away_once_.
Option _irc.network.lag_min_show_ is now in milliseconds, you should set new
value: your current value multiplied by 1000 (new default value is 500).
[[v0.3.2]]
== Version 0.3.2 (2010-04-18)
[[v0.3.2_after_upgrade]]
=== After /upgrade
If you are using `/upgrade` from a previous release, then you must execute this
command on all IRC servers/channels/private buffers and xfer DCC chats (not
needed on WeeChat core buffer or buffers from other plugins/scripts):
----
/buffer set highlight_words $nick
----
[[v0.3.1.1]]
== Version 0.3.1.1 (2010-01-31)
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.
[[v0.3.1]]
== Version 0.3.1 (2010-01-23)
[[v0.3.1_aliases]]
=== Aliases
IRC commands /ame and /amsg are now aliases, if you are upgrading from version
0.3.0, you must create aliases with following commands:
----
/alias aaway allserv /away
/alias ame allchan /me
/alias amsg allchan /amsg *
/alias anick allserv /nick
----
[[v0.3.0]]
== Version 0.3.0 (2009-09-06)
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.
[[v0.2.6.3]]
== Version 0.2.6.3 (2009-06-13)
This version fixes gnutls detection.
[[v0.2.6.2]]
== Version 0.2.6.2 (2009-04-18)
This version fixes a bug with charset decoding (like _iso2022jp_).
[[v0.2.6.1]]
== Version 0.2.6.1 (2009-03-14)
This version fixes a major bug: crash with some special chars in IRC messages.
[[v0.2.6]]
== Version 0.2.6 (2007-09-06)
No release note.
[[v0.2.5]]
== Version 0.2.5 (2007-06-07)
No release note.
[[v0.2.4]]
== Version 0.2.4 (2007-03-29)
No release note.
[[v0.2.3]]
== Version 0.2.3 (2007-01-10)
This version fixes several major bugs of version 0.2.2.
All users of version 0.2.2 should upgrade to this version.
[[v0.2.2]]
== Version 0.2.2 (2007-01-06)
[[v0.2.2_charset_plugin]]
=== Charset plugin
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
----
[[v0.2.2_new_keys]]
=== New keys
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
----
[[v0.2.1]]
== Version 0.2.1 (2006-10-01)
No release note.
[[v0.2.0]]
== Version 0.2.0 (2006-08-19)
[[v0.2.0_after_upgrade]]
=== After /upgrade
If you upgraded with `/upgrade` in WeeChat, you should `/disconnect` and then
`/reconnect` on each server, to display properly channel/user modes.
[[v0.2.0_plugins]]
=== Plugins
If you're using plugins, you should remove some old plugins libraries in
WeeChat system library directory (commonly _/usr/local/lib/weechat/plugins_):
remove `lib*` files (like `libperl.*`, `libpython.*`, ..) and keep only new
libraries (`perl.*`, `python.*`, ..).
[[v0.1.9]]
== Version 0.1.9 (2006-05-25)
[[v0.1.9_dcc_chat]]
=== DCC chat
Please close all DCC chat buffers before using /upgrade command, otherwise you
may experience problems with DCC chats.
[[v0.1.9_script_api]]
=== Script API
Some changes in script API: now timer handlers functions takes exactly 0 (zero)
argument (in version 0.1.8, two arguments were mandatory but not used: server
and arguments).
[[v0.1.8]]
== Version 0.1.8 (2006-03-18)
[[v0.1.8_after_upgrade]]
=== After /upgrade
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`).
[[v0.1.8_configuration_files]]
=== Configuration files
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`).
[[v0.1.8_keys]]
=== Keys
Keys kbd:[Alt+Home] / kbd:[Alt+End] were used for nicklist scroll, they're now
replaced by kbd:[Alt+F11] / kbd:[Alt+F12].
[[v0.1.7]]
== Version 0.1.7 (2006-01-14)
[[v0.1.7_ruby]]
=== Ruby
Ruby script plugin has been added but is experimental in this release. You're
warned!
[[v0.1.7_command_away]]
=== Command /away
Command `/away` was changed to be RFC 2812 compliant. Now argument is required
to set away, and no argument means remove away ("back").
Option _irc_default_msg_away_ has been removed.
[[v0.1.6]]
== Version 0.1.6 (2005-11-11)
[[v0.1.6_script_api]]
=== Script API
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).
[[v0.1.6_openbsd]]
=== OpenBSD
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_.
[[v0.1.6_utf8]]
=== UTF-8
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.
[[v0.1.5]]
== Version 0.1.5 (2005-09-24)
No release note.
[[v0.1.4]]
== Version 0.1.4 (2005-07-30)
No release note.
[[v0.1.3]]
== Version 0.1.3 (2005-07-02)
No release note.
[[v0.1.2]]
== Version 0.1.2 (2005-05-21)
No release note.
[[v0.1.1]]
== Version 0.1.1 (2005-03-20)
No release note.
[[v0.1.0]]
== Version 0.1.0 (2005-02-12)
No release note.
[[v0.0.9]]
== Version 0.0.9 (2005-01-01)
No release note.
[[v0.0.8]]
== Version 0.0.8 (2004-10-30)
No release note.
[[v0.0.7]]
== Version 0.0.7 (2004-08-08)
No release note.
[[v0.0.6]]
== Version 0.0.6 (2004-06-05)
No release note.
[[v0.0.5]]
== Version 0.0.5 (2004-02-07)
No release note.
[[v0.0.4]]
== Version 0.0.4 (2004-01-01)
No release note.
[[v0.0.3]]
== Version 0.0.3 (2003-11-03)
No release note.
[[v0.0.2]]
== Version 0.0.2 (2003-10-05)
No release note.
[[v0.0.1]]
== Version 0.0.1 (2003-09-27)
No release note.