(x_catch_errors): Use xmalloc.
[emacs.git] / etc / ERC-NEWS
blobada1d02785dcceeb59f0415d7849ce2632bfd32f
1 ERC NEWS                                                       -*- outline -*-
3 * Changes in ERC 5.1.2 (unreleased)
5 ** Fix compiler errors in erc-autojoin.el and erc-dcc.el.
7 ** Move to end of prompt when ERC reconnects to a server.
9 ** Changes and additions to modules
11 *** Spell-checking (erc-spelling.el)
13 **** Don't spell-check nicks or words that are prefixed with '/'.
15 **** Remove flyspell properties from words we shouldn't spell-check.
17 **** Fix an issue that caused the ispell process to reload every time
18 we switch to an ERC buffer.
20 *** Timestamps (erc-stamp.el)
22 **** Fix an inconsistency in calculating width of right timestamps.
24 **** Rename option `erc-timestamp-right-align-by-pixel' to
25 `erc-timestamp-use-align-to'.  This controls whether to use the more
26 fail-proof method of aligning right timestamps, as mentioned below.
28 **** Fix a right timestamp spacing problem that used to occur when
29 erc-stamp.el was byte-compiled.  Now that this is fixed, it is safe to
30 use the method that aligns right timestamps perfectly in Emacs22 with
31 X.  If the current version of Emacs doesn't support this method, use
32 the simpler method, which is prone to alignment issues for math
33 symbols and other variable-width text.
35 A side effect of using this new method is that there will only be one
36 space before a right timestamp in any saved logs.  If this is
37 unacceptable, set `erc-timestamp-use-align-to' to nil.
39 * Changes in ERC 5.1.1
41 ** Fix a requirement on cl.el.
43 ** Use tls.el for SSL connections, rather than ssl.el.
45 ** Changes and additions to modules
47 *** ibuffer integration (erc-ibuffer.el)
49 **** Update this to work with the version of ibuffer.el that comes with
50 recent Emacs variants.
52 *** Old completion (erc-complete.el)
54 **** Fix a few errors.
56 *** Speedbar (erc-speedbar.el)
58 **** Make this work with the version of speedbar.el that comes with
59 recent Emacs variants.
61 *** Timestamps (erc-stamp.el)
63 **** By default, use a more failsafe method of displaying right timestamps.
64 To get right timestamps to align perfectly in Emacs22 using X, set the
65 new `erc-timestamp-right-align-by-pixel' option to non-nil.
67 *** Viper compatibility (erc-viper.el)
69 **** Since most of these changes are now merged into Emacs22, detect
70 whether we need these changes and install them only if necessary.
72 * Changes in ERC 5.1
74 ** Improve XEmacs compatibility.
76 ** Namespace changes
78 *** Now ERC doesn't use global variable space.
79 Renamed all variables that didn't start with "erc-".
81   o `away' is now `erc-away'
83   o `current-nick' is now `erc-server-current-nick'
85   o `last-peers' is now `erc-server-last-peers'
87   o `last-ping-time' is now `erc-server-last-ping-time'
89   o `last-sent-time' is now `erc-server-last-sent-time'
91   o `lines-sent' is now `erc-server-lines-sent'
93   o `quitting' is now `erc-server-quitting'
95 *** Remove the `with-erc-channel-buffer' function.
97 ** Bugfixes
99 *** Don't inadvertently destroy face properties.
101 *** Load erc scripts in a safer way.
103 *** Don't insert a timestamp if text at point is invisible.
105 *** Don't hide messages from those in `erc-fools' by default.
106 Color their nicks instead.
108 *** Use a more foolproof method of encoding and decoding strings
109 before sending to a channel.
111 ** Backend changes
113 *** Renamed some server-specific variables
115   o `erc-announced-server-name' is now `erc-server-announced-name'
117   o `erc-auto-reconnect' is now `erc-server-auto-reconnect'
119   o `erc-connect-function' is now `erc-server-connect-function'
121   o `erc-default-coding-system' is now `erc-server-coding-system'
123   o `erc-duplicate-timeout' is now `erc-server-duplicate-timeout'
125   o `erc-duplicates' is now `erc-server-duplicates'
127   o `erc-lag' is now `erc-server-lag'
129   o `erc-prevent-duplicates' is now `erc-server-prevent-duplicates'
131   o `erc-previous-read' is now `erc-server-filter-data'
133   o `erc-process' is now `erc-server-process'
135   o `erc-ping-handler' is now `erc-server-send-ping-handler'
137   o `erc-ping-interval' is now `erc-server-send-ping-interval'
139 *** Renamed some functions
141   o `erc-connect' is now `erc-server-connect'
143   o `erc-process-filter' is now `erc-server-filter-function'
145   o `erc-send-command' is now `erc-server-send'
147   o `erc-send-single-line' is now `erc-send-input'
149   o `erc-setup-periodical-server-ping' is now
150     `erc-server-setup-periodical-server-ping'
152   o `erc-split-command is now `erc-split-line'
154 *** New options
156   o erc-server-flood-margin, erc-server-flood-penalty: New options
157     that allow tweaking of flood control.
159   o erc-split-line-length: The maximum line length of a single
160     message.
162 *** New variables
164   o erc-server-flood-last-message, erc-server-flood-queue,
165     erc-server-flood-timer: Flood control.
167   o erc-server-processing-p: Indicate when we're currently processing
168     a message.
170 *** Remove some options
172   o `erc-flood-limit'
173   o `erc-flood-limit2'
175 ** New customization group `erc-server' for dealing with IRC servers.
177 ** ERC can now be installed by doing `make install' from the command line.
179 ** ERC now has a manual in erc.texi.
180 Type `make doc' to generate HTML and Info versions of it.
182 ** ERC no longer depends on cl.el.
183 Only the macros in cl-macs.el are used.
185 ** Fix an edge case when quitting as new messages come in.
187 ** Make flood protection toggle-able as on/off, removing the 'strict option.
189 ** If possible, re-use channel buffers when reconnecting to a server.
191 ** Text in ERC buffers is now read-only by default.
192 To get the previous behavior, 
194 ** Changes and additions to modules
196 *** Auto-join (erc-autojoin.el)
198 **** Recognize the Azzurra server.
200 *** BBDB (erc-bbdb.el)
202 **** When the user types /WHOIS, ask for a record to merge to.
204 **** Store the displayed name of a BitlBee contact.
205 The new `erc-bbdb-bitlbee-name-field' option specifies the field to use
206 to store this information.
208 **** Don't prompt for a name on /JOIN or /NICK.
210 *** Button (erc-button.el)
212 **** Fix customization of `erc-button-alist'
214 **** New option `erc-button-nickname-face' determines the face to use
215 when coloring ERC nicknames.
217 *** Channel tracking (erc-track.el)
219 **** Remove channels from the modified channels list if not currently
220 connected.  This should remove residue from the mode line after
221 quitting ERC.
223 **** Recognize buttonized text
225 *** Highlighting (erc-match.el)
227 **** Highlight current nickname by default.
229 **** Added the option of beeping when certain matches occur.
230 Add `erc-beep-on-match' to `erc-text-matched-hook' to enable
231 beeping.  Set the new variable `erc-beep-match-types' which match
232 types that make beeps.
234 *** Nicklist (erc-nicklist.el)
236 **** Fix a couple of errors.
238 **** Make sure a stray mouse click doesn't trigger an error.
240 **** Insert icons from the /images directory next to nicks.
241 This indicates their away status.  The location is customizable via
242 the new `erc-nicklist-icons-directory' option.
244 If you do not want these icons, set `erc-nicklist-use-icons' to nil.
246 *** Nickserv identification (erc-nickserv.el)
248 **** Recognize Azzurra and OFTC networks.
250 *** Old completion (erc-complete.el)
252 **** Disable by default.
254 *** Programmable completion (erc-pcomplete.el)
256 **** Enable by default.
258 *** Timestamps (erc-stamp.el)
260 **** On Emacs22, align right timestamps perfectly, even if variable-width
261 characters are used.  If we aren't using Emacs22, move text farther
262 away from the right margin when variable-width characters are used.
263 It is considered better to misalign the stamp by a bit than to go past
264 the right margin.
266 **** Enable by default
268 ** New modules
270 *** Spell-checking (erc-spelling.el)
272 **** Use flyspell in ERC.
274 *** Viper compatibility (erc-viper.el)
276 **** Helps ERC work correctly in viper-mode.
278 * Changes in ERC 5.0.4
280 ** Fix a problem with undo in channels.
282 * Changes in ERC 5.0.3
284 ** Fix typo in the `ctcp-request-to' entry of the English catalog.
286 ** Debugging with edegug has been made easier in all of the
287 erc-with-* and with-erc* macros.
289 ** Non-ASCII character sets should be better supported when sending
290 and processing messages.
292 ** A load failure with erc-autoaway.el and Emacs21 has been fixed.
294 ** A few XEmacs warnings were fixed.
296 ** Changes and additions to modules
298 *** Backend (erc-backend.el)
300 **** Move the check for hidden messages into `erc-display-message'
301 so there isn't so much replicated code.
303 **** Add `definition-name' property to constructed symbols so that
304 `find-function' and `find-variable' will be able to locate them.
306 **** Make sure logs are inserted info the correct channel buffers.
307 There was previously an error when using `erc-insert-log-on-open' in
308 combination with autojoin to multiple channels.
310 *** Button (erc-button.el)
312 **** The layering of `erc-button-face' on other faces in ERC buffers
313 has been improved.
315 *** Channel tracking (erc-track.el)
317 **** Use optimal amount of whitespace around modified channels
318 indicator.  Previously, there was an additional unnecessary space.
320 **** Fix an error that occurred when unchecked buffers existed when
321 invoking /QUIT.
323 * Changes in ERC 5.0.2
325 ** If a channel key is required for a certain channel, ERC will prompt
326 for one if `erc-prompt-for-channel-key' is non-nil.
328 ** ERC doesn't try to reconnect if the network connection is refused
329 when using `open-network-stream-nowait' as the `erc-connect-function'.
331 ** Messages from multiple servers will not go to the currently active
332 buffer.  The messages from each server will be contained in the most
333 recently active channel/server buffer that corresponds with the
334 server.
336 ** Some text messages were cleaned up slightly.
338 ** Button faces should no longer "cover" other faces.
340 ** Made some XEmacs compatibility fixes.
342 ** Nicknames containing a backslash are now correctly highlighted as
343 current-nick and buttonized as nicks.
345 ** `erc-server-select' doesn't offer networks without servers as a
346 choice anymore.
348 ** Non-ASCII character support has been improved.
350 ** Changes and additions to modules
352 *** Menu (erc-menu.el)
354 **** You can now save logs and truncate buffers from the menu-bar.
356 * Changes in ERC 5.0.1
358 ** Narrowing in ERC buffers no longer causes formatting errors.
360 ** The BBDB module now loads correctly when customizing `erc-modules'.
362 ** The value of `erc-button-face' is now respected.
364 ** Fixed a bug which caused a read-only error during connection.
366 ** Server buffers are now tracked correctly.
367 This means that `erc-track-priority-faces-only', `erc-track-exclude',
368 and `erc-track-exclude-types' now work with server buffers.
370 * Changes in ERC 5.0
372 ** Channel members are now stored as a hash-table.
373 `erc-server-users' and `erc-channel-users' are now hash-tables, rather
374 than alists.  This significantly increases performance, especially in
375 large channels.  Each channel member is stored as an `erc-server-user'
376 struct, with additional information about the channels they are on
377 stored in an `erc-channel-user' struct.  Code using old alist-style
378 channel members needs to be updated to work with hash-tables.
379 This new code also removes the need for erc-members.el, which has been
380 removed.
382 ** The way ERC deals with input from the server has changed.
383 All server response code is now in a new file, erc-backend.el.  There
384 should be no real user visible changes.  There are, however, a few
385 major changes for implementers, and module writers:
387 *** The PARSED response that all handlers get called with is
388     no longer a vector, but an `erc-response' struct.
390     This means LESS MAGIC NUMBERS in the ERC source code, but a few
391     changes in how you get at parsed responses.
393     The sender is accessed via `erc-response.sender'.
395     The command is accessed via `erc-response.command'.
397     The arguments to the command (everything after the command and
398     before the colon) are accessed via `erc-response.command-args'.
399     This is a /list/ of arguments in the order they appear in the
400     unparsed response.
402     The contents of the response is accessed via
403     `erc-response.contents'.
405     Should, for some reason, you want to do something with the
406     /unparsed/ response, you can get it via `erc-response.unparsed'.
408 *** The `erc-server-hook-list' mechanism is gone.
410     All server response handlers should be defined with
411     `define-erc-response-handler'.  This defines functions and
412     corresponding hook variables.
414     The mapping of server commands to hook variables is no longer
415     done via `erc-event-to-hook', but through an #'equal hashtable,
416     `erc-server-responses'.  In order to find a hook you do:
418     (erc-get-hook command)
420     See the docstring of `define-erc-response-handler' for more
421     information.
423 *** ALL hook variables have been renamed.
425     In accordance with recommendations in the Emacs Lisp manual,
426     the hook variables are no longer called `erc-server-FOO-hook',
427     but rather `erc-server-FOO-functions'.  This is to indicate
428     that the functions they call take arguments.
430     All the modules in ERC have been updated to reflect this change,
431     but external module authors should beware.
433 ** The values of `erc-mode-line-format' and `erc-header-line-format'
434 are now defined as strings to be formatted using `format-spec'.
435 `erc-mode-line-format' does not replace the whole mode-line anymore,
436 only `mode-line-buffer-identification' is set.  This way, personal
437 mode-line configurations are not modified and all key bindings work as
438 expected.  The process status (connecting, closed) is now shown in
439 `mode-line-process'.
441 ** Customization of ERC variables has been made easier.  Variables
442 have been split into more groups for better organization.
444 ** New variables
446   o `erc-send-whitespace-lines' - Set this to send lines even if they
447     are empty.
449   o `erc-manual-set-nick-on-bad-nick-p' - If the nickname you chose is
450     already taken or not allowed, your nick is not changed and you can
451     try again manually if this is non-nil.
453   o `erc-mode-line-away-status-format' - You can now set what is shown
454     in the mode-line when you are away.
456   o `erc-header-line-uses-help-echo-p' - The header-line now uses the
457     help-echo property. You can set this to nil to disable it.
459   o `erc-format-query-as-channel-p' - Set this to nil to have messages
460     in the query buffer formatted like private messages.
462   o `erc-show-channel-key-p' - The channel key is now shown with the
463     other channel modes in the header line. Set this to nil if you
464     want it hidden.
466   o `erc-prompt-for-channel-key' - Set this if you want to be prompted
467     for the channel key (channel's mode is +k) when you call
468     `erc-join-channel' interactively.
470   o `erc-kill-server-buffer-on-quit' - If non-nil, kill the server
471     buffer automatically when you quit.
473 ** New hooks
475   o `erc-join-hook' - Called when you join a channel.
477   o `erc-kick-hook' - Called when you are kicked from a channel. The
478     channel's buffer is sent as an argument to functions called from
479     this hook.
481   o `erc-nick-changed-functions' - Whenever your nickname changes
482     successfully, the functions in this hook are run with the
483     arguments NEW-NICK and OLD-NICK.
485 ** New command /WHOAMI - Do a /WHOIS on your current nickname.
487 ** The key binding for changing channel modes is now C-c C-o.
489 ** Removed variables
491   o `erc-echo-notices-in-minibuffer-flag' and
492     `erc-echo-notices-in-current-buffer' - You should use
493     `erc-echo-notice-hook' and `erc-echo-notice-always-hook' instead.
495   o `erc-prompt-interactive-input' has been removed (commented out)
496     because nickname completion does not work with it.
498   o All INFO buffer-related variables and functions have been removed.
500 ** You can now disable modules by setting `erc-modules' with the
501 customization interface.
503 ** Changes and additions to modules
505 *** Autoaway (erc-autoaway.el)
507 **** New variable `erc-autoaway-no-auto-back-regexp' - Add text which,
508 when you type anything matching it, will not automatically discard
509 your away status when `erc-auto-discard-away' is non-nil.
511 *** Filling (erc-fill.el)
513 **** New variable `erc-fill-variable-maximum-indentation' - Don't
514 indent more than this many characters when indenting a message from a
515 user with a long nickname.
517 *** Goodies (erc-goodies.el)
519 **** Miscellaneous small modules have been moved from erc.el.
520 The functions erc-add-scroll-to-bottom, erc-make-read-only,
521 erc-send-distinguish-noncommands, erc-interpret-controls, erc-unmorse,
522 erc-smiley, and erc-occur, which were defined in the main erc.el file
523 have been moved to erc-goodies.el and have mostly been translated to
524 the modules scrolltobottom, readonly, noncommands, irccontrols, smiley
525 and unmorse.
527 **** New variables
529   o `erc-input-line-position' - The line number to use with
530     `erc-scroll-to-bottom'.
532   o `erc-beep-p' - Beep if there is a \C-g control character in a
533     message.
535 *** Channel lists (erc-list.el)
537 **** New variable `erc-chanlist-highlight-face' - A face used for
538 highlighting the current line.
540 *** Highlighting (erc-match.el)
542 **** `erc-current-nick-highlight-type' has new options: 'keyword and
543 'nick-or-keyword.
545 *** Menu (erc-menu.el)
547 **** The `IRC' menu is now automatically added to `erc-mode' buffers.
549 *** Networks (erc-nets.el)
551 **** The functions for determining current network are in this file.
552 There were a couple of functions spread about in different files which
553 each had a different way of determining the current network.  The
554 methods have been combined, and the big list of known networks
555 (`erc-networks-alist') is being put to use.  You can access the
556 network's name by calling the new function `erc-network'.  This
557 returns the name of the current network as a symbol or 'Unknown if it
558 could not determine which network it is.
560 *** Nicklist (erc-nicklist.el)
562 **** ERC has a new way of displaying nicknames in a channel.
563 The new file erc-nicklist.el defines a new command `erc-nicklist'
564 which pops up a small Emacs window showing the nicknames of all
565 members of the current channel.  The implementation is not complete
566 and is rather proof-of-concept for now.  The result is something a bit
567 like erc-speedbar, but not quite as invasive, and doesn't require use
568 of a new frame.
570 *** Internet services / Nickserv (erc-nickserv.el)
572 **** Network detection is now taken care of by erc-nets.el.
573 The function `erc-current-network' is deprecated, use `erc-network'
574 instead.  The variable `erc-networks' has been removed, use
575 `erc-networks-alist'.  The network symbols used in
576 `erc-nickserv-alist' now match those in `erc-networks-alist'.
578 **** New variable `erc-nickserv-identify-mode' - Choose which method
579 to use for automatic identification: you can wait for Nickserv to ask
580 you to identify (the default), or send an identify message
581 automatically after you change your nickname.
583 *** Speedbar (erc-speedbar.el)
585 **** New variable `erc-speedbar-sort-users-type' - Sort users in a
586 channel by activity, alphabetically, or not at all.
588 *** Timestamps (erc-stamp.el)
590 **** `erc-timestamp-only-if-changed-flag' now works when
591 `erc-insert-timestamp-function' is set to 'erc-insert-timestamp-left.
593 **** New variable `erc-timestamp-intangible' - Set this to nil if
594 timestamps should not have the 'intangible property.
596 *** Channel tracking (erc-track.el)
598 **** Using faces to indicate channel activity in the modeline now works
599 in XEmacs.
601 **** New variables
603   o `erc-track-priority-faces-only' - Ignore changes in a channel
604     unless there is a face from the `erc-track-faces-priority-list' in
605     the message.
607   o `erc-track-exclude-server-buffer' - Ignore changes in the server
608     buffer.
610   o `erc-track-position-in-mode-line' - Set the position in the
611     mode-line where modified channels are shown (only works in GNU
612     Emacs versions above 21.3).
614 * Changes in ERC 4.0
616 ** The module system has again changed a lot.  You can now customize
617   the variable `erc-modules' and define once and for all which
618   extension modules you want to use.  This unfortunately may require
619   you to change your current erc initialisation code a bit, if you
620   have some existing customsations.  On the other hand, this change
621   makes the configuration of extension modules a lot easier for new
622   users.  In theory, you should be able to configure all aspects of
623   ERC by using the customize interface, you should no longer really
624   need to write Lisp code for trivial customizations.
626   By default, the following modules are now loaded: (pcomplete
627   netsplit fill track ring button autojoin)
629   Please use M-x customize-variable RET erc-modules RET to change the
630   default if it does not suite your needs.
632 ** THe symbol used in `erc-nickserv-passwords' for debian.org IRC servers
633   (formerly called OpenProjects, now FreeNode) has changed from
634   openprojects to freenode.  You may need to update your configuration
635   for a successful automatic nickserv identification.
637 * Changes in ERC 3.0.cvs.20030119
639 ** New module erc-dcc:
641 This finally implements DCC.  It requires server sockets to fully work
642 in both directions.  This feature is currently only available in Emacs
643 21.3.50 (CVS). Here is a short list of what should work though.
645 ** Compatibility:
646   * Emacs 21.2, DCC get, and accepting DCC chat offers.
647   * XEmacs 21, Only accepting DCC chat offers.
649 ** erc is switching to global-minor-modes for activation of submodules.
651 This allows you to customize such a mode and get automatic loading of
652 the module.  No longer putting a lot of require statments in .emacs.
653 At least this is the long-term plan, not all modules are converted
654 yet.
656 ** The most important user visible change is that you now need to activate
657 erc-completion-mode, to get TAB completion.  The new completion code
658 is based on pcomplete.  To get the old code, manually load
659 erc-complete and bind TAB to erc-complete in erc-mode-map.
661 To activate completion on startup, put (erc-completion-mode 1) in your
662 .emacs file.
664 Same applies to timestamps.  You no longer need to (require
665 'erc-stamp), you can customize the variable `erc-timestamp-mode', and
666 the rest should be automatic.
668 arch-tag: 2b21b387-6cdc-4192-889c-6743cfffdcb1