1 ERC NEWS -*- outline -*-
3 * Changes in ERC 5.2 (unreleased)
7 ** Fix use of /quote command with no initial whitespace.
9 ** Make it possible to customize the colorization of the header line.
10 The `erc-header-line' face is used to color the header line.
11 The `erc-header-line-face-method' determines the method to use when
12 colorizing the header line.
14 ** Add the new function `erc-handle-irc-url', which is a suitable
15 candidate to use for `url-irc-function'. This permits some
16 integration of url.el and ERC.
18 ** Fix several errors that occur when server or channel buffers are killed
21 ** Fix toggling of flood control.
23 ** Match the patterns in `erc-encoding-coding-alist' as regexps,
24 instead of verbatim text. Also, match case-insensitively.
26 ** The /SMV command has been removed, since we no longer have
27 meaningful module-specific version information.
29 ** Fix a "(stringp nil)" error that can happen when doing /PART.
31 ** Use a better example in the `erc-part-reason-various-alist'
34 ** When using `erc-quit-reason-various' and `erc-part-reason-various'
35 and no matches are found, default to using the ERC version string
38 ** Add the `list' and `page' modules to the `erc-modules' customize
41 ** Changes to the ERC manual
43 *** Update the list of available modules.
45 *** Revise information about releases and development.
47 *** Provide a simpler example in the "Getting Started" chapter.
49 *** Fully document how to connect to an IRC server in the new
52 ** Changes and additions to modules
54 *** Autoaway (erc-autoaway.el)
56 **** Rename the `erc-autoaway-use-emacs-idle' option to
57 `erc-autoaway-idle-method'.
59 **** Add support for autoaway based on user idle time.
60 This is now the default.
62 **** If you set the AWAY status yourself, erc-autoaway will not
63 interfere by un-setting AWAY prematurely.
65 **** If you are set away while visiting a non-ERC buffer,
66 erc-autoaway used to fail in bringing the user back. This is now
69 *** BBDB (erc-bbdb.el)
71 **** Add new option `erc-bbdb-electric-p', which determines whether
72 to make the BBDB buffer electric. This defaults to not electric.
74 *** Button (erc-button.el)
76 **** Use <backtab> instead of <C-tab> for `erc-button-previous'.
78 *** Identd (erc-identd.el)
80 **** Fix a bug that involves starting the identd server.
82 **** Make this work with Emacs 22.
84 **** Provide a real ERC module named `identd'.
86 **** Don't create an extra buffer for the identd process.
88 *** Logging (erc-log.el)
90 **** By default, don't insert old logs when opening an ERC buffer.
91 This may be changed by customizing `erc-log-insert-log-on-open'.
93 **** New option `erc-log-write-after-send' determines whether the
94 log file will be written to after every sent message. The default is
97 **** New option `erc-log-write-after-insert' determines whether the
98 log file will be written to when new text is added to a logged ERC
99 buffer. The default is not to do this. With this option and the
100 previous option, logging should no longer slow down ERC as much.
102 **** Default to saving buffers and queries on quit.
103 This may be changed by customizing the `erc-save-buffer-on-quit' and
104 `erc-save-queries-on-quit' options, respectively.
106 **** Only perform logging when the `logging' module is added to
107 `erc-modules'. This prevents logging from being activated just by
108 loading the erc-log.el file, and makes logging act like other ERC
111 *** Programmable completion (erc-pcomplete.el)
113 **** Don't complete the user's current nickname.
115 * Changes in ERC 5.1.2
117 ** Fix compiler errors in erc-autojoin.el and erc-dcc.el.
119 ** Move to end of prompt when ERC reconnects to a server.
121 ** Changes and additions to modules
123 *** Spell-checking (erc-spelling.el)
125 **** Don't spell-check nicks or words that are prefixed with '/'.
127 **** Remove flyspell properties from words we shouldn't spell-check.
129 **** Fix an issue that caused the ispell process to reload every time
130 we switch to an ERC buffer.
132 *** Timestamps (erc-stamp.el)
134 **** Fix an inconsistency in calculating width of right timestamps.
136 **** Rename option `erc-timestamp-right-align-by-pixel' to
137 `erc-timestamp-use-align-to'. This controls whether to use the more
138 fail-proof method of aligning right timestamps, as mentioned below.
140 **** Fix a right timestamp spacing problem that used to occur when
141 erc-stamp.el was byte-compiled. Now that this is fixed, it is safe to
142 use the method that aligns right timestamps perfectly in Emacs22 with
143 X. If the current version of Emacs doesn't support this method, use
144 the simpler method, which is prone to alignment issues for math
145 symbols and other variable-width text.
147 A side effect of using this new method is that there will only be one
148 space before a right timestamp in any saved logs. If this is
149 unacceptable, set `erc-timestamp-use-align-to' to nil.
151 * Changes in ERC 5.1.1
153 ** Fix a requirement on cl.el.
155 ** Use tls.el for SSL connections, rather than ssl.el.
157 ** Changes and additions to modules
159 *** ibuffer integration (erc-ibuffer.el)
161 **** Update this to work with the version of ibuffer.el that comes with
162 recent Emacs variants.
164 *** Old completion (erc-complete.el)
166 **** Fix a few errors.
168 *** Speedbar (erc-speedbar.el)
170 **** Make this work with the version of speedbar.el that comes with
171 recent Emacs variants.
173 *** Timestamps (erc-stamp.el)
175 **** By default, use a more failsafe method of displaying right timestamps.
176 To get right timestamps to align perfectly in Emacs22 using X, set the
177 new `erc-timestamp-right-align-by-pixel' option to non-nil.
179 *** Viper compatibility (erc-viper.el)
181 **** Since most of these changes are now merged into Emacs22, detect
182 whether we need these changes and install them only if necessary.
186 ** Improve XEmacs compatibility.
190 *** Now ERC doesn't use global variable space.
191 Renamed all variables that didn't start with "erc-".
193 o `away' is now `erc-away'
195 o `current-nick' is now `erc-server-current-nick'
197 o `last-peers' is now `erc-server-last-peers'
199 o `last-ping-time' is now `erc-server-last-ping-time'
201 o `last-sent-time' is now `erc-server-last-sent-time'
203 o `lines-sent' is now `erc-server-lines-sent'
205 o `quitting' is now `erc-server-quitting'
207 *** Remove the `with-erc-channel-buffer' function.
211 *** Don't inadvertently destroy face properties.
213 *** Load erc scripts in a safer way.
215 *** Don't insert a timestamp if text at point is invisible.
217 *** Don't hide messages from those in `erc-fools' by default.
218 Color their nicks instead.
220 *** Use a more foolproof method of encoding and decoding strings
221 before sending to a channel.
225 *** Renamed some server-specific variables
227 o `erc-announced-server-name' is now `erc-server-announced-name'
229 o `erc-auto-reconnect' is now `erc-server-auto-reconnect'
231 o `erc-connect-function' is now `erc-server-connect-function'
233 o `erc-default-coding-system' is now `erc-server-coding-system'
235 o `erc-duplicate-timeout' is now `erc-server-duplicate-timeout'
237 o `erc-duplicates' is now `erc-server-duplicates'
239 o `erc-lag' is now `erc-server-lag'
241 o `erc-prevent-duplicates' is now `erc-server-prevent-duplicates'
243 o `erc-previous-read' is now `erc-server-filter-data'
245 o `erc-process' is now `erc-server-process'
247 o `erc-ping-handler' is now `erc-server-send-ping-handler'
249 o `erc-ping-interval' is now `erc-server-send-ping-interval'
251 *** Renamed some functions
253 o `erc-connect' is now `erc-server-connect'
255 o `erc-process-filter' is now `erc-server-filter-function'
257 o `erc-send-command' is now `erc-server-send'
259 o `erc-send-single-line' is now `erc-send-input'
261 o `erc-setup-periodical-server-ping' is now
262 `erc-server-setup-periodical-server-ping'
264 o `erc-split-command is now `erc-split-line'
268 o erc-server-flood-margin, erc-server-flood-penalty: New options
269 that allow tweaking of flood control.
271 o erc-split-line-length: The maximum line length of a single
276 o erc-server-flood-last-message, erc-server-flood-queue,
277 erc-server-flood-timer: Flood control.
279 o erc-server-processing-p: Indicate when we're currently processing
282 *** Remove some options
287 ** New customization group `erc-server' for dealing with IRC servers.
289 ** ERC can now be installed by doing `make install' from the command line.
291 ** ERC now has a manual in erc.texi.
292 Type `make doc' to generate HTML and Info versions of it.
294 ** ERC no longer depends on cl.el.
295 Only the macros in cl-macs.el are used.
297 ** Fix an edge case when quitting as new messages come in.
299 ** Make flood protection toggle-able as on/off, removing the 'strict option.
301 ** If possible, re-use channel buffers when reconnecting to a server.
303 ** Text in ERC buffers is now read-only by default.
304 To get the previous behavior,
306 ** Changes and additions to modules
308 *** Auto-join (erc-autojoin.el)
310 **** Recognize the Azzurra server.
312 *** BBDB (erc-bbdb.el)
314 **** When the user types /WHOIS, ask for a record to merge to.
316 **** Store the displayed name of a BitlBee contact.
317 The new `erc-bbdb-bitlbee-name-field' option specifies the field to use
318 to store this information.
320 **** Don't prompt for a name on /JOIN or /NICK.
322 *** Button (erc-button.el)
324 **** Fix customization of `erc-button-alist'
326 **** New option `erc-button-nickname-face' determines the face to use
327 when coloring ERC nicknames.
329 *** Channel tracking (erc-track.el)
331 **** Remove channels from the modified channels list if not currently
332 connected. This should remove residue from the mode line after
335 **** Recognize buttonized text
337 *** Highlighting (erc-match.el)
339 **** Highlight current nickname by default.
341 **** Added the option of beeping when certain matches occur.
342 Add `erc-beep-on-match' to `erc-text-matched-hook' to enable
343 beeping. Set the new variable `erc-beep-match-types' which match
344 types that make beeps.
346 *** Nicklist (erc-nicklist.el)
348 **** Fix a couple of errors.
350 **** Make sure a stray mouse click doesn't trigger an error.
352 **** Insert icons from the /images directory next to nicks.
353 This indicates their away status. The location is customizable via
354 the new `erc-nicklist-icons-directory' option.
356 If you do not want these icons, set `erc-nicklist-use-icons' to nil.
358 *** Nickserv identification (erc-nickserv.el)
360 **** Recognize Azzurra and OFTC networks.
362 *** Old completion (erc-complete.el)
364 **** Disable by default.
366 *** Programmable completion (erc-pcomplete.el)
368 **** Enable by default.
370 *** Timestamps (erc-stamp.el)
372 **** On Emacs22, align right timestamps perfectly, even if variable-width
373 characters are used. If we aren't using Emacs22, move text farther
374 away from the right margin when variable-width characters are used.
375 It is considered better to misalign the stamp by a bit than to go past
378 **** Enable by default
382 *** Spell-checking (erc-spelling.el)
384 **** Use flyspell in ERC.
386 *** Viper compatibility (erc-viper.el)
388 **** Helps ERC work correctly in viper-mode.
390 * Changes in ERC 5.0.4
392 ** Fix a problem with undo in channels.
394 * Changes in ERC 5.0.3
396 ** Fix typo in the `ctcp-request-to' entry of the English catalog.
398 ** Debugging with edegug has been made easier in all of the
399 erc-with-* and with-erc* macros.
401 ** Non-ASCII character sets should be better supported when sending
402 and processing messages.
404 ** A load failure with erc-autoaway.el and Emacs21 has been fixed.
406 ** A few XEmacs warnings were fixed.
408 ** Changes and additions to modules
410 *** Backend (erc-backend.el)
412 **** Move the check for hidden messages into `erc-display-message'
413 so there isn't so much replicated code.
415 **** Add `definition-name' property to constructed symbols so that
416 `find-function' and `find-variable' will be able to locate them.
418 **** Make sure logs are inserted info the correct channel buffers.
419 There was previously an error when using `erc-insert-log-on-open' in
420 combination with autojoin to multiple channels.
422 *** Button (erc-button.el)
424 **** The layering of `erc-button-face' on other faces in ERC buffers
427 *** Channel tracking (erc-track.el)
429 **** Use optimal amount of whitespace around modified channels
430 indicator. Previously, there was an additional unnecessary space.
432 **** Fix an error that occurred when unchecked buffers existed when
435 * Changes in ERC 5.0.2
437 ** If a channel key is required for a certain channel, ERC will prompt
438 for one if `erc-prompt-for-channel-key' is non-nil.
440 ** ERC doesn't try to reconnect if the network connection is refused
441 when using `open-network-stream-nowait' as the `erc-connect-function'.
443 ** Messages from multiple servers will not go to the currently active
444 buffer. The messages from each server will be contained in the most
445 recently active channel/server buffer that corresponds with the
448 ** Some text messages were cleaned up slightly.
450 ** Button faces should no longer "cover" other faces.
452 ** Made some XEmacs compatibility fixes.
454 ** Nicknames containing a backslash are now correctly highlighted as
455 current-nick and buttonized as nicks.
457 ** `erc-server-select' doesn't offer networks without servers as a
460 ** Non-ASCII character support has been improved.
462 ** Changes and additions to modules
464 *** Menu (erc-menu.el)
466 **** You can now save logs and truncate buffers from the menu-bar.
468 * Changes in ERC 5.0.1
470 ** Narrowing in ERC buffers no longer causes formatting errors.
472 ** The BBDB module now loads correctly when customizing `erc-modules'.
474 ** The value of `erc-button-face' is now respected.
476 ** Fixed a bug which caused a read-only error during connection.
478 ** Server buffers are now tracked correctly.
479 This means that `erc-track-priority-faces-only', `erc-track-exclude',
480 and `erc-track-exclude-types' now work with server buffers.
484 ** Channel members are now stored as a hash-table.
485 `erc-server-users' and `erc-channel-users' are now hash-tables, rather
486 than alists. This significantly increases performance, especially in
487 large channels. Each channel member is stored as an `erc-server-user'
488 struct, with additional information about the channels they are on
489 stored in an `erc-channel-user' struct. Code using old alist-style
490 channel members needs to be updated to work with hash-tables.
491 This new code also removes the need for erc-members.el, which has been
494 ** The way ERC deals with input from the server has changed.
495 All server response code is now in a new file, erc-backend.el. There
496 should be no real user visible changes. There are, however, a few
497 major changes for implementers, and module writers:
499 *** The PARSED response that all handlers get called with is
500 no longer a vector, but an `erc-response' struct.
502 This means LESS MAGIC NUMBERS in the ERC source code, but a few
503 changes in how you get at parsed responses.
505 The sender is accessed via `erc-response.sender'.
507 The command is accessed via `erc-response.command'.
509 The arguments to the command (everything after the command and
510 before the colon) are accessed via `erc-response.command-args'.
511 This is a /list/ of arguments in the order they appear in the
514 The contents of the response is accessed via
515 `erc-response.contents'.
517 Should, for some reason, you want to do something with the
518 /unparsed/ response, you can get it via `erc-response.unparsed'.
520 *** The `erc-server-hook-list' mechanism is gone.
522 All server response handlers should be defined with
523 `define-erc-response-handler'. This defines functions and
524 corresponding hook variables.
526 The mapping of server commands to hook variables is no longer
527 done via `erc-event-to-hook', but through an #'equal hashtable,
528 `erc-server-responses'. In order to find a hook you do:
530 (erc-get-hook command)
532 See the docstring of `define-erc-response-handler' for more
535 *** ALL hook variables have been renamed.
537 In accordance with recommendations in the Emacs Lisp manual,
538 the hook variables are no longer called `erc-server-FOO-hook',
539 but rather `erc-server-FOO-functions'. This is to indicate
540 that the functions they call take arguments.
542 All the modules in ERC have been updated to reflect this change,
543 but external module authors should beware.
545 ** The values of `erc-mode-line-format' and `erc-header-line-format'
546 are now defined as strings to be formatted using `format-spec'.
547 `erc-mode-line-format' does not replace the whole mode-line anymore,
548 only `mode-line-buffer-identification' is set. This way, personal
549 mode-line configurations are not modified and all key bindings work as
550 expected. The process status (connecting, closed) is now shown in
553 ** Customization of ERC variables has been made easier. Variables
554 have been split into more groups for better organization.
558 o `erc-send-whitespace-lines' - Set this to send lines even if they
561 o `erc-manual-set-nick-on-bad-nick-p' - If the nickname you chose is
562 already taken or not allowed, your nick is not changed and you can
563 try again manually if this is non-nil.
565 o `erc-mode-line-away-status-format' - You can now set what is shown
566 in the mode-line when you are away.
568 o `erc-header-line-uses-help-echo-p' - The header-line now uses the
569 help-echo property. You can set this to nil to disable it.
571 o `erc-format-query-as-channel-p' - Set this to nil to have messages
572 in the query buffer formatted like private messages.
574 o `erc-show-channel-key-p' - The channel key is now shown with the
575 other channel modes in the header line. Set this to nil if you
578 o `erc-prompt-for-channel-key' - Set this if you want to be prompted
579 for the channel key (channel's mode is +k) when you call
580 `erc-join-channel' interactively.
582 o `erc-kill-server-buffer-on-quit' - If non-nil, kill the server
583 buffer automatically when you quit.
587 o `erc-join-hook' - Called when you join a channel.
589 o `erc-kick-hook' - Called when you are kicked from a channel. The
590 channel's buffer is sent as an argument to functions called from
593 o `erc-nick-changed-functions' - Whenever your nickname changes
594 successfully, the functions in this hook are run with the
595 arguments NEW-NICK and OLD-NICK.
597 ** New command /WHOAMI - Do a /WHOIS on your current nickname.
599 ** The key binding for changing channel modes is now C-c C-o.
603 o `erc-echo-notices-in-minibuffer-flag' and
604 `erc-echo-notices-in-current-buffer' - You should use
605 `erc-echo-notice-hook' and `erc-echo-notice-always-hook' instead.
607 o `erc-prompt-interactive-input' has been removed (commented out)
608 because nickname completion does not work with it.
610 o All INFO buffer-related variables and functions have been removed.
612 ** You can now disable modules by setting `erc-modules' with the
613 customization interface.
615 ** Changes and additions to modules
617 *** Autoaway (erc-autoaway.el)
619 **** New variable `erc-autoaway-no-auto-back-regexp' - Add text which,
620 when you type anything matching it, will not automatically discard
621 your away status when `erc-auto-discard-away' is non-nil.
623 *** Filling (erc-fill.el)
625 **** New variable `erc-fill-variable-maximum-indentation' - Don't
626 indent more than this many characters when indenting a message from a
627 user with a long nickname.
629 *** Goodies (erc-goodies.el)
631 **** Miscellaneous small modules have been moved from erc.el.
632 The functions erc-add-scroll-to-bottom, erc-make-read-only,
633 erc-send-distinguish-noncommands, erc-interpret-controls, erc-unmorse,
634 erc-smiley, and erc-occur, which were defined in the main erc.el file
635 have been moved to erc-goodies.el and have mostly been translated to
636 the modules scrolltobottom, readonly, noncommands, irccontrols, smiley
641 o `erc-input-line-position' - The line number to use with
642 `erc-scroll-to-bottom'.
644 o `erc-beep-p' - Beep if there is a \C-g control character in a
647 *** Channel lists (erc-list.el)
649 **** New variable `erc-chanlist-highlight-face' - A face used for
650 highlighting the current line.
652 *** Highlighting (erc-match.el)
654 **** `erc-current-nick-highlight-type' has new options: 'keyword and
657 *** Menu (erc-menu.el)
659 **** The `IRC' menu is now automatically added to `erc-mode' buffers.
661 *** Networks (erc-nets.el)
663 **** The functions for determining current network are in this file.
664 There were a couple of functions spread about in different files which
665 each had a different way of determining the current network. The
666 methods have been combined, and the big list of known networks
667 (`erc-networks-alist') is being put to use. You can access the
668 network's name by calling the new function `erc-network'. This
669 returns the name of the current network as a symbol or 'Unknown if it
670 could not determine which network it is.
672 *** Nicklist (erc-nicklist.el)
674 **** ERC has a new way of displaying nicknames in a channel.
675 The new file erc-nicklist.el defines a new command `erc-nicklist'
676 which pops up a small Emacs window showing the nicknames of all
677 members of the current channel. The implementation is not complete
678 and is rather proof-of-concept for now. The result is something a bit
679 like erc-speedbar, but not quite as invasive, and doesn't require use
682 *** Internet services / Nickserv (erc-nickserv.el)
684 **** Network detection is now taken care of by erc-nets.el.
685 The function `erc-current-network' is deprecated, use `erc-network'
686 instead. The variable `erc-networks' has been removed, use
687 `erc-networks-alist'. The network symbols used in
688 `erc-nickserv-alist' now match those in `erc-networks-alist'.
690 **** New variable `erc-nickserv-identify-mode' - Choose which method
691 to use for automatic identification: you can wait for Nickserv to ask
692 you to identify (the default), or send an identify message
693 automatically after you change your nickname.
695 *** Speedbar (erc-speedbar.el)
697 **** New variable `erc-speedbar-sort-users-type' - Sort users in a
698 channel by activity, alphabetically, or not at all.
700 *** Timestamps (erc-stamp.el)
702 **** `erc-timestamp-only-if-changed-flag' now works when
703 `erc-insert-timestamp-function' is set to 'erc-insert-timestamp-left.
705 **** New variable `erc-timestamp-intangible' - Set this to nil if
706 timestamps should not have the 'intangible property.
708 *** Channel tracking (erc-track.el)
710 **** Using faces to indicate channel activity in the modeline now works
715 o `erc-track-priority-faces-only' - Ignore changes in a channel
716 unless there is a face from the `erc-track-faces-priority-list' in
719 o `erc-track-exclude-server-buffer' - Ignore changes in the server
722 o `erc-track-position-in-mode-line' - Set the position in the
723 mode-line where modified channels are shown (only works in GNU
724 Emacs versions above 21.3).
728 ** The module system has again changed a lot. You can now customize
729 the variable `erc-modules' and define once and for all which
730 extension modules you want to use. This unfortunately may require
731 you to change your current erc initialisation code a bit, if you
732 have some existing customsations. On the other hand, this change
733 makes the configuration of extension modules a lot easier for new
734 users. In theory, you should be able to configure all aspects of
735 ERC by using the customize interface, you should no longer really
736 need to write Lisp code for trivial customizations.
738 By default, the following modules are now loaded: (pcomplete
739 netsplit fill track ring button autojoin)
741 Please use M-x customize-variable RET erc-modules RET to change the
742 default if it does not suite your needs.
744 ** THe symbol used in `erc-nickserv-passwords' for debian.org IRC servers
745 (formerly called OpenProjects, now FreeNode) has changed from
746 openprojects to freenode. You may need to update your configuration
747 for a successful automatic nickserv identification.
749 * Changes in ERC 3.0.cvs.20030119
751 ** New module erc-dcc:
753 This finally implements DCC. It requires server sockets to fully work
754 in both directions. This feature is currently only available in Emacs
755 21.3.50 (CVS). Here is a short list of what should work though.
758 * Emacs 21.2, DCC get, and accepting DCC chat offers.
759 * XEmacs 21, Only accepting DCC chat offers.
761 ** erc is switching to global-minor-modes for activation of submodules.
763 This allows you to customize such a mode and get automatic loading of
764 the module. No longer putting a lot of require statments in .emacs.
765 At least this is the long-term plan, not all modules are converted
768 ** The most important user visible change is that you now need to activate
769 erc-completion-mode, to get TAB completion. The new completion code
770 is based on pcomplete. To get the old code, manually load
771 erc-complete and bind TAB to erc-complete in erc-mode-map.
773 To activate completion on startup, put (erc-completion-mode 1) in your
776 Same applies to timestamps. You no longer need to (require
777 'erc-stamp), you can customize the variable `erc-timestamp-mode', and
778 the rest should be automatic.
780 arch-tag: 2b21b387-6cdc-4192-889c-6743cfffdcb1