]> jfr.im git - irc/weechat/weechat.git/blame - ReleaseNotes.adoc
relay: fix crash when decoding a malformed websocket frame (CVE-2021-40516)
[irc/weechat/weechat.git] / ReleaseNotes.adoc
CommitLineData
5812564b 1= WeeChat Release Notes
ac820639
SH
2:author: Sébastien Helleu
3:email: flashcode@flashtux.org
4:lang: en
7d3d56cc
SH
5:toc: left
6:docinfo1:
6394a3d1
SH
7
8
cecb546c 9This document lists important changes for each version, that require manual
7115f830 10actions (the latest formatted version of this document can be found
0cd2aff7 11https://weechat.org/files/releasenotes/ReleaseNotes-devel.html[here]). +
7115f830 12It is recommended to read it when upgrading to a new stable
6394a3d1
SH
13version.
14
cecb546c 15For a complete list of changes, please look at
0cd2aff7 16https://weechat.org/files/changelog/ChangeLog-devel.html[ChangeLog]
b7bdbbdc 17(file _ChangeLog.adoc_ in sources).
b9a04242 18
2a37b44a 19
6620f40e
SH
20[[v2.3]]
21== Version 2.3 (2018-10-21)
22
23No release note.
24
5f2ed55c 25[[v2.2]]
c47916ac 26== Version 2.2 (2018-07-14)
5f2ed55c 27
24d2413f
SH
28[[v2.2_default_hotlist_conditions]]
29=== Default conditions for hotlist
30
31The default value for option `weechat.look.hotlist_add_conditions` has been
32changed to take care about the number of connected clients on the relay
33with weechat protocol: if at least one client is connected, the buffer is
34always added to the hotlist.
35
36The new value contains three conditions, if one of them is true, the buffer
37is added to the hotlist:
38
39* `${away}`: true if you are away on the server matching the buffer,
40* `${buffer.num_displayed} == 0`: true if the buffer is not displayed in any
41 window
41d5cdd1
SH
42* `${info:relay_client_count,weechat,connected} > 0`: true if at least
43 one client is connected on a weechat relay (new condition).
24d2413f
SH
44
45To use the new default value, you can reset the option with this command:
46
47----
48/unset weechat.look.hotlist_add_conditions
49----
50
51Or set explicitly the value:
52
53----
54/set weechat.look.hotlist_add_conditions "${away} || ${buffer.num_displayed} == 0 || ${info:relay_client_count,weechat,connected} > 0"
55----
56
1587674e
SH
57[[v2.2_default_triggers]]
58=== Default triggers
59
53fedfe4
SH
60The existing triggers "cmd_pass" and "msg_auth" have been updated to hide
61password in command `/msg nickserv set password` and support the option
62`-server xxx`.
1587674e 63
53fedfe4 64You can restore the default triggers with the following command:
1587674e
SH
65
66----
53fedfe4 67/trigger restore cmd_pass msg_auth
1587674e
SH
68----
69
2802457c
SH
70[[v2.2_irc_signals_tags]]
71=== Tags in IRC "in" signals
72
3fc0ce7d
SH
73The IRCv3 tags are now sent in these IRC signals for received messages
74(_xxx_ is IRC server name, _yyy_ is IRC command name):
2802457c 75
3fc0ce7d
SH
76* _xxx,irc_in_yyy_
77* _xxx,irc_in2_yyy_
78* _xxx,irc_raw_in_yyy_
79* _xxx,irc_raw_in2_yyy_
2802457c
SH
80
81This could break plugins or scripts that parse IRC messages and don't expect
82to receive tags (even if tags *are* part of the IRC message, so this was a bug
83in the IRC signals).
84
85See issue #787 for more information.
86
87[NOTE]
88It is recommended for plugins and scripts to use the WeeChat IRC parser:
89see the function "info_get_hashtable" in the Plugin API reference.
90
91Now the whole IRC message is received by the signal callback, for example:
92
93----
94@tag1=abc;tag2=def :nick!user@host PRIVMSG #test :this is a test
95----
96
97In older releases, this message was received:
98
99----
100:nick!user@host PRIVMSG #test :this is a test
101----
102
5f2ed55c
SH
103[[v2.2_debian_headless_package]]
104=== New Debian package for headless version
105
106A new Debian package has been added: _weechat-headless_ which contains the
107binary _weechat-headless_ and its man page.
108
97ad48e3 109In version 2.1, this binary was in the package _weechat-curses_.
5f2ed55c 110
40749afc 111[[v2.1]]
47e38255 112== Version 2.1 (2018-03-18)
40749afc 113
21e63e79
SH
114[[v2.1_script_plugin_check_license]]
115=== Option to check license of scripts loaded
116
117A configuration file has been added for each script plugin: _python.conf_,
118_perl.conf_, _ruby.conf_, ...
119
120Therefore the option to check license of loaded scripts has been moved from
121_plugins.var.<language>.check_license_ (type: string) to the plugin
122configuration file (type: boolean, default is _off_).
123
124List of options moved:
125
126* _plugins.var.python.check_license_ (string) moved to _python.look.check_license_ (boolean)
127* _plugins.var.perl.check_license_ (string) moved to _perl.look.check_license_ (boolean)
128* _plugins.var.ruby.check_license_ (string) moved to _ruby.look.check_license_ (boolean)
129* _plugins.var.lua.check_license_ (string) moved to _lua.look.check_license_ (boolean)
130* _plugins.var.tcl.check_license_ (string) moved to _tcl.look.check_license_ (boolean)
131* _plugins.var.guile.check_license_ (string) moved to _guile.look.check_license_ (boolean)
132* _plugins.var.javascript.check_license_ (string) moved to _javascript.look.check_license_ (boolean)
133* _plugins.var.php.check_license_ (string) moved to _php.look.check_license_ (boolean)
134
ee79e11b
SH
135[[v2.1_option_name_completion]]
136=== Completion for /set and /help commands
40749afc
SH
137
138A new option weechat.completion.partial_completion_templates has been added to
139force partial completion on some templates. By default, the option name
ee79e11b 140completed in `/set` and `/help` commands are now using partial completion.
40749afc
SH
141
142If you prefer old behavior, you can remove the templates from the new option
143with this command:
144
145----
146/set weechat.completion.partial_completion_templates ""
147----
148
149For more information about this feature, you can read help with:
150
151----
152/help weechat.completion.partial_completion_templates
153----
154
6f64cd0c
SH
155[[v2.0.1]]
156== Version 2.0.1 (2017-12-20)
157
158Bug fix and maintenance release.
159
5392e307 160[[v2.0]]
f0a06cc8 161== Version 2.0 (2017-12-03)
5392e307 162
a7522d8e
SH
163[[v2.0_fset_plugin]]
164=== Fset plugin
165
166A new plugin "fset" has been added, it replaces the script iset.pl and has many
167new features.
168
169By default the fset plugin changes the behavior of `/set` command when it is
170used with only an option name: it opens the fset buffer if at least one option
171is found.
172
173The old behavior was to display the list of options in the core buffer.
174
175If you prefer the old behavior, you can restore it with this command:
176
177----
178/set fset.look.condition_catch_set ""
179----
180
181For more information about this feature, you can read help with:
182
183----
184/help fset.look.condition_catch_set
185----
186
b55c1582
SH
187[[v2.0_debian_packaging]]
188=== Split of scripting Debian packages
189
190The Debian packaging has changed (for now only on weechat.org repositories,
191not in Debian official repositories). +
5f2ed55c 192The package _weechat-plugins_ has been split into 9 packages:
b55c1582
SH
193
194- weechat-plugins (with only the following plugins: aspell, exec, fifo, relay,
195 script, trigger)
196- weechat-python
197- weechat-perl
198- weechat-ruby
199- weechat-lua
200- weechat-tcl
201- weechat-guile
202- weechat-javascript
203- weechat-php.
204
205If you are using the packages from weechat.org, you will have to install
206manually the scripting packages (according to the languages you'll use
207in WeeChat), for example Python/Perl only:
208
209----
210sudo apt-get install weechat-python weechat-perl
211----
212
213For development packages:
214
215----
216sudo apt-get install weechat-devel-python weechat-devel-perl
217----
218
8c046d9b
SH
219[[v2.0_buflist_eval]]
220=== Evaluation in buflist
221
222The evaluation of expressions in buflist options is not recursive any more,
223to prevent too many evaluations, for example in buffer variables
224(see issue #1060 for more information). +
225If you are using custom variables/options containing evaluated expressions,
226like `${some.config.option}`, and if this option contains evaluated strings (`${...}`),
227you must evaluate them with: `${eval:${some.config.option}}`.
228
229[NOTE]
230The default buflist formats (`${format_buffer}`, `${format_name}`,
231`${format_hotlist}`, ...) are automatically evaluated in options _buflist.format.buffer_,
232_buflist.format.buffer_current_ and _buflist.format.hotlist_.
233
bfef8da8
SH
234[[v2.0_hook_connect]]
235=== Function hook_connect
236
237In scripts, the arguments _status_, _gnutls_rc_ and _sock_ sent to the callback
238of _hook_connect_ are now integers (they were strings in older releases). +
239To be compatible with all versions, it is recommended to convert the argument
240to integer before using it, for example in Python: `int(sock)`.
241
5392e307
SH
242[[v2.0_hook_fd]]
243=== Function hook_fd
244
71e59b09
SH
245In scripts, the argument _fd_ sent to the callback of _hook_fd_ is now
246an integer (it was a string in older releases). +
5392e307
SH
247To be compatible with all versions, it is recommended to convert the argument
248to integer before using it, for example in Python: `int(fd)`.
249
1876af75
SH
250[[v1.9.1]]
251== Version 1.9.1 (2017-09-23)
252
253Bug fix and maintenance release.
254
1206a7bb
SH
255[[v1.9]]
256== Version 1.9 (2017-06-25)
257
258No release note.
259
b29f18d7 260[[v1.8]]
664cb659 261== Version 1.8 (2017-05-13)
5ba10f41 262[[v1.8_options]]
8c046d9b 263
5ba10f41
SH
264=== Options
265
266The option _script.scripts.url_force_https_ has been removed because now the
267site weechat.org can only be used with HTTPS. +
268Both HTTP and HTTPS protocols are allowed in the option _script.scripts.url_.
1ff9d1f5 269For http://weechat.org/ an automatic redirection to https://weechat.org/ will
5ba10f41
SH
270occur, so you should check that the CA certificates are properly installed
271on your machine.
272
273Aspell option with color for suggestion on a misspelled word has been renamed:
274
275* _aspell.color.suggestions_ has been renamed to _aspell.color.suggestion_
276
a9f6c34f
SH
277[[v1.8_buflist_plugin]]
278=== Buflist plugin
279
280A new plugin called "buflist" has been added, it replaces the script "buffers.pl".
281
282If the script is installed, you will see two sidebars with list of buffers.
283
90a9a1fb
SH
284If you fell in love with buflist and that the script buffers.pl is installed,
285you can uninstall the script and remove its bar with these commands:
a9f6c34f
SH
286
287----
288/script remove buffers.pl
289/bar del buffers
290----
291
90a9a1fb
SH
292If you don't want the list of buffers, you can disable buflist:
293
294----
295/set buflist.look.enabled off
296----
297
298To save extra memory, you can even unload the buflist plugin, remove the bar and
299prevent the plugin from loading on next startup:
300
301----
302/plugin unload buflist
303/bar del buflist
304/set weechat.plugin.autoload "*,!buflist"
305----
306
10917530
SH
307[[v1.7.1]]
308== Version 1.7.1 (2017-04-22)
309
310Bug fix and maintenance release.
311
68d5a89b 312[[v1.7]]
fb1a0231 313== Version 1.7 (2017-01-15)
68d5a89b 314
0cec295a
SH
315[[v1.7_fifo_options]]
316=== FIFO options
317
318A new configuration file "fifo.conf" has been added and the old option
319_plugins.var.fifo.fifo_ has been moved to _fifo.file.enabled_.
320
321A new option _fifo.file.path_ can be used to customize the FIFO pipe
322path/filename.
323
324[[v1.7_default_triggers]]
325=== Default triggers
326
68d5a89b
SH
327A new trigger "cmd_pass_register" has been added to hide only password and not
328email in command `/msg nickserv register password email`. +
329The existing trigger "cmd_pass" has been updated to hide password in all
330commands except `/msg nickserv register`.
331
332You can add the new trigger and restore the other one with the following
333command:
334
335----
336/trigger restore cmd_pass_register cmd_pass
337----
338
20c86db0 339[[v1.6]]
cc0337bb 340== Version 1.6 (2016-10-02)
20c86db0 341
34ccf3fd
SH
342[[v1.6_irc_server_default_msg]]
343=== IRC kick/part/quit default messages
344
345Server options with default messages for kick/part/quit have been renamed:
346
347* options by default for all servers:
348** _irc.server_default.default_msg_kick_ has been renamed to _irc.server_default.msg_kick_
349** _irc.server_default.default_msg_part_ has been renamed to _irc.server_default.msg_part_
350** _irc.server_default.default_msg_quit_ has been renamed to _irc.server_default.msg_quit_
351* options in each server:
352** _irc.server.xxx.default_msg_kick_ has been renamed to _irc.server.xxx.msg_kick_
353** _irc.server.xxx.default_msg_part_ has been renamed to _irc.server.xxx.msg_part_
354** _irc.server.xxx.default_msg_quit_ has been renamed to _irc.server.xxx.msg_quit_
355
a864da7b
SH
356If you changed the value of these options, you must set them again after upgrade.
357
20c86db0 358[[v1.6_api_printf]]
8743a88c 359=== Printf API functions
20c86db0
SH
360
361Some "printf" functions have been removed from C API (there were not in scripting API):
362
363* printf_date
364* printf_tags
365
366The function "printf_date_tags" must now be used instead of these functions
367(the two functions removed were just C macros on function "printf_date_tags"
368with tags set to NULL for "printf_date" and date set to 0 for "printf_tags").
369
951d1410 370[[v1.5]]
c017af8e 371== Version 1.5 (2016-05-01)
7ea2aebc 372
951d1410 373[[v1.5_nick_coloring]]
fabd48cc
SH
374=== Nick coloring moved to core
375
376The nick coloring feature has been moved from irc plugin to core.
377
378Two options have been moved from irc plugin (irc.conf) to core (weechat.conf),
379and you must set new value if you customized them:
380
7d3d56cc
SH
381* _irc.look.nick_color_force_ moved to _weechat.look.nick_color_force_
382* _irc.look.nick_color_hash_ moved to _weechat.look.nick_color_hash_
383* _irc.look.nick_color_stop_chars_ moved to _weechat.look.nick_color_stop_chars_
fabd48cc 384
7d3d56cc 385The default value for option _weechat.look.nick_color_hash_ is now `djb2`
5b629037
SH
386instead of `sum`.
387
fabd48cc
SH
388The following info names (used by API function "info_get") are renamed as well:
389
7d3d56cc
SH
390* _irc_nick_color_ renamed to _nick_color_
391* _irc_nick_color_name_ renamed to _nick_color_name_
fabd48cc
SH
392
393[NOTE]
7d3d56cc 394The old info _irc_nick_color_ and _irc_nick_color_name_ are kept for
fabd48cc
SH
395compatibility (especially scripts) and will be removed in an upcoming release.
396
951d1410 397[[v1.5_callbacks_pointer]]
cf6aca16
SH
398=== Pointer in callbacks
399
400A pointer has been added in all callbacks used by scripts, so the callbacks
7d3d56cc 401will receive an extra _const void *pointer_ before the _void *data_
cf6aca16
SH
402(in the C API only, not scripting API).
403
404This is used to remove linked list of callbacks in scrips (improve speed,
405reduce memory usage).
406
407Following functions are changed in the C API:
408
409* exec_on_files
410* config_new
411* config_new_section
412* config_new_option
413* hook_command
414* hook_command_run
415* hook_timer
416* hook_fd
417* hook_process
418* hook_process_hashtable
419* hook_connect
420* hook_print
421* hook_signal
422* hook_hsignal
423* hook_config
424* hook_completion
425* hook_modifier
426* hook_info
427* hook_info_hashtable
428* hook_infolist
429* hook_hdata
430* hook_focus
d3c21e35 431* unhook_all
cf6aca16
SH
432* buffer_new
433* bar_item_new
434* upgrade_new
435* upgrade_read
436
d3c21e35
SH
437The function `unhook_all` has a new argument `const char *subplugin` to remove
438only hooks created by this "subplugin" (script).
cf6aca16 439
951d1410 440[[v1.5_bar_item_away]]
0e6a6a03
SH
441=== Bar item "away"
442
443The bar item "away" has been moved from irc plugin to core (so that away status
444can be displayed for any plugin, using the buffer local variable "away").
445
446Two options have been moved from irc plugin (irc.conf) to core (weechat.conf):
447
7d3d56cc
SH
448* _irc.look.item_away_message_ moved to _weechat.look.item_away_message_
449* _irc.color.item_away_ moved to _weechat.color.item_away_
0e6a6a03 450
951d1410 451[[v1.5_default_triggers]]
7ea2aebc
SH
452=== Default triggers
453
454The default triggers "cmd_pass" and "msg_auth" have been updated to include
455nickserv commands "recover" and "regain".
456
457You can restore them with the following command:
458
459----
460/trigger restore cmd_pass msg_auth
461----
462
951d1410 463[[v1.4]]
0e3ac938 464== Version 1.4 (2016-01-10)
39e03d45 465
951d1410 466[[v1.4_irc_alternate_nicks]]
39e03d45
SH
467=== IRC alternate nicks
468
7d3d56cc
SH
469The option _irc.network.alternate_nick_ has been moved into servers
470(_irc.server_default.nicks_alternate_ and _irc.server.xxx.nicks_alternate_).
39e03d45
SH
471
472If you disabled this option, you must switch it off again, globally or by
473server.
474
475Globally (default value for all servers):
476
477----
478/set irc.server_default.nicks_alternate off
479----
480
481For a specific server:
482
483----
484/set irc.server.freenode.nicks_alternate off
485----
486
951d1410 487[[v1.3]]
9019d031 488== Version 1.3 (2015-08-16)
07cbc3bd 489
951d1410 490[[v1.3_irc_channels_encoding]]
1f457ca0
SH
491=== IRC channels encoding
492
493If you are using exotic charsets in your channel names (anything different from
494UTF-8, like ISO charset), you should turn on a new option:
495
496----
497/set irc.network.channel_encode on
498----
499
500This will force WeeChat to decode/encode the channel name
501(like WeeChat 1.2 or older did).
502
503See these issues for more information: issue #482, issue #218.
504
505[NOTE]
506It is *highly recommended* to use only UTF-8 in WeeChat (wherever you can),
507because everything is stored as UTF-8 internally.
508
951d1410 509[[v1.3_alias_command]]
7be16826
SH
510=== Alias command
511
512The command `/alias` has been updated to list, add and remove aliases.
513Therefore the command `/unalias` has been removed.
514
515To add an alias, the argument `add` must be used in command `/alias` before the
516name, for example:
517
518----
519/alias add split /window splith
520----
521
522And the alias is removed with this command:
523
524----
525/alias del split
526----
527
951d1410 528[[v1.3_script_path]]
07cbc3bd
SH
529=== Script path
530
7d3d56cc 531The option _script.scripts.dir_ has been renamed to _script.scripts.path_
07cbc3bd
SH
532(and the content is now evaluated, see `/help eval`).
533
a864da7b
SH
534If you changed the value of this option, you must set it again after upgrade.
535
951d1410 536[[v1.2]]
66abd517 537== Version 1.2 (2015-05-10)
b2a68af0
SH
538
539The word chars are now customizable with two options:
540
541* weechat.look.word_chars_highlight
542* weechat.look.word_chars_input
543
544The behavior has changed for command line: now any non-word char is used as
545delimiter for keys to move to previous/next word or delete previous/next word.
546
547You can restore the old behavior (only use spaces as delimiters) with this
548command:
549
550----
551/set weechat.look.word_chars_input "!\u00A0,!\x20,*"
552----
553
951d1410 554[[v1.1.1]]
772d2649
SH
555== Version 1.1.1 (2015-01-25)
556
557Bug fix and maintenance release.
558
951d1410 559[[v1.1]]
eb81c475 560== Version 1.1 (2015-01-11)
b0101155 561
951d1410 562[[v1.1_triggers_regex_format]]
3f5a8102
SH
563=== New format for regex replacement in triggers
564
565A new format is used in regex replacement to use regex groups, this format
566is incompatible with version 1.0.
567
568The existing triggers are *NOT automatically updated*.
569
670e4d7e 570[width="60%",cols="2,2,3",options="header"]
3f5a8102
SH
571|===
572| Old format | New format | Examples (new format)
573| `$0` ... `$99` | `${re:0}` ... `${re:99}` | `${re:1}`
574| `$+` | `${re:+}` | `${re:+}`
575| `$.*N` | `${hide:*,${re:N}}` | `${hide:*,${re:2}}` +
576 `${hide:-,${re:+}}`
577|===
578
579Moreover, default triggers used to hide passwords have been fixed for *BSD
580operating systems.
581
582You can restore them with the following command:
583
584----
585/trigger restore cmd_pass msg_auth server_pass
586----
587
588If you added triggers with the old regex replacement format, you must update
589them manually.
590
951d1410 591[[v1.1_trigger_beep]]
3f5a8102
SH
592=== Default "beep" trigger
593
594The command of "beep" trigger is now executed only if the message is displayed
595(not filtered with /filter).
596
597You can restore the default "beep" trigger with the following command:
598
599----
600/trigger restore beep
601----
602
951d1410 603[[v1.1_commands_return_code]]
1ef3237b
SH
604=== Return code of commands
605
7d3d56cc 606The API function _weechat_command_ now sends the value returned return by
1ef3237b
SH
607command callback.
608
609WeeChat does not display any more an error when a command returns
7d3d56cc
SH
610_WEECHAT_RC_ERROR_. Consequently, all plugins/scripts should display an
611explicit error message before returning _WEECHAT_RC_ERROR_.
1ef3237b
SH
612
613For C plugins, two macros have been added in weechat-plugin.h:
7d3d56cc 614_WEECHAT_COMMAND_MIN_ARGS_ and _WEECHAT_COMMAND_ERROR_.
1ef3237b 615
951d1410 616[[v1.1_inline_commands_completion]]
af0397fb
SH
617=== Completion of inline commands
618
619WeeChat now completes by default inline commands (not only at beginning of
620line).
621
622When this feature is enabled, there is no more automatic completion of
623absolute paths (except if you are completing a path inside a command argument,
624like `/dcc send <nick> <path>`).
625
626To restore the old behavior (no completion of inline commands):
627
628----
629/set weechat.completion.command_inline off
630----
631
951d1410 632[[v1.1_relay_irc_backlog_tags]]
1bda9f10
SH
633=== Relay option relay.irc.backlog_tags
634
7d3d56cc 635The option _relay.irc.backlog_tags_ is now a list separated by commas
1bda9f10
SH
636(it was separated by semicolons in older versions).
637
638If you are using a list of tags in this option, you must adjust the value
639manually.
640
951d1410 641[[v1.1_relay_ipv6_ipv4]]
f48dd3bb
SH
642=== IPv4-mapped IPv6 client address in relay
643
644The string "::ffff:" has been removed from IPv4-mapped IPv6 client address
645in relay plugin.
646
7d3d56cc 647If you are using "::ffff:" in option _relay.network.allowed_ips_, you can
f48dd3bb
SH
648remove it.
649
951d1410 650[[v1.1_irc_temporary_servers]]
761ac5d0
SH
651=== Temporary servers disabled by default with /connect
652
7d3d56cc
SH
653Creating a temporary server with command `+/connect <address>+` or
654`+/connect irc://...+` is now forbidden by default.
761ac5d0
SH
655
656A new option has been added to unlock the feature, you can do that for
657the old behavior in command `/connect`:
658
659----
660/set irc.look.temporary_servers on
661----
662
951d1410 663[[v1.1_timeval_microseconds]]
7b546bea
SH
664=== Microseconds in API timeval functions
665
666The API functions using timeval are now using or returning microseconds,
667instead of milliseconds:
668
7d3d56cc
SH
669* function _util_timeval_diff_: returns microseconds
670* function _util_timeval_add_: the argument _interval_ is now expressed in
7b546bea
SH
671 microseconds.
672
951d1410 673[[v1.0.1]]
9aee60bd
SH
674== Version 1.0.1 (2014-09-28)
675
676Bug fix and maintenance release.
677
951d1410 678[[v1.0]]
addc27af 679== Version 1.0 (2014-08-15)
39be4e33 680
951d1410 681[[v1.0_irc_channel_type]]
37ad9e36
SH
682=== Channel type not added by default on /join
683
684The channel type is not any more automatically added to a channel name on join
685(for example `/join weechat` will not send `/join #weechat`).
686
687If you are lazy and want to automatically add the channel type, you can turn on
688the new option:
689
690----
691/set irc.look.join_auto_add_chantype on
692----
693
951d1410 694[[v1.0_irc_channel_modes_arguments]]
de4ce8ee
SH
695=== Hide IRC channel modes arguments
696
7d3d56cc
SH
697The option _irc.look.item_channel_modes_hide_key_ has been renamed to
698_irc.look.item_channel_modes_hide_args_ and is now a string. +
de4ce8ee
SH
699It can now hide arguments for multiple channel modes.
700
701By default, a channel key (mode "k") will hide channel arguments. For old
702behavior (never hide arguments, even with a channel key), you can do:
703
704----
705/set irc.look.item_channel_modes_hide_args ""
706----
707
951d1410 708[[v1.0_jump_first_last_buffer]]
bc96d2f1
SH
709=== Jump to first/last buffer
710
711The command `/input jump_last_buffer` has been replaced by `/buffer +`.
7d3d56cc 712You can rebind the key kbd:[Alt+j], kbd:[Alt+l]:
bc96d2f1
SH
713
714----
715/key bind meta-jmeta-l /buffer +
716----
717
718[NOTE]
719The command `/input jump_last_buffer` still works for compatibility reasons,
720but it should not be used any more.
721
7d3d56cc 722Similarly, a new key has been added to jump to first buffer: kbd:[Alt+j], kbd:[Alt+f].
bc96d2f1
SH
723You can add it with following command:
724
725----
726/key missing
727----
728
951d1410 729[[v1.0_hotlist_conditions]]
dc236510
SH
730=== Hotlist conditions
731
7d3d56cc
SH
732A new option _weechat.look.hotlist_add_conditions_ has been added. This option
733replaces the option _weechat.look.hotlist_add_buffer_if_away_, which has been
dc236510
SH
734removed.
735
736Default conditions are `${away} || ${buffer.num_displayed} == 0`, which means
737that a buffer is added in hotlist if you are away ("away" local variable is
738set), or if the buffer is not visible on screen (not displayed in any window).
739
7d3d56cc 740If you have set _weechat.look.hotlist_add_buffer_if_away_ to `off` (to not add
dc236510
SH
741current buffer in hotlist when you are away), then you must manually change the
742default conditions with the following command:
743
744----
745/set weechat.look.hotlist_add_conditions "${buffer.num_displayed} == 0"
746----
747
951d1410 748[[v1.0_trigger_plugin]]
3c398bd6
SH
749=== Rmodifier replaced by Trigger plugin
750
751The trigger plugin replaces the rmodifier plugin, which has been removed
752(and trigger has much more features than rmodifier).
753
754Default triggers have same features as default rmodifiers (to hide passwords
755in commands and output).
756
757If you added some custom rmodifiers, you must create similar triggers, see
7d3d56cc 758`/help trigger` and the complete trigger doc in the _WeeChat User's guide_.
3c398bd6 759
c5583b06 760[NOTE]
7d3d56cc 761If on startup you have an error about API mismatch in plugin _rmodifier.so_,
c5583b06
SH
762you can manually remove the file (the command `make install` does not remove
763obsolete plugins).
764
951d1410 765[[v1.0_bare_display]]
39be4e33
SH
766=== Bare display
767
768A bare display mode has been added (for easy text selection and click on URLs),
7d3d56cc 769the new default key is kbd:[Alt+l].
39be4e33
SH
770
771Use command `/key missing` to add the key or `/key listdiff` to see differences
772between your current keys and WeeChat default keys.
773
d4254f21 774[[v1.0_hook_print]]
71e59b09
SH
775=== Function hook_print
776
777In scripts, the arguments _displayed_ and _highlight_ sent to the callback of
778_hook_print_ are now integers (they were strings in older releases). +
779To be compatible with all versions, it is recommended to convert the argument
780to integer before testing it, for example in Python: `if int(highlight):`.
781
951d1410 782[[v0.4.3]]
f25dd0c8 783== Version 0.4.3 (2014-02-09)
9b4eb6d6 784
951d1410 785[[v0.4.3_colors_messages]]
d3799b46
SH
786=== Colors in messages
787
d0832cd5
SH
788The color code for "reverse video" in IRC message has been fixed: now WeeChat
789uses 0x16 like other clients (and not 0x12 any more). +
d3799b46
SH
790The code 0x12 is not decoded any more, so if it is received (for example from
791an old WeeChat version), it is not displayed as reverse video.
792
d0832cd5
SH
793The color code for "underlined text" in input line has been fixed: now WeeChat
794uses 0x1F, the same code sent to IRC server.
795
796The default keys for "reverse video" and "underlined text" have changed:
797
7d3d56cc
SH
798* reverse video: key kbd:[Ctrl+c], kbd:[r] is replaced by kbd:[Ctrl+c], kbd:[v]
799* underlined text: key kbd:[Ctrl+c], kbd:[u] is replaced by kbd:[Ctrl+c], kbd:[_]
d3799b46 800
d0832cd5 801You can remove the old keys and add the new ones with these commands:
d3799b46
SH
802
803----
804/key unbind ctrl-Cr
d0832cd5 805/key unbind ctrl-Cu
d3799b46
SH
806/key missing
807----
808
951d1410 809[[v0.4.3_terminal_title]]
90774b73
SH
810=== Terminal title
811
7d3d56cc
SH
812The boolean option _weechat.look.set_title_ has been renamed to
813_weechat.look.window_title_ and is now a string.
90774b73
SH
814
815The content is evaluated and the default value is `WeeChat ${info:version}`.
816
817[NOTE]
818Only static content should be used in this option, because the title is
819refreshed only when the option is changed.
820
951d1410 821[[v0.4.3_bar_item_buffer_last_number]]
1d81645c
SH
822=== New bar item buffer_last_number
823
7d3d56cc 824The bar item _buffer_count_ now displays the number of opened buffers (each
1d81645c
SH
825merged buffer counts 1).
826
7d3d56cc 827The new bar item _buffer_last_number_ displays the highest buffer number
1d81645c
SH
828currently used.
829
7d3d56cc
SH
830If you want to display last number in the status bar, replace _buffer_count_
831by _buffer_last_number_ in your option _weechat.bar.status.items_.
1d81645c 832
951d1410 833[[v0.4.3_bar_item_buffer_zoom]]
9b4eb6d6
SH
834=== New bar item buffer_zoom
835
7d3d56cc 836A new bar item has been added: _buffer_zoom_.
9b4eb6d6
SH
837The default value for status bar items becomes:
838
839----
840/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"
841----
842
951d1410 843[[v0.4.3_irc_messages_channel_join]]
f285fdaf
SH
844=== IRC messages on channel join
845
846The names are not displayed any more by default on channel join (they are in
847nicklist anyway).
848
849Names can be displayed with the value "353" in option
7d3d56cc 850_irc.look.display_join_message_ (which is not in default value). +
f285fdaf
SH
851The value "366" shows only names count on channel.
852
853If you want to display all messages on join (including names), you can do:
854
855----
537f5617 856/set irc.look.display_join_message "329,332,333,353,366"
f285fdaf
SH
857----
858
951d1410 859[[v0.4.3_irc_maximum_lag]]
4f184b61
SH
860=== Maximum lag in IRC
861
7d3d56cc 862Option _irc.network.lag_max_ has been added.
4f184b61 863
7d3d56cc
SH
864The value of option _irc.network.lag_reconnect_ (if set to non-zero value) must
865be less than or equal to _irc.network.lag_max_, otherwise the reconnection will
4f184b61
SH
866never occur.
867
868You should check the value of both options and fix them if needed.
869
951d1410 870[[v0.4.2]]
5812564b 871== Version 0.4.2 (2013-10-06)
f7f01988 872
951d1410 873[[v0.4.2_day_change_message]]
5812564b 874=== Day change message
03b6b4c1
SH
875
876The day change message is now dynamically displayed, and therefore is not stored
877as a line in buffer any more.
878
7d3d56cc
SH
879Option _weechat.look.day_change_time_format_ has been split into two options
880_weechat.look.day_change_message_{1date|2dates}_ (color codes are allowed in
9c36b7c6 881these options, see `/help eval`).
03b6b4c1 882
7d3d56cc 883New color option _weechat.color.chat_day_change_ has been added.
03b6b4c1
SH
884
885After `/upgrade` from an old version, you will see two messages for each day
886change. This is a normal behavior and will not happen again with the next day
887changes.
888
951d1410 889[[v0.4.2_buffer_regex_search]]
5812564b 890=== Regex search in buffer
600ee3dd
SH
891
892Search with regular expression has been added, and therefore some keys in search
893context have been changed.
894
7d3d56cc 895The key kbd:[Ctrl+r] in search context is now used to switch string/regex search
600ee3dd
SH
896(instead of searching exact text).
897
898If you never changed keys in search context, you can reset them all with one
899command:
900
5812564b 901----
600ee3dd 902/key resetall -yes search
5812564b 903----
600ee3dd
SH
904
905Or the manual method:
906
5812564b 907----
600ee3dd
SH
908/key missing search
909/key bindctxt search ctrl-R /input search_switch_regex
5812564b 910----
600ee3dd
SH
911
912To view keys in search context:
913
5812564b 914----
600ee3dd 915/key list search
5812564b 916----
600ee3dd 917
7d3d56cc 918For more information, see the chapter about keys in the _WeeChat User's guide_.
600ee3dd 919
951d1410 920[[v0.4.2_rmodifier]]
5812564b 921=== New rmodifier
f0cd7a99
SH
922
923A new rmodifier "secure" has been added to hide passphrase and passwords
7d3d56cc 924displayed by command `/secure`. Use command `/rmodifier missing` to add it.
f0cd7a99 925
951d1410 926[[v0.4.2_color_codes_options]]
5812564b 927=== Color codes in options
8ca36552
SH
928
929The format for color codes in some options has changed. The options are
930evaluated with the function "string_eval_expression", which uses the format
931`${color:xxx}`.
932
933Following options are affected:
934
7d3d56cc
SH
935* _weechat.look.buffer_time_format_
936* _weechat.look.prefix_action_
937* _weechat.look.prefix_error_
938* _weechat.look.prefix_join_
939* _weechat.look.prefix_network_
940* _weechat.look.prefix_quit_
8ca36552
SH
941
942The options using old format `${xxx}` must be changed with new format
943`${color:xxx}` (where xxx is a color name or number, with optional color
944attributes).
945
946Example:
947
5812564b 948----
8ca36552 949/set weechat.look.buffer_time_format "${color:251}%H${color:243}%M${color:238}%S"
5812564b 950----
8ca36552 951
951d1410 952[[v0.4.2_binary_man_page]]
5812564b 953=== Binary and man page
996da2f6
SH
954
955WeeChat binary and man page have been renamed from `weechat-curses` to
956`weechat`.
957
958A symbolic link has been added for binary: `weechat-curses` -> `weechat`
959(so that the /upgrade from a old version will still work).
960
961If you upgrade from an old version, it is recommended to force the use of the
962new binary name with the command: `/upgrade /path/to/weechat` (replace the path
963accordingly).
964
965[NOTE]
966For packagers: you should create the link `weechat-curses` -> `weechat` if it's
967not automatically created in the package (both cmake and configure are creating
968this link on make install).
969
951d1410 970[[v0.4.2_man_page_documentation]]
5812564b 971=== Man page / documentation
261efe62
SH
972
973Documentation is not built by default any more, you have to use option
974`-DENABLE_DOC=ON` in cmake to enable it.
975
976The man page is now built with asciidoc and translated in several
977languages. A new cmake option `ENABLE_MAN` has been added to compile man page
3aed4ac1 978(`OFF` by default).
261efe62 979
951d1410 980[[v0.4.2_aspell_colors]]
5812564b 981=== Aspell colors
f7f01988 982
7d3d56cc 983Option _aspell.look.color_ has been renamed to _aspell.color.misspelled_.
f7f01988 984
a864da7b
SH
985If you changed the value of this option, you must set it again after upgrade.
986
951d1410 987[[v0.4.1]]
5812564b 988== Version 0.4.1 (2013-05-20)
ff15c0a4 989
951d1410 990[[v0.4.1_relay_nicklist_diff]]
5812564b 991=== Nicklist diff in relay
00f3fbdf
SH
992
993A new message with identifier "_nicklist_diff" has been added in relay (WeeChat
3450bf7c
SH
994protocol). WeeChat may decide to send full nicklist or this nicklist diff at
995any time (depending on size of message, the smaller is sent).
00f3fbdf
SH
996
997Clients using nicklist must implement it.
998
7d3d56cc 999For more info about content of message, see document _WeeChat Relay Protocol_.
00f3fbdf 1000
951d1410 1001[[v0.4.1_dynamic_nick_prefix_suffix]]
5812564b 1002=== Dynamic nick prefix/suffix
16cc0b60
SH
1003
1004The nick prefix/suffix (for example: "<" and ">") are now dynamic and used on
1005display (not stored any more in the line).
1006
1007Options moved from irc plugin (irc.conf) to core (weechat.conf):
1008
7d3d56cc
SH
1009* _irc.look.nick_prefix_ moved to _weechat.look.nick_prefix_
1010* _irc.look.nick_suffix_ moved to _weechat.look.nick_suffix_
1011* _irc.color.nick_prefix_ moved to _weechat.color.chat_nick_prefix_
1012* _irc.color.nick_suffix_ moved to _weechat.color.chat_nick_suffix_
16cc0b60
SH
1013
1014Types and default values for these four options remain unchanged.
1015
0a7b708a
SH
1016Two new options to customize the truncature char (by default "`+`"):
1017
7d3d56cc
SH
1018* _weechat.look.prefix_align_more_after_ (boolean, _on_ by default)
1019* _weechat.look.prefix_buffer_align_more_after_ (boolean, _on_ by default)
0a7b708a
SH
1020
1021When these options are enabled (default), the "`+`" is displayed after the
1022text, replacing the space that should be displayed there. +
1023When turned off, the "`+`" will replace last char of text.
1024
1025Example for a nicks "FlashCode" and "fc" with different values for options
7d3d56cc
SH
1026_weechat.look.prefix_align_max_, _weechat.look.prefix_align_more_after_,
1027_weechat.look.nick_prefix_ and _weechat.look.nick_suffix_:
0a7b708a 1028
5812564b 1029----
0a7b708a
SH
1030 # align_max, more_after, prefix/suffix
1031
1032FlashCode │ test # 0, on
1033 fc │ test
1034
1035FlashCod+│ test # 8, on
1036 fc │ test
1037
1038FlashCo+ │ test # 8, off
1039 fc │ test
1040
1041<FlashCode> │ test # 0, on, < >
1042 <fc> │ test
1043
1044<FlashC>+│ test # 8, on, < >
1045 <fc> │ test
1046
1047<Flash+> │ test # 8, off, < >
1048 <fc> │ test
5812564b 1049----
0a7b708a 1050
16cc0b60
SH
1051After `/upgrade`, if you set new options to non-empty strings, and if old
1052options were set to non-empty strings too, you will see double prefix/suffix
2dff60d7 1053on old messages, this is normal behavior (lines displayed before `/upgrade`
16cc0b60
SH
1054have prefix/suffix saved in prefix, but new lines don't have them any more).
1055
1056New options in logger plugin (logger.conf):
1057
7d3d56cc 1058* _logger.file.nick_prefix_: prefix for nicks in log files (default: empty
16cc0b60 1059 string)
7d3d56cc 1060* _logger.file.nick_suffix_: suffix for nicks in log files (default: empty
16cc0b60
SH
1061 string)
1062
951d1410 1063[[v0.4.1_irc_reconnection_lag]]
5812564b 1064=== IRC reconnection on important lag
7cf9c8a6 1065
7d3d56cc
SH
1066Option _irc.network.lag_disconnect_ has been renamed to
1067_irc.network.lag_reconnect_ and value is now a number of seconds (instead of
d654fca8 1068minutes).
7cf9c8a6 1069
a864da7b
SH
1070If you changed the value of this option, you must set it again after upgrade.
1071
951d1410 1072[[v0.4.1_irc_passwords_hidden]]
5812564b 1073=== IRC passwords hidden
9beb263e
SH
1074
1075IRC plugin is now using modifiers "irc_command_auth" and "irc_message_auth" to
1076hide passwords.
1077
7d3d56cc
SH
1078The option _irc.look.hide_nickserv_pwd_ has been removed, and a new option
1079_irc.look.nicks_hide_password_ has been added (by default passwords are hidden
9beb263e
SH
1080only for "nickserv").
1081
1082A new rmodifier "message_auth" has been added to hide passwords displayed by
7d3d56cc 1083command `/msg nickserv identify|register|ghost|release` and the rmodifier
9beb263e
SH
1084"nickserv" has been renamed to "command_auth".
1085
1086If you never added/changed rmodifiers, you can just reset all rmodifiers:
1087
5812564b 1088----
9beb263e 1089/rmodifier default -yes
5812564b 1090----
9beb263e
SH
1091
1092If you added/changed some rmodifiers, do it manually with these commands:
1093
5812564b 1094----
9beb263e
SH
1095/rmodifier del nickserv
1096/rmodifier add command_auth history_add,input_text_display,irc_command_auth 1,4* ^(/(msg|quote) +nickserv +(id|identify|register|ghost \S+|release \S+) +)(.*)
1097/rmodifier add message_auth irc_message_auth 1,3* ^(.*(id|identify|register|ghost \S+|release \S+) +)(.*)
5812564b 1098----
9beb263e 1099
951d1410 1100[[v0.4.1_lua_constants]]
5812564b 1101=== Lua constants
2ffa199a
SH
1102
1103For consistency with other supported languages, the API constants in Lua have
1104been redefined as constants instead of functions.
1105
1106Therefore, the use of a constant must be changed: the parentheses must be
1107removed.
1108
1109The old syntax was:
1110
1111[source,lua]
5812564b 1112----
2ffa199a 1113return weechat.WEECHAT_RC_OK()
5812564b 1114----
2ffa199a
SH
1115
1116The new syntax is:
1117
1118[source,lua]
5812564b 1119----
2ffa199a 1120return weechat.WEECHAT_RC_OK
5812564b 1121----
2ffa199a 1122
951d1410 1123[[v0.4.1_guile_callbacks]]
5812564b 1124=== Guile callbacks
9857b44e 1125
6394a3d1
SH
1126The way to give arguments for guile callbacks has been fixed: now arguments are
1127sent individually (instead of a list with all arguments inside).
1128
1129Therefore, existing guile scripts must be modified accordingly. Moreover,
1130WeeChat now requires Guile ≥ 2.0 to compile.
9857b44e 1131
951d1410 1132[[v0.4.0]]
5812564b 1133== Version 0.4.0 (2013-01-20)
e0959486 1134
951d1410 1135[[v0.4.0_bars_conditions]]
5812564b 1136=== Conditions in bars
6394a3d1
SH
1137
1138Conditions in bars have changed, and now an expression is evaluated.
1139
1140If you have a value with many conditions in a bar, like: `nicklist,active`, you
1141must now use an expression like: `${nicklist} && ${active}` (see the chapter
7d3d56cc 1142about bars in the _WeeChat User's guide_).
6394a3d1 1143
951d1410 1144[[v0.4.0_ipv6_default]]
5812564b 1145=== IPv6 by default
6394a3d1 1146
5812564b 1147==== IRC
6394a3d1
SH
1148
1149IPv6 is now used by default to connect to IRC servers, with fallback to
7d3d56cc 1150IPv4. The option _irc.server_default.ipv6_ is now "on" by default. If IPv6 is
3450bf7c
SH
1151not enabled or fails, IPv4 will be used. The "ipv6" option in server is now
1152used to disable IPv6 and force IPv4 (if option is turned "off").
6394a3d1 1153
5812564b 1154==== Relay
6394a3d1
SH
1155
1156Relay plugin is now listening by default on an IPv6 socket (new option
7d3d56cc 1157_relay.network.ipv6_, on by default), so connections with IPv4 will have
6394a3d1 1158IPv4-mapped IPv6 addresses, like: "::ffff:127.0.0.1" (for "127.0.0.1"); check
7d3d56cc 1159that value of option _relay.network.allowed_ips_ supports this mapping, or
9beb263e 1160disable IPv6 in relay if you don't plan to use it at all:
6394a3d1 1161
5812564b 1162----
6394a3d1 1163/set relay.network.ipv6 off
5812564b 1164----
e0959486 1165
951d1410 1166[[v0.3.9.2]]
5812564b 1167== Version 0.3.9.2 (2012-11-18)
57293ffc 1168
3450bf7c
SH
1169This version fixes a security vulnerability when a plugin/script gives
1170untrusted command to API function "hook_process".
57293ffc 1171
951d1410 1172[[v0.3.9.1]]
5812564b 1173== Version 0.3.9.1 (2012-11-09)
7cd376b4
SH
1174
1175This version fixes crash when decoding IRC colors in strings.
1176
951d1410 1177[[v0.3.9]]
5812564b 1178== Version 0.3.9 (2012-09-29)
9076f359 1179
951d1410 1180[[v0.3.9_options_moved]]
5812564b 1181=== Options moved
9c8b06de 1182
6394a3d1
SH
1183Options moved from core (weechat.conf) to irc plugin (irc.conf):
1184
7d3d56cc 1185* _weechat.look.nickmode_ moved to _irc.look.nick_mode_ (new type: integer
50730484 1186 with values: none/prefix/action/both)
7d3d56cc 1187* _weechat.look.nickmode_empty_ moved to _irc.look.nick_mode_empty_
6394a3d1 1188
951d1410 1189[[v0.3.9_bar_item_buffer_modes]]
5812564b 1190=== New bar item buffer_modes
6394a3d1 1191
7d3d56cc
SH
1192A new bar item has been added: _buffer_modes_ and irc option
1193_irc.look.item_channel_modes_ has been removed; to display irc channel modes in
6394a3d1 1194status bar (after channel name), you have to manually add the new item
7d3d56cc 1195_buffer_modes_ (this is now used by default in status bar items), default value
6394a3d1
SH
1196for status bar items becomes:
1197
5812564b 1198----
6394a3d1 1199/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"
5812564b 1200----
6394a3d1 1201
951d1410 1202[[v0.3.9_command_aspell]]
5812564b 1203=== Command /aspell
6394a3d1
SH
1204
1205New options in command `/aspell`:
1206
1207* `enable`: enable aspell
1208* `disable`: disable aspell
7d3d56cc 1209* `toggle`: toggle aspell (new default key: kbd:[Alt+s])
6394a3d1
SH
1210
1211Options renamed in command `/aspell`:
1212
1213* `enable` renamed to `setdict` (set dictionary for current buffer)
1214* `disable` renamed to `deldict` (delete dictionary used on current buffer)
1215* `dictlist` renamed to `listdict` (show installed dictionaries)
1216
951d1410 1217[[v0.3.9_horizontal_separator]]
5812564b 1218=== Horizontal separator
6394a3d1
SH
1219
1220An horizontal separator has been added between split windows, and two options
1221have been added to toggle separators (both are enabled by default):
1222
7d3d56cc
SH
1223* _weechat.look.window_separator_horizontal_
1224* _weechat.look.window_separator_vertical_
6394a3d1 1225
951d1410 1226[[v0.3.9_new_keys]]
5812564b 1227=== New keys
6394a3d1
SH
1228
1229New keys were added, use command `/key missing` to add them or `/key listdiff`
1230to see differences between your current keys and WeeChat default keys.
9076f359 1231
951d1410 1232[[v0.3.8]]
5812564b 1233== Version 0.3.8 (2012-06-03)
ca643c6f 1234
951d1410 1235[[v0.3.8_options]]
5812564b 1236=== Options
6394a3d1 1237
7d3d56cc
SH
1238Options _weechat.look.prefix_align_more_ and
1239_weechat.look.prefix_buffer_align_more_ have been converted from type boolean
3450bf7c 1240to string:
6394a3d1 1241
fa845c2e
SH
1242* If the value was on (default), new value is "+" and you can now customize
1243 this char.
1244* If the value was off, you have to set " " (string with one space).
6394a3d1 1245
951d1410 1246[[v0.3.8_paste_detection]]
5812564b 1247=== Paste detection
6394a3d1 1248
7d3d56cc 1249Option _weechat.look.paste_max_lines_ can now be used with value 0 to detect
6394a3d1 1250paste with one line (only if terminal "bracketed paste mode" is enabled when
7d3d56cc
SH
1251option _weechat.look.paste_bracketed_ is on); so now the value -1 is used to
1252disable paste detection: if your value was 0, you should set it to -1:
6394a3d1 1253
5812564b 1254----
6394a3d1 1255/set weechat.look.paste_max_lines -1
5812564b 1256----
6394a3d1 1257
951d1410 1258[[v0.3.8_rmodifier]]
5812564b 1259=== Rmodifier
6394a3d1 1260
3450bf7c 1261Rmodifier "nickserv" has a new default regex which includes option "release"
7d3d56cc 1262for command `/msg nickserv`.
9beb263e
SH
1263
1264If you never added/changed rmodifiers, you can just reset all rmodifiers:
1265
5812564b 1266----
9beb263e 1267/rmodifier default -yes
5812564b 1268----
6394a3d1 1269
9beb263e 1270If you added/changed some rmodifiers, do it manually with these commands:
6394a3d1 1271
5812564b 1272----
6394a3d1
SH
1273/rmodifier del nickserv
1274/rmodifier add nickserv history_add,input_text_display 1,4* ^(/(msg|quote) +nickserv +(id|identify|ghost \S+|release \S+) +)(.*)
5812564b 1275----
ca643c6f 1276
951d1410 1277[[v0.3.7]]
5812564b 1278== Version 0.3.7 (2012-02-26)
60e88df4 1279
951d1410 1280[[v0.3.7_options]]
5812564b 1281=== Options
6394a3d1
SH
1282
1283Option `scroll_unread` has been moved from command `/input` to `/window`,
7d3d56cc 1284therefore default command of key kbd:[Alt+u] has been updated. To bind key with
03fa2448 1285new default value:
6394a3d1 1286
5812564b 1287----
6394a3d1 1288/key bind meta-u /window scroll_unread
5812564b 1289----
6394a3d1 1290
7d3d56cc
SH
1291Option _weechat.history.max_lines_ has been renamed to
1292_weechat.history.max_buffer_lines_number_.
6394a3d1 1293
a864da7b
SH
1294If you changed the value of this option, you must set it again after upgrade.
1295
7d3d56cc 1296Option _weechat.plugin.extension_ now supports list of extensions, and new
6394a3d1
SH
1297default value is ".so,.dll" (with this value, weechat.conf is compatible with
1298Cygwin).
1299
951d1410 1300[[v0.3.7_extended_regex]]
5812564b 1301=== Extended regex
6394a3d1
SH
1302
1303Extended regex is used in filters and irc ignore, so some chars that needed
1304escape in past do not need any more (for example `[0-9]\+` becomes `[0-9]+`),
1305filters and ignore have to be manually fixed.
1306
7d3d56cc 1307Option _weechat.look.highlight_regex_ becomes case insensitive by default, to
6394a3d1
SH
1308make it case sensitive, use "(?-i)" at beginning of string, for example:
1309"(?-i)FlashCode|flashy".
60e88df4 1310
951d1410 1311[[v0.3.6]]
5812564b 1312== Version 0.3.6 (2011-10-22)
4a16de55 1313
951d1410 1314[[v0.3.6_options]]
5812564b 1315=== Options
0f5b4dbe 1316
7d3d56cc
SH
1317Option _weechat.look.hline_char_ has been renamed to
1318_weechat.look.separator_horizontal_.
6394a3d1 1319
a864da7b
SH
1320If you changed the value of this option, you must set it again after upgrade.
1321
951d1410 1322[[v0.3.6_colors_bold]]
5812564b 1323=== Bold in colors
6394a3d1
SH
1324
1325Bold is not used any more for basic colors (used only if terminal has less than
132616 colors), a new option has been added to force bold if needed:
7d3d56cc 1327_weechat.look.color_basic_force_bold_.
4a16de55 1328
951d1410 1329[[v0.3.5]]
5812564b 1330== Version 0.3.5 (2011-05-15)
030755d3 1331
951d1410 1332[[v0.3.5_colors]]
5812564b 1333=== Colors
6394a3d1
SH
1334
1335If you have some colors defined in section "palette" with version 0.3.4, you
1336should remove all colors defined, and add new aliases (it's not needed any more
1337to add colors before using them).
1338
3450bf7c 1339Colors for nick prefixes (char for op, voice, ..) are defined in a single
7d3d56cc
SH
1340option _irc.color.nick_prefixes_, therefore following options will be lost:
1341_irc.color.nick_prefix_op_, _irc.color.nick_prefix_halfop_,
1342_irc.color.nick_prefix_voice_, _irc.color.nick_prefix_user_.
6394a3d1 1343
951d1410 1344[[v0.3.5_hotlist]]
5812564b 1345=== Hotlist
6394a3d1 1346
951d1410 1347[[v0.3.5_hotlist_counters]]
5812564b 1348==== Counters
6394a3d1
SH
1349
1350Count of messages have been added to hotlist by default, if you want to come
1351back to old behavior, do that:
1352
5812564b 1353----
6394a3d1
SH
1354/set weechat.look.hotlist_count_max 0
1355/set weechat.look.hotlist_buffer_separator ","
5812564b 1356----
6394a3d1 1357
951d1410 1358[[v0.3.5_hotlist_away_current_buffer]]
5812564b 1359==== Away and current buffer
6394a3d1 1360
3450bf7c
SH
1361When you are away, all buffers are now added to hotlist by default (even if
1362they are displayed in a window), if you want to come back to old behavior, do
1363that:
6394a3d1 1364
5812564b 1365----
6394a3d1 1366/set weechat.look.hotlist_add_buffer_if_away off
5812564b 1367----
6394a3d1 1368
951d1410 1369[[v0.3.5_new_keys]]
5812564b 1370=== New keys
6394a3d1
SH
1371
1372New keys were added, use command `/key missing` to add them or `/key listdiff`
1373to see differences between your current keys and WeeChat default keys.
030755d3 1374
951d1410 1375[[v0.3.4]]
5812564b 1376== Version 0.3.4 (2011-01-16)
6f063c95 1377
951d1410 1378[[v0.3.4_after_upgrade]]
5812564b 1379=== After /upgrade
6394a3d1
SH
1380
1381If you are using `/upgrade` from a previous release:
1382
fa845c2e
SH
1383* Some nick prefixes can be wrong, so it is recommended to do `/allchan names`.
1384* Nick colors are defined with a new option _weechat.color.chat_nick_colors_,
7d3d56cc 1385 therefore old options _weechat.color.chat_nick_color1..10_ will be lost when
fa845c2e
SH
1386 upgrading.
1387* Nick colors in messages displayed will be wrong if you changed some nick
1388 colors (old default colors will be used).
6394a3d1 1389
951d1410 1390[[v0.3.4_options]]
5812564b 1391=== Options
6394a3d1
SH
1392
1393Some IRC options have been renamed, before upgrading to this version, note
1394value for old options, and set them again with new name:
1395
7d3d56cc 1396* options moved from _network_ section to servers (with global value, and
3450bf7c 1397 server value, like other server options):
7d3d56cc
SH
1398** _irc.network.connection_timeout_ moved to
1399 _irc.server_default.connection_timeout_
1400** _irc.network.anti_flood_prio_high_ moved to
1401 _irc.server_default.anti_flood_prio_high_
1402** _irc.network.anti_flood_prio_low_ moved to
1403 _irc.server_default.anti_flood_prio_low_
1404** _irc.network.away_check_ moved to _irc.server_default.away_check_
1405** _irc.network.away_check_max_nicks_ moved to
1406 _irc.server_default.away_check_max_nicks_
1407** _irc.network.default_msg_part_ moved to
1408 _irc.server_default.default_msg_part_
1409** _irc.network.default_msg_quit_ moved to
1410 _irc.server_default.default_msg_quit_
6394a3d1 1411* other IRC options renamed:
7d3d56cc 1412** _irc.look.open_channel_near_server_ moved to _irc.look.new_channel_position_
6394a3d1 1413 (old option was boolean, new is integer with value as string)
7d3d56cc 1414** _irc.look.open_pv_near_server_ moved to _irc.look.new_pv_position_
6394a3d1 1415 (old option was boolean, new is integer with value as string)
6f063c95 1416
951d1410 1417[[v0.3.3]]
5812564b 1418== Version 0.3.3 (2010-08-07)
f51ec651 1419
951d1410 1420[[v0.3.3_after_upgrade]]
5812564b 1421=== After /upgrade
6394a3d1
SH
1422
1423If you are using `/upgrade` from a previous release, then you must reconnect to
1424IRC servers in order to use new command /wallchops.
1425
951d1410 1426[[v0.3.3_options]]
5812564b 1427=== Options
a31d01a4 1428
7d3d56cc
SH
1429Option _irc.look.show_away_once_ has been renamed to
1430_irc.look.display_pv_away_once_.
6394a3d1 1431
7d3d56cc 1432Option _irc.network.lag_min_show_ is now in milliseconds, you should set new
6394a3d1 1433value: your current value multiplied by 1000 (new default value is 500).
f51ec651 1434
951d1410 1435[[v0.3.2]]
5812564b 1436== Version 0.3.2 (2010-04-18)
2a37b44a 1437
951d1410 1438[[v0.3.2_after_upgrade]]
5812564b 1439=== After /upgrade
6394a3d1 1440
2a37b44a
SH
1441If you are using `/upgrade` from a previous release, then you must execute this
1442command on all IRC servers/channels/private buffers and xfer DCC chats (not
6394a3d1
SH
1443needed on WeeChat core buffer or buffers from other plugins/scripts):
1444
5812564b 1445----
6394a3d1 1446/buffer set highlight_words $nick
5812564b 1447----
2a37b44a 1448
951d1410 1449[[v0.3.1.1]]
5812564b 1450== Version 0.3.1.1 (2010-01-31)
2a37b44a 1451
6394a3d1 1452This version fixes crashes with SSL connection and purge of old DCC chats.
2a37b44a 1453
b5082902 1454All users of version 0.3.1 should upgrade to this version.
2a37b44a 1455
951d1410 1456[[v0.3.1]]
5812564b 1457== Version 0.3.1 (2010-01-23)
2a37b44a 1458
951d1410 1459[[v0.3.1_aliases]]
5812564b 1460=== Aliases
6394a3d1 1461
2a37b44a 1462IRC commands /ame and /amsg are now aliases, if you are upgrading from version
6394a3d1
SH
14630.3.0, you must create aliases with following commands:
1464
5812564b 1465----
6394a3d1
SH
1466/alias aaway allserv /away
1467/alias ame allchan /me
1468/alias amsg allchan /amsg *
1469/alias anick allserv /nick
5812564b 1470----
2a37b44a 1471
951d1410 1472[[v0.3.0]]
5812564b 1473== Version 0.3.0 (2009-09-06)
2a37b44a 1474
6394a3d1 1475This version brings *MAJOR* changes, especially for configuration files and
25f8a629 1476plugin API and is not compatible with previous versions.
ce657fd7
SH
1477
1478Major differences:
1479
fa845c2e 1480* It is *NOT POSSIBLE* to use command `/upgrade` from a version 0.2.x to 0.3.x;
ce657fd7 1481 you have to quit your old WeeChat, then run new version.
fa845c2e 1482* New configuration files (`*.conf`) are not compatible with old files
3450bf7c 1483 (`*.rc`).
fa845c2e 1484* Name of options is similar to old versions, but there is now one
3450bf7c 1485 configuration file by plugin, and one file for WeeChat core; there is
ce657fd7
SH
1486 *no automatic conversion* for your old options to new configuration files,
1487 so you'll have to setup again your IRC servers and all other options.
fa845c2e 1488* Plugin API has been rewritten and is not compatible with previous versions;
ce657fd7
SH
1489 accordingly, scripts and plugins must have been designed for version 0.3.x to
1490 be loaded into WeeChat.
1491
1492More information about new API is available on wiki:
1493http://wiki.flashtux.org/wiki/WeeChat_0.3.0
1494and http://wiki.flashtux.org/wiki/WeeChat_0.3.0_API
2a37b44a 1495
951d1410 1496[[v0.2.6.3]]
5812564b 1497== Version 0.2.6.3 (2009-06-13)
2a37b44a
SH
1498
1499This version fixes gnutls detection.
1500
951d1410 1501[[v0.2.6.2]]
5812564b 1502== Version 0.2.6.2 (2009-04-18)
2a37b44a 1503
7d3d56cc 1504This version fixes a bug with charset decoding (like _iso2022jp_).
2a37b44a 1505
951d1410 1506[[v0.2.6.1]]
5812564b 1507== Version 0.2.6.1 (2009-03-14)
2a37b44a
SH
1508
1509This version fixes a major bug: crash with some special chars in IRC messages.
1510
951d1410 1511[[v0.2.6]]
5812564b 1512== Version 0.2.6 (2007-09-06)
2a37b44a
SH
1513
1514No release note.
1515
951d1410 1516[[v0.2.5]]
5812564b 1517== Version 0.2.5 (2007-06-07)
2a37b44a
SH
1518
1519No release note.
1520
951d1410 1521[[v0.2.4]]
5812564b 1522== Version 0.2.4 (2007-03-29)
2a37b44a
SH
1523
1524No release note.
1525
951d1410 1526[[v0.2.3]]
5812564b 1527== Version 0.2.3 (2007-01-10)
2a37b44a
SH
1528
1529This version fixes several major bugs of version 0.2.2.
1530
1531All users of version 0.2.2 should upgrade to this version.
1532
951d1410 1533[[v0.2.2]]
5812564b 1534== Version 0.2.2 (2007-01-06)
2a37b44a 1535
951d1410 1536[[v0.2.2_charset_plugin]]
5812564b 1537=== Charset plugin
6394a3d1
SH
1538
1539For users of any previous version, all your charset settings in weechat.rc will
1540be LOST! You should save your weechat.rc to keep your values and set them again
7d3d56cc 1541with new _charset_ plugin.
6394a3d1
SH
1542
1543For ISO users: history of channels may be without accents (after `/upgrade`),
1544this is not recoverable, but this is not a bug. All new messages should be OK.
1545
3450bf7c 1546Be careful, now default encode is UTF-8 for all channels (before it was
7d3d56cc
SH
1547terminal charset). If you still want to send messages as _ISO-8859-1_, you
1548should set either global encode or server specific encode to _ISO-8859-1_.
6394a3d1
SH
1549
1550For global encode:
1551
5812564b 1552----
6394a3d1 1553/setp charset.global.encode = "ISO-8859-1"
5812564b 1554----
6394a3d1
SH
1555
1556For server encode (on server buffer):
1557
5812564b 1558----
6394a3d1 1559/charset encode ISO-8859-1
5812564b 1560----
6394a3d1 1561
951d1410 1562[[v0.2.2_new_keys]]
5812564b 1563=== New keys
6394a3d1 1564
7d3d56cc 1565New keys for topic scroll: kbd:[F9]/kbd:[F10].
6394a3d1 1566
7d3d56cc 1567Key kbd:[F10] was used for `infobar_clear` in previous WeeChat versions, you
03fa2448 1568have to manually rebind this key (except for new WeeChat users):
6394a3d1 1569
5812564b 1570----
6394a3d1 1571/key <press alt+"k" then F10> scroll_topic_right
5812564b 1572----
6394a3d1
SH
1573
1574Which gives something like:
1575
5812564b 1576----
6394a3d1 1577/key meta2-21~ scroll_topic_right
5812564b 1578----
2a37b44a 1579
951d1410 1580[[v0.2.1]]
5812564b 1581== Version 0.2.1 (2006-10-01)
2a37b44a
SH
1582
1583No release note.
1584
951d1410 1585[[v0.2.0]]
5812564b 1586== Version 0.2.0 (2006-08-19)
2a37b44a 1587
951d1410 1588[[v0.2.0_after_upgrade]]
5812564b 1589=== After /upgrade
2a37b44a 1590
6394a3d1
SH
1591If you upgraded with `/upgrade` in WeeChat, you should `/disconnect` and then
1592`/reconnect` on each server, to display properly channel/user modes.
1593
951d1410 1594[[v0.2.0_plugins]]
5812564b 1595=== Plugins
6394a3d1 1596
3450bf7c 1597If you're using plugins, you should remove some old plugins libraries in
7d3d56cc 1598WeeChat system library directory (commonly _/usr/local/lib/weechat/plugins_):
3450bf7c
SH
1599remove `lib*` files (like `libperl.*`, `libpython.*`, ..) and keep only new
1600libraries (`perl.*`, `python.*`, ..).
2a37b44a 1601
951d1410 1602[[v0.1.9]]
5812564b 1603== Version 0.1.9 (2006-05-25)
2a37b44a 1604
951d1410 1605[[v0.1.9_dcc_chat]]
5812564b 1606=== DCC chat
6394a3d1
SH
1607
1608Please close all DCC chat buffers before using /upgrade command, otherwise you
1609may experience problems with DCC chats.
2a37b44a 1610
951d1410 1611[[v0.1.9_script_api]]
5812564b 1612=== Script API
6394a3d1
SH
1613
1614Some changes in script API: now timer handlers functions takes exactly 0 (zero)
1615argument (in version 0.1.8, two arguments were mandatory but not used: server
1616and arguments).
2a37b44a 1617
951d1410 1618[[v0.1.8]]
5812564b 1619== Version 0.1.8 (2006-03-18)
2a37b44a 1620
951d1410 1621[[v0.1.8_after_upgrade]]
5812564b 1622=== After /upgrade
6394a3d1
SH
1623
1624After installing 0.1.8 (or with `/upgrade`), issue both commands (if you didn't
7d3d56cc 1625redefine these keys (kbd:[Alt+Home] / kbd:[Alt+End]):
6394a3d1 1626
5812564b 1627----
6394a3d1
SH
1628/key unbind meta-meta2-1~
1629/key unbind meta-meta2-4~
5812564b 1630----
6394a3d1
SH
1631
1632Then launch again WeeChat (or issue `/upgrade`).
1633
951d1410 1634[[v0.1.8_configuration_files]]
5812564b 1635=== Configuration files
6394a3d1
SH
1636
1637It is recommended for users of version 0.1.7 (or any older), to replace values
7d3d56cc 1638in setup file (_~/.weechat/weechat.rc_):
6394a3d1 1639
7d3d56cc
SH
1640* option: log_path: replace _~/.weechat/logs_ by _%h/logs_
1641* option: plugins_path: replace _~/.weechat/plugins_ by _%h/plugins_
6394a3d1 1642
7d3d56cc 1643The string _%h_ is replaced by WeeChat home (default: _~/.weechat_, may be
6394a3d1
SH
1644overridden by new command line argument `--dir`).
1645
951d1410 1646[[v0.1.8_keys]]
5812564b 1647=== Keys
6394a3d1 1648
7d3d56cc
SH
1649Keys kbd:[Alt+Home] / kbd:[Alt+End] were used for nicklist scroll, they're now
1650replaced by kbd:[Alt+F11] / kbd:[Alt+F12].
2a37b44a 1651
951d1410 1652[[v0.1.7]]
5812564b 1653== Version 0.1.7 (2006-01-14)
2a37b44a 1654
951d1410 1655[[v0.1.7_ruby]]
5812564b 1656=== Ruby
6394a3d1
SH
1657
1658Ruby script plugin has been added but is experimental in this release. You're
1659warned!
1660
951d1410 1661[[v0.1.7_command_away]]
5812564b 1662=== Command /away
2a37b44a 1663
6394a3d1
SH
1664Command `/away` was changed to be RFC 2812 compliant. Now argument is required
1665to set away, and no argument means remove away ("back").
1666
7d3d56cc 1667Option _irc_default_msg_away_ has been removed.
2a37b44a 1668
951d1410 1669[[v0.1.6]]
5812564b 1670== Version 0.1.6 (2005-11-11)
2a37b44a 1671
951d1410 1672[[v0.1.6_script_api]]
5812564b 1673=== Script API
6394a3d1
SH
1674
1675Incompatibility with some old scripts: now all handlers have to return a code
1676for completion, and to do some actions about message to ignore (please look at
1677documentation for detail).
1678
951d1410 1679[[v0.1.6_openbsd]]
5812564b 1680=== OpenBSD
6394a3d1 1681
7d3d56cc
SH
1682On OpenBSD, the new option _plugins_extension_ should be set to _.so.0.0_ since
1683the plugins names are ending by _.so.0.0_ and not _.so_.
6394a3d1 1684
951d1410 1685[[v0.1.6_utf8]]
5812564b 1686=== UTF-8
6394a3d1 1687
7d3d56cc 1688With new and full UTF-8 support, the option _look_charset_internal_ should be
6394a3d1 1689set to blank for most cases. Forces it only if your locale is not properly
7d3d56cc
SH
1690detected by WeeChat (you can set _UTF-8_ or _ISO-8859-15_ for example,
1691depending on your locale). WeeChat is looking for _UTF-8_ in your locale name
3450bf7c 1692at startup.
2a37b44a 1693
951d1410 1694[[v0.1.5]]
5812564b 1695== Version 0.1.5 (2005-09-24)
2a37b44a
SH
1696
1697No release note.
1698
951d1410 1699[[v0.1.4]]
5812564b 1700== Version 0.1.4 (2005-07-30)
2a37b44a
SH
1701
1702No release note.
1703
951d1410 1704[[v0.1.3]]
5812564b 1705== Version 0.1.3 (2005-07-02)
2a37b44a
SH
1706
1707No release note.
1708
951d1410 1709[[v0.1.2]]
5812564b 1710== Version 0.1.2 (2005-05-21)
2a37b44a
SH
1711
1712No release note.
1713
951d1410 1714[[v0.1.1]]
5812564b 1715== Version 0.1.1 (2005-03-20)
2a37b44a
SH
1716
1717No release note.
1718
951d1410 1719[[v0.1.0]]
5812564b 1720== Version 0.1.0 (2005-02-12)
2a37b44a
SH
1721
1722No release note.
1723
951d1410 1724[[v0.0.9]]
5812564b 1725== Version 0.0.9 (2005-01-01)
2a37b44a
SH
1726
1727No release note.
1728
951d1410 1729[[v0.0.8]]
5812564b 1730== Version 0.0.8 (2004-10-30)
2a37b44a
SH
1731
1732No release note.
1733
951d1410 1734[[v0.0.7]]
5812564b 1735== Version 0.0.7 (2004-08-08)
2a37b44a
SH
1736
1737No release note.
1738
951d1410 1739[[v0.0.6]]
5812564b 1740== Version 0.0.6 (2004-06-05)
2a37b44a
SH
1741
1742No release note.
1743
951d1410 1744[[v0.0.5]]
5812564b 1745== Version 0.0.5 (2004-02-07)
2a37b44a
SH
1746
1747No release note.
1748
951d1410 1749[[v0.0.4]]
5812564b 1750== Version 0.0.4 (2004-01-01)
2a37b44a
SH
1751
1752No release note.
1753
951d1410 1754[[v0.0.3]]
5812564b 1755== Version 0.0.3 (2003-11-03)
2a37b44a
SH
1756
1757No release note.
1758
951d1410 1759[[v0.0.2]]
5812564b 1760== Version 0.0.2 (2003-10-05)
2a37b44a
SH
1761
1762No release note.
1763
951d1410 1764[[v0.0.1]]
5812564b 1765== Version 0.0.1 (2003-09-27)
2a37b44a
SH
1766
1767No release note.