(load_face_font, free_realized_face, clear_face_gcs):
[emacs.git] / etc / ERC-NEWS
blob53b595a753f3861c36abac8d1689ea87113246b5
1 ERC NEWS                                                       -*- outline -*-
3 Copyright (C) 2006, 2007  Free Software Foundation, Inc.
4 See the end of the file for license conditions.
6 * Changes in ERC 5.3
8 ** New function `erc-tls' is to be used for connecting to a server via TLS.
9 It requires the tls.el library.
11 ** The function `erc-ssl' will now always use ssl.el, even in the version
12 of ERC that comes with Emacs.
14 ** Changes and additions to modules
16 *** Channel tracking (erc-track.el)
18 If erc-track-position-in-mode-line is set to nil, the tracking
19 information won't be shown in the mode line, which is a change
20 from the previous behavior of showing it "After all other
21 information".
23 * Changes in ERC 5.2
25 ** M-x erc RET now starts ERC.
26 `erc-select' has been changed to `erc'.  `erc-select' still remains as
27 an alias of `erc'. Likewise, `erc-select-ssl' has been renamed to
28 `erc-ssl' with `erc-select-ssl' as its alias.  The function that was
29 known as `erc' is now `erc-open'.
31 ** Open query buffers by default when private messages are received.
32 The default value of `erc-auto-query' has been changed to 'bury.
34 ** New command: /RECONNECT
35 This command tries to reconnect to the current IRC server exactly
36 once.  It does not work in server buffers (throws an error before the
37 command is run), but works in query and channel buffers.
39 ** In MS-DOS environments, look for _ercrc.el rather than .ercrc.el.
41 ** Fix buggy interaction with multi-tty Emacs.
43 ** After running /QUIT, make sure that the IRC process is killed within
44 4 seconds.  Freenode, in particular, needs this at times.
46 ** If the IRC process has not responded to our PINGs within a certain
47 time, kill it and restart the connection.  See
48 `erc-server-auto-reconnect', `erc-server-reconnect-attempts',
49 `erc-server-reconnect-timeout', `erc-server-send-ping-interval', and
50 `erc-server-send-ping-timeout' to fine-tune ERC's behavior.
52 ** Avoid getting into an infinite connection loop.
53 Previously, this could happen if your nick was banned, you were using
54 Tor, incorrect information was entered, or the connection was bad.
56 ** Make ban messages less confusing.
58 ** Restore the point correctly when reconnecting to an IRC server.
60 ** Make /IGNORE and /UNIGNORE prompt to determine whether their
61 argument is a user or a regexp.  This results in less-confusing
62 behavior when trying to ignore someone who has a bracket in their
63 nick.
65 ** Make the default port "6667" rather than "ircd", because some
66 operating systems don't know what port "ircd" maps to.
68 ** Fix several bugs in erc-iswitchb (C-c C-b).
70 ** Clean up internal documentation.
71 Special thanks go to Juanma Barranquero for the thorough vetting of
72 ERC's internal documentation.
74 ** Display a more informative message when a module is not found.
76 ** Fix a bug where paths were being colored like IRC commands.
78 ** In the customize interface for `erc-modules', add the name of the module.
79 This makes it easier to find modules by name.
81 ** erc-server-send-ping-interval: Change to use a default of 30 seconds.
83 ** Some files which are included with the release of ERC 5.2 will not
84 appear in the version of ERC that is bundled with Emacs 22.  These
85 extras files may be found at:
87  o http://ftp.gnu.org/gnu/erc/erc-5.2-extras.tar.gz, or
88  o http://ftp.gnu.org/gnu/erc/erc-5.2-extras.zip.
90 ** Renamed files
92 Several files were renamed so as to make them distinct to users of the
93 MS-DOS operating system.
95  o erc-autojoin.el -> erc-join.el
96  o erc-complete.el -> erc-hecomplete.el
97  o erc-nickserv.el -> erc-services.el
98  o ChangeLog.NNNN -> ChangeLog.NN
100 ** Header line changes
102 *** Remove "[IRC]" from the header line.
104 *** Add the %l format character to `erc-header-line-format',
106 *** Document how to remove the header line.
107 Namely: (setq erc-header-line-format nil).
109 ** New options
111 *** erc-server-reconnect-attempts: Determines the number of
112 reconnection attempts that ERC will make per server.
114 *** erc-server-reconnect-timeout: Determines the amount of time,
115 in seconds, that ERC will wait between successive reconnect attempts.
117 *** erc-server-send-ping-timeout: Determines when to consider a connection
118 stalled and restart it.  The default is after 120 seconds.
120 *** erc-system-name: Determines the system name to use when logging in.
121 The default is to figure this out by calling `system-name'.
123 ** New face: `erc-my-nick-face'
124 This helps make it easier to distinguish messages sent by yourself
125 from messages sent by other users when the value of the variable
126 `erc-show-my-nick' is non-nil.
128 ** Namespace changes
130 *** New macro: `erc-with-server-buffer'
131 Switches to the current ERC server buffer and runs some code.  If no
132 server buffer is available, return nil.  This is a useful way to
133 access variables in the server buffer.
135 *** New function: `erc-open-server-buffer-p'
136 Returns non-nil if the given buffer is an ERC server buffer that has
137 an open IRC process.
139 *** New function: `erc-format-lag-time'
140 Returns the estimated lag time to server, `erc-server-lag'.
142 *** Renamed items
144  o `erc-server-setup-periodical-server-ping' is now
145    `erc-server-setup-periodical-ping'
147  o `erc-away-p' is now `erc-away-time'
149 ** Changes to the ERC manual
151 *** New section: Sample Session.
152 Describes a sample ERC session for connecting to the #emacs channel on
153 Freenode.  Also mention the #erc channel.
155 *** New section: Special Features.
156 Describes some of the special features of ERC.
158 *** Getting Started: Mention ~/.emacs.d/.ercrc.el and the Customize
159 interface.
161 *** Development: Mention ErcDevelopment page on emacswiki.org.
163 *** Tips and Tricks: Remove empty section for now.
165 *** Options: Mention how to see available ERC options.
167 *** Sample Configuration: Add an example of how to configure ERC.
169 ** New modules
171 *** Autoaway (erc-autoaway.el)
173 **** Make this much more reliable.
175 **** Avoid duplicate messages when coming back from being away.
177 **** Fix bug where autoaway was enabled just by loading the file.
179 *** BBDB (erc-bbdb.el)
181 **** Display information on how to cancel merging of info or how to
182 create a new John Doe record.
184 **** Make it so that information from /whois continues to come in, even
185 while prompting for a record to merge.
187 **** Make hitting C-g correctly abort merging the record.
189 *** Capab identify (erc-capab.el)
190 Mark users who haven't identified to NickServ on servers supporting
191 CAPAB IDENTIFY-MSG.
193 ** Changes and additions to modules
195 *** Button (erc-button.el)
197 **** Make <backtab> go to the previous button.
199 *** Channel tracking (erc-track.el)
201 **** Use mouse-face and help-echo for channel names in the mode-line.
202 This helps people using a mouse know that they are buttons and can be
203 clicked on.
205 **** Fix issue where C-c C-SPC could conflict with user-defined keybindings.
206 This is accomplished by moving these bindings to their own global
207 minor mode.  Now the default is to check whether the user has bound
208 something to C-c C-SPC or C-c C-@.  If they have, prompt them about
209 whether to really override that binding.  This also has the effect of
210 preventing ERC from clobbering rcirc's keybinding, unless this is
211 desired.  See `erc-track-enable-keybindings' for more details.
213 **** New option: erc-track-enable-keybindings.
214 Determine whether or not to enable the C-c C-SPC and C-c C-@
215 keybindings.  The default is to ask whether to do this if a binding to
216 these keys already exists.  It can also be set to t or nil to always
217 bind or never bind, respectively.
219 **** Remove `track-when-inactive' module.
220 See `erc-track-when-inactive' for further details.
222 **** New option: erc-track-when-inactive.
223 This option replaces the track-when-inactive module.  Set it to
224 non-nil to track activity even in visible buffers when inactive.  The
225 default is nil.
227 **** Remove the `track-modified-channels' alias for the `track' module.
229 *** DCC support (erc-dcc.el)
231 **** Add Usage section to Commentary.
233 **** Fix a bug in the server message output.
235 *** Filling (erc-fill.el)
237 **** Fix bug involving messages that start with one or more blank lines.
239 *** Identd (erc-identd.el)
241 **** New option `erc-identd-port'
242 Specifies the port to use if none is given as an argument to
243 `erc-identd-start'.  This is placed in the new customization group
244 `erc-identd'.
246 **** New function: `erc-identd-quickstart'
247 Ignores any arguments and calls `erc-identd-start'.
249 *** Channel lists (erc-list.el)
251 **** Enable by default, except in the version of ERC bundled with Emacs 22.
253 *** Logging (erc-log.el)
255 **** Make sure filenames are safe to use before writing to them.
257 **** Save all log buffers when exiting Emacs.
259 **** erc-generate-log-file-name-function: Add option for
260 `erc-generate-log-file-name-network', which is a new function that
261 uses the network name rather than the server name when possible.
263 *** Menu (erc-menu.el)
265 **** Name the menu "ERC" instead of "IRC" to avoid confusion with rcirc
266 and other clients.
268 **** Make this into a proper module and load it by default.
270 **** Add "Current channel" submenu.
272 *** Networks (erc-networks.el)
274 **** Add support for Ars OpenIRC, LinuxChix, and OFTC networks.
276 **** Escape periods in Konfido.Net and Kewl.Org.
278 *** Internet services / Nickserv (erc-nickserv.el)
280 **** Add new 'both method for the `erc-nickserv-identify-mode' option
281 and make it the default.  This tries to do the right thing both when a
282 known nickserv message exists for an IRC network, and when it does
283 not.
285 **** Support nickserv authentication on OFTC, Azzurra, Ars, and QuakeNet.
287 **** Support authentication on BitlBee.
289 **** Make source code easier to understand by using accessor functions.
291 *** Sound support (erc-sound.el)
293 **** Make this work with both Emacs 21 and Emacs 22.
295 *** Timestamps (erc-stamp.el)
297 **** Exclude the newline from the erc-timestamp field.
299 **** New function: `erc-toggle-timestamps'.
300 Toggles display of timestamps.
302 * Changes in ERC 5.1.4
304 ** Make find-function and find-variable work in Emacs 22 for
305 names that are constructed by `define-erc-module'.
307 ** Fix bug introduced in ERC 5.1.3 that caused messages to go the
308 wrong buffer.
310 ** Changes and additions to modules
312 *** Highlighting (erc-match.el)
314 **** Don't activate view-mode.
316 *** Logging (erc-log.el)
318 **** When this module is activated, make sure logging is enabled on
319 already-opened buffers.  Ditto for disabling logging when the module
320 is deactivated.
322 **** Fix some errors that occur when exiting Emacs without first
323 quitting open IRC servers.
325 * Changes in ERC 5.1.3
327 ** Fix use of /quote command with no initial whitespace.
329 ** Make it possible to customize the colorization of the header line.
330 The `erc-header-line' face is used to color the header line.
331 The `erc-header-line-face-method' determines the method to use when
332 colorizing the header line.
334 ** Add the new function `erc-handle-irc-url', which is a suitable
335 candidate to use for `url-irc-function'.  This permits some
336 integration of url.el and ERC.
338 ** Fix several errors that occur when server or channel buffers are killed
339 prematurely.
341 ** Fix toggling of flood control.
343 ** Match the patterns in `erc-encoding-coding-alist' as regexps,
344 instead of verbatim text.  Also, match case-insensitively.
346 ** The /SMV command has been removed, since we no longer have
347 meaningful module-specific version information.
349 ** Fix a "(stringp nil)" error that can happen when doing /PART.
351 ** Use a better example in the `erc-part-reason-various-alist'
352 documentation.
354 ** When using `erc-quit-reason-various' and `erc-part-reason-various'
355 and no matches are found, default to using the ERC version string
356 rather than "nil".
358 ** Add the `list' and `page' modules to the `erc-modules' customize
359 interface.
361 ** Changes to the ERC manual
363 *** Update the list of available modules.
365 *** Revise information about releases and development.
367 *** Provide a simpler example in the "Getting Started" chapter.
369 *** Fully document how to connect to an IRC server in the new
370 "Connecting" chapter.
372 ** Changes and additions to modules
374 *** Autoaway (erc-autoaway.el)
376 **** Rename the `erc-autoaway-use-emacs-idle' option to
377 `erc-autoaway-idle-method'.
379 **** Add support for autoaway based on user idle time.
380 This is now the default.
382 **** If you set the AWAY status yourself, erc-autoaway will not
383 interfere by un-setting AWAY prematurely.
385 **** If you are set away while visiting a non-ERC buffer,
386 erc-autoaway used to fail in bringing the user back.  This is now
387 fixed.
389 *** BBDB (erc-bbdb.el)
391 **** Add new option `erc-bbdb-electric-p', which determines whether
392 to make the BBDB buffer electric.  This defaults to not electric.
394 *** Button (erc-button.el)
396 **** Use <backtab> instead of <C-tab> for `erc-button-previous'.
398 *** Identd (erc-identd.el)
400 **** Fix a bug that involves starting the identd server.
402 **** Make this work with Emacs 22.
404 **** Provide a real ERC module named `identd'.
406 **** Don't create an extra buffer for the identd process.
408 *** Channel lists (erc-list.el)
410 **** Enable by default, except in the version of ERC bundled with Emacs 22.
412 *** Logging (erc-log.el)
414 **** By default, don't insert old logs when opening an ERC buffer.
415 This may be changed by customizing `erc-log-insert-log-on-open'.
417 **** New option `erc-log-write-after-send' determines whether the
418 log file will be written to after every sent message.  The default is
419 not to do this.
421 **** New option `erc-log-write-after-insert' determines whether the
422 log file will be written to when new text is added to a logged ERC
423 buffer.  The default is not to do this.  With this option and the
424 previous option, logging should no longer slow down ERC as much.
426 **** Default to saving buffers and queries on quit.
427 This may be changed by customizing the `erc-save-buffer-on-quit' and
428 `erc-save-queries-on-quit' options, respectively.
430 **** Only perform logging when the `logging' module is added to
431 `erc-modules'.  This prevents logging from being activated just by
432 loading the erc-log.el file, and makes logging act like other ERC
433 modules.
435 *** Programmable completion (erc-pcomplete.el)
437 **** Don't complete the user's current nickname.
439 * Changes in ERC 5.1.2
441 ** Fix compiler errors in erc-autojoin.el and erc-dcc.el.
443 ** Move to end of prompt when ERC reconnects to a server.
445 ** Changes and additions to modules
447 *** Spell-checking (erc-spelling.el)
449 **** Don't spell-check nicks or words that are prefixed with '/'.
451 **** Remove flyspell properties from words we shouldn't spell-check.
453 **** Fix an issue that caused the ispell process to reload every time
454 we switch to an ERC buffer.
456 *** Timestamps (erc-stamp.el)
458 **** Fix an inconsistency in calculating width of right timestamps.
460 **** Rename option `erc-timestamp-right-align-by-pixel' to
461 `erc-timestamp-use-align-to'.  This controls whether to use the more
462 fail-proof method of aligning right timestamps, as mentioned below.
464 **** Fix a right timestamp spacing problem that used to occur when
465 erc-stamp.el was byte-compiled.  Now that this is fixed, it is safe to
466 use the method that aligns right timestamps perfectly in Emacs22 with
467 X.  If the current version of Emacs doesn't support this method, use
468 the simpler method, which is prone to alignment issues for math
469 symbols and other variable-width text.
471 A side effect of using this new method is that there will only be one
472 space before a right timestamp in any saved logs.  If this is
473 unacceptable, set `erc-timestamp-use-align-to' to nil.
475 * Changes in ERC 5.1.1
477 ** Fix a requirement on cl.el.
479 ** Use tls.el for SSL connections, rather than ssl.el.
481 ** Changes and additions to modules
483 *** ibuffer integration (erc-ibuffer.el)
485 **** Update this to work with the version of ibuffer.el that comes with
486 recent Emacs variants.
488 *** Old completion (erc-complete.el)
490 **** Fix a few errors.
492 *** Speedbar (erc-speedbar.el)
494 **** Make this work with the version of speedbar.el that comes with
495 recent Emacs variants.
497 *** Timestamps (erc-stamp.el)
499 **** By default, use a more failsafe method of displaying right timestamps.
500 To get right timestamps to align perfectly in Emacs22 using X, set the
501 new `erc-timestamp-right-align-by-pixel' option to non-nil.
503 *** Viper compatibility (erc-viper.el)
505 **** Since most of these changes are now merged into Emacs22, detect
506 whether we need these changes and install them only if necessary.
508 * Changes in ERC 5.1
510 ** Improve XEmacs compatibility.
512 ** Namespace changes
514 *** Now ERC doesn't use global variable space.
515 Renamed all variables that didn't start with "erc-".
517   o `away' is now `erc-away'
519   o `current-nick' is now `erc-server-current-nick'
521   o `last-peers' is now `erc-server-last-peers'
523   o `last-ping-time' is now `erc-server-last-ping-time'
525   o `last-sent-time' is now `erc-server-last-sent-time'
527   o `lines-sent' is now `erc-server-lines-sent'
529   o `quitting' is now `erc-server-quitting'
531 *** Remove the `with-erc-channel-buffer' function.
533 ** Bugfixes
535 *** Don't inadvertently destroy face properties.
537 *** Load erc scripts in a safer way.
539 *** Don't insert a timestamp if text at point is invisible.
541 *** Don't hide messages from those in `erc-fools' by default.
542 Color their nicks instead.
544 *** Use a more foolproof method of encoding and decoding strings
545 before sending to a channel.
547 ** Backend changes
549 *** Renamed some server-specific variables
551   o `erc-announced-server-name' is now `erc-server-announced-name'
553   o `erc-auto-reconnect' is now `erc-server-auto-reconnect'
555   o `erc-connect-function' is now `erc-server-connect-function'
557   o `erc-default-coding-system' is now `erc-server-coding-system'
559   o `erc-duplicate-timeout' is now `erc-server-duplicate-timeout'
561   o `erc-duplicates' is now `erc-server-duplicates'
563   o `erc-lag' is now `erc-server-lag'
565   o `erc-prevent-duplicates' is now `erc-server-prevent-duplicates'
567   o `erc-previous-read' is now `erc-server-filter-data'
569   o `erc-process' is now `erc-server-process'
571   o `erc-ping-handler' is now `erc-server-send-ping-handler'
573   o `erc-ping-interval' is now `erc-server-send-ping-interval'
575 *** Renamed some functions
577   o `erc-connect' is now `erc-server-connect'
579   o `erc-process-filter' is now `erc-server-filter-function'
581   o `erc-send-command' is now `erc-server-send'
583   o `erc-send-single-line' is now `erc-send-input'
585   o `erc-setup-periodical-server-ping' is now
586     `erc-server-setup-periodical-server-ping'
588   o `erc-split-command is now `erc-split-line'
590 *** New options
592   o erc-server-flood-margin, erc-server-flood-penalty: New options
593     that allow tweaking of flood control.
595   o erc-split-line-length: The maximum line length of a single
596     message.
598 *** New variables
600   o erc-server-flood-last-message, erc-server-flood-queue,
601     erc-server-flood-timer: Flood control.
603   o erc-server-processing-p: Indicate when we're currently processing
604     a message.
606 *** Remove some options
608   o `erc-flood-limit'
609   o `erc-flood-limit2'
611 ** New customization group `erc-server' for dealing with IRC servers.
613 ** ERC can now be installed by doing `make install' from the command line.
615 ** ERC now has a manual in erc.texi.
616 Type `make doc' to generate HTML and Info versions of it.
618 ** ERC no longer depends on cl.el.
619 Only the macros in cl-macs.el are used.
621 ** Fix an edge case when quitting as new messages come in.
623 ** Make flood protection toggle-able as on/off, removing the 'strict option.
625 ** If possible, re-use channel buffers when reconnecting to a server.
627 ** Text in ERC buffers is now read-only by default.
628 To get the previous behavior, 
630 ** Changes and additions to modules
632 *** Auto-join (erc-autojoin.el)
634 **** Recognize the Azzurra server.
636 *** BBDB (erc-bbdb.el)
638 **** When the user types /WHOIS, ask for a record to merge to.
640 **** Store the displayed name of a BitlBee contact.
641 The new `erc-bbdb-bitlbee-name-field' option specifies the field to use
642 to store this information.
644 **** Don't prompt for a name on /JOIN or /NICK.
646 *** Button (erc-button.el)
648 **** Fix customization of `erc-button-alist'
650 **** New option `erc-button-nickname-face' determines the face to use
651 when coloring ERC nicknames.
653 *** Channel tracking (erc-track.el)
655 **** Remove channels from the modified channels list if not currently
656 connected.  This should remove residue from the mode line after
657 quitting ERC.
659 **** Recognize buttonized text
661 *** Highlighting (erc-match.el)
663 **** Highlight current nickname by default.
665 **** Added the option of beeping when certain matches occur.
666 Add `erc-beep-on-match' to `erc-text-matched-hook' to enable
667 beeping.  Set the new variable `erc-beep-match-types' which match
668 types that make beeps.
670 *** Nicklist (erc-nicklist.el)
672 **** Fix a couple of errors.
674 **** Make sure a stray mouse click doesn't trigger an error.
676 **** Insert icons from the /images directory next to nicks.
677 This indicates their away status.  The location is customizable via
678 the new `erc-nicklist-icons-directory' option.
680 If you do not want these icons, set `erc-nicklist-use-icons' to nil.
682 *** Nickserv identification (erc-nickserv.el)
684 **** Recognize Azzurra and OFTC networks.
686 *** Old completion (erc-complete.el)
688 **** Disable by default.
690 *** Programmable completion (erc-pcomplete.el)
692 **** Enable by default.
694 *** Timestamps (erc-stamp.el)
696 **** On Emacs22, align right timestamps perfectly, even if variable-width
697 characters are used.  If we aren't using Emacs22, move text farther
698 away from the right margin when variable-width characters are used.
699 It is considered better to misalign the stamp by a bit than to go past
700 the right margin.
702 **** Enable by default
704 ** New modules
706 *** Spell-checking (erc-spelling.el)
708 **** Use flyspell in ERC.
710 *** Viper compatibility (erc-viper.el)
712 **** Helps ERC work correctly in viper-mode.
714 * Changes in ERC 5.0.4
716 ** Fix a problem with undo in channels.
718 * Changes in ERC 5.0.3
720 ** Fix typo in the `ctcp-request-to' entry of the English catalog.
722 ** Debugging with edegug has been made easier in all of the
723 erc-with-* and with-erc* macros.
725 ** Non-ASCII character sets should be better supported when sending
726 and processing messages.
728 ** A load failure with erc-autoaway.el and Emacs21 has been fixed.
730 ** A few XEmacs warnings were fixed.
732 ** Changes and additions to modules
734 *** Backend (erc-backend.el)
736 **** Move the check for hidden messages into `erc-display-message'
737 so there isn't so much replicated code.
739 **** Add `definition-name' property to constructed symbols so that
740 `find-function' and `find-variable' will be able to locate them.
742 **** Make sure logs are inserted info the correct channel buffers.
743 There was previously an error when using `erc-insert-log-on-open' in
744 combination with autojoin to multiple channels.
746 *** Button (erc-button.el)
748 **** The layering of `erc-button-face' on other faces in ERC buffers
749 has been improved.
751 *** Channel tracking (erc-track.el)
753 **** Use optimal amount of whitespace around modified channels
754 indicator.  Previously, there was an additional unnecessary space.
756 **** Fix an error that occurred when unchecked buffers existed when
757 invoking /QUIT.
759 * Changes in ERC 5.0.2
761 ** If a channel key is required for a certain channel, ERC will prompt
762 for one if `erc-prompt-for-channel-key' is non-nil.
764 ** ERC doesn't try to reconnect if the network connection is refused
765 when using `open-network-stream-nowait' as the `erc-connect-function'.
767 ** Messages from multiple servers will not go to the currently active
768 buffer.  The messages from each server will be contained in the most
769 recently active channel/server buffer that corresponds with the
770 server.
772 ** Some text messages were cleaned up slightly.
774 ** Button faces should no longer "cover" other faces.
776 ** Made some XEmacs compatibility fixes.
778 ** Nicknames containing a backslash are now correctly highlighted as
779 current-nick and buttonized as nicks.
781 ** `erc-server-select' doesn't offer networks without servers as a
782 choice anymore.
784 ** Non-ASCII character support has been improved.
786 ** Changes and additions to modules
788 *** Menu (erc-menu.el)
790 **** You can now save logs and truncate buffers from the menu-bar.
792 * Changes in ERC 5.0.1
794 ** Narrowing in ERC buffers no longer causes formatting errors.
796 ** The BBDB module now loads correctly when customizing `erc-modules'.
798 ** The value of `erc-button-face' is now respected.
800 ** Fixed a bug which caused a read-only error during connection.
802 ** Server buffers are now tracked correctly.
803 This means that `erc-track-priority-faces-only', `erc-track-exclude',
804 and `erc-track-exclude-types' now work with server buffers.
806 * Changes in ERC 5.0
808 ** Channel members are now stored as a hash-table.
809 `erc-server-users' and `erc-channel-users' are now hash-tables, rather
810 than alists.  This significantly increases performance, especially in
811 large channels.  Each channel member is stored as an `erc-server-user'
812 struct, with additional information about the channels they are on
813 stored in an `erc-channel-user' struct.  Code using old alist-style
814 channel members needs to be updated to work with hash-tables.
815 This new code also removes the need for erc-members.el, which has been
816 removed.
818 ** The way ERC deals with input from the server has changed.
819 All server response code is now in a new file, erc-backend.el.  There
820 should be no real user visible changes.  There are, however, a few
821 major changes for implementers, and module writers:
823 *** The PARSED response that all handlers get called with is
824     no longer a vector, but an `erc-response' struct.
826     This means LESS MAGIC NUMBERS in the ERC source code, but a few
827     changes in how you get at parsed responses.
829     The sender is accessed via `erc-response.sender'.
831     The command is accessed via `erc-response.command'.
833     The arguments to the command (everything after the command and
834     before the colon) are accessed via `erc-response.command-args'.
835     This is a /list/ of arguments in the order they appear in the
836     unparsed response.
838     The contents of the response is accessed via
839     `erc-response.contents'.
841     Should, for some reason, you want to do something with the
842     /unparsed/ response, you can get it via `erc-response.unparsed'.
844 *** The `erc-server-hook-list' mechanism is gone.
846     All server response handlers should be defined with
847     `define-erc-response-handler'.  This defines functions and
848     corresponding hook variables.
850     The mapping of server commands to hook variables is no longer
851     done via `erc-event-to-hook', but through an #'equal hashtable,
852     `erc-server-responses'.  In order to find a hook you do:
854     (erc-get-hook command)
856     See the docstring of `define-erc-response-handler' for more
857     information.
859 *** ALL hook variables have been renamed.
861     In accordance with recommendations in the Emacs Lisp manual,
862     the hook variables are no longer called `erc-server-FOO-hook',
863     but rather `erc-server-FOO-functions'.  This is to indicate
864     that the functions they call take arguments.
866     All the modules in ERC have been updated to reflect this change,
867     but external module authors should beware.
869 ** The values of `erc-mode-line-format' and `erc-header-line-format'
870 are now defined as strings to be formatted using `format-spec'.
871 `erc-mode-line-format' does not replace the whole mode-line anymore,
872 only `mode-line-buffer-identification' is set.  This way, personal
873 mode-line configurations are not modified and all key bindings work as
874 expected.  The process status (connecting, closed) is now shown in
875 `mode-line-process'.
877 ** Customization of ERC variables has been made easier.  Variables
878 have been split into more groups for better organization.
880 ** New variables
882   o `erc-send-whitespace-lines' - Set this to send lines even if they
883     are empty.
885   o `erc-manual-set-nick-on-bad-nick-p' - If the nickname you chose is
886     already taken or not allowed, your nick is not changed and you can
887     try again manually if this is non-nil.
889   o `erc-mode-line-away-status-format' - You can now set what is shown
890     in the mode-line when you are away.
892   o `erc-header-line-uses-help-echo-p' - The header-line now uses the
893     help-echo property. You can set this to nil to disable it.
895   o `erc-format-query-as-channel-p' - Set this to nil to have messages
896     in the query buffer formatted like private messages.
898   o `erc-show-channel-key-p' - The channel key is now shown with the
899     other channel modes in the header line. Set this to nil if you
900     want it hidden.
902   o `erc-prompt-for-channel-key' - Set this if you want to be prompted
903     for the channel key (channel's mode is +k) when you call
904     `erc-join-channel' interactively.
906   o `erc-kill-server-buffer-on-quit' - If non-nil, kill the server
907     buffer automatically when you quit.
909 ** New hooks
911   o `erc-join-hook' - Called when you join a channel.
913   o `erc-kick-hook' - Called when you are kicked from a channel. The
914     channel's buffer is sent as an argument to functions called from
915     this hook.
917   o `erc-nick-changed-functions' - Whenever your nickname changes
918     successfully, the functions in this hook are run with the
919     arguments NEW-NICK and OLD-NICK.
921 ** New command /WHOAMI - Do a /WHOIS on your current nickname.
923 ** The key binding for changing channel modes is now C-c C-o.
925 ** Removed variables
927   o `erc-echo-notices-in-minibuffer-flag' and
928     `erc-echo-notices-in-current-buffer' - You should use
929     `erc-echo-notice-hook' and `erc-echo-notice-always-hook' instead.
931   o `erc-prompt-interactive-input' has been removed (commented out)
932     because nickname completion does not work with it.
934   o All INFO buffer-related variables and functions have been removed.
936 ** You can now disable modules by setting `erc-modules' with the
937 customization interface.
939 ** Changes and additions to modules
941 *** Autoaway (erc-autoaway.el)
943 **** New variable `erc-autoaway-no-auto-back-regexp' - Add text which,
944 when you type anything matching it, will not automatically discard
945 your away status when `erc-auto-discard-away' is non-nil.
947 *** Filling (erc-fill.el)
949 **** New variable `erc-fill-variable-maximum-indentation' - Don't
950 indent more than this many characters when indenting a message from a
951 user with a long nickname.
953 *** Goodies (erc-goodies.el)
955 **** Miscellaneous small modules have been moved from erc.el.
956 The functions erc-add-scroll-to-bottom, erc-make-read-only,
957 erc-send-distinguish-noncommands, erc-interpret-controls, erc-unmorse,
958 erc-smiley, and erc-occur, which were defined in the main erc.el file
959 have been moved to erc-goodies.el and have mostly been translated to
960 the modules scrolltobottom, readonly, noncommands, irccontrols, smiley
961 and unmorse.
963 **** New variables
965   o `erc-input-line-position' - The line number to use with
966     `erc-scroll-to-bottom'.
968   o `erc-beep-p' - Beep if there is a \C-g control character in a
969     message.
971 *** Channel lists (erc-list.el)
973 **** New variable `erc-chanlist-highlight-face' - A face used for
974 highlighting the current line.
976 *** Highlighting (erc-match.el)
978 **** `erc-current-nick-highlight-type' has new options: 'keyword and
979 'nick-or-keyword.
981 *** Menu (erc-menu.el)
983 **** The `IRC' menu is now automatically added to `erc-mode' buffers.
985 *** Networks (erc-nets.el)
987 **** The functions for determining current network are in this file.
988 There were a couple of functions spread about in different files which
989 each had a different way of determining the current network.  The
990 methods have been combined, and the big list of known networks
991 (`erc-networks-alist') is being put to use.  You can access the
992 network's name by calling the new function `erc-network'.  This
993 returns the name of the current network as a symbol or 'Unknown if it
994 could not determine which network it is.
996 *** Nicklist (erc-nicklist.el)
998 **** ERC has a new way of displaying nicknames in a channel.
999 The new file erc-nicklist.el defines a new command `erc-nicklist'
1000 which pops up a small Emacs window showing the nicknames of all
1001 members of the current channel.  The implementation is not complete
1002 and is rather proof-of-concept for now.  The result is something a bit
1003 like erc-speedbar, but not quite as invasive, and doesn't require use
1004 of a new frame.
1006 *** Internet services / Nickserv (erc-nickserv.el)
1008 **** Network detection is now taken care of by erc-nets.el.
1009 The function `erc-current-network' is deprecated, use `erc-network'
1010 instead.  The variable `erc-networks' has been removed, use
1011 `erc-networks-alist'.  The network symbols used in
1012 `erc-nickserv-alist' now match those in `erc-networks-alist'.
1014 **** New variable `erc-nickserv-identify-mode' - Choose which method
1015 to use for automatic identification: you can wait for Nickserv to ask
1016 you to identify (the default), or send an identify message
1017 automatically after you change your nickname.
1019 *** Speedbar (erc-speedbar.el)
1021 **** New variable `erc-speedbar-sort-users-type' - Sort users in a
1022 channel by activity, alphabetically, or not at all.
1024 *** Timestamps (erc-stamp.el)
1026 **** `erc-timestamp-only-if-changed-flag' now works when
1027 `erc-insert-timestamp-function' is set to 'erc-insert-timestamp-left.
1029 **** New variable `erc-timestamp-intangible' - Set this to nil if
1030 timestamps should not have the 'intangible property.
1032 *** Channel tracking (erc-track.el)
1034 **** Using faces to indicate channel activity in the modeline now works
1035 in XEmacs.
1037 **** New variables
1039   o `erc-track-priority-faces-only' - Ignore changes in a channel
1040     unless there is a face from the `erc-track-faces-priority-list' in
1041     the message.
1043   o `erc-track-exclude-server-buffer' - Ignore changes in the server
1044     buffer.
1046   o `erc-track-position-in-mode-line' - Set the position in the
1047     mode-line where modified channels are shown (only works in GNU
1048     Emacs versions above 21.3).
1050 * Changes in ERC 4.0
1052 ** The module system has again changed a lot.  You can now customize
1053   the variable `erc-modules' and define once and for all which
1054   extension modules you want to use.  This unfortunately may require
1055   you to change your current erc initialisation code a bit, if you
1056   have some existing customsations.  On the other hand, this change
1057   makes the configuration of extension modules a lot easier for new
1058   users.  In theory, you should be able to configure all aspects of
1059   ERC by using the customize interface, you should no longer really
1060   need to write Lisp code for trivial customizations.
1062   By default, the following modules are now loaded: (pcomplete
1063   netsplit fill track ring button autojoin)
1065   Please use M-x customize-variable RET erc-modules RET to change the
1066   default if it does not suite your needs.
1068 ** THe symbol used in `erc-nickserv-passwords' for debian.org IRC servers
1069   (formerly called OpenProjects, now FreeNode) has changed from
1070   openprojects to freenode.  You may need to update your configuration
1071   for a successful automatic nickserv identification.
1073 * Changes in ERC 3.0.cvs.20030119
1075 ** New module erc-dcc:
1077 This finally implements DCC.  It requires server sockets to fully work
1078 in both directions.  This feature is currently only available in Emacs
1079 21.3.50 (CVS). Here is a short list of what should work though.
1081 ** Compatibility:
1082   * Emacs 21.2, DCC get, and accepting DCC chat offers.
1083   * XEmacs 21, Only accepting DCC chat offers.
1085 ** erc is switching to global-minor-modes for activation of submodules.
1087 This allows you to customize such a mode and get automatic loading of
1088 the module.  No longer putting a lot of require statments in .emacs.
1089 At least this is the long-term plan, not all modules are converted
1090 yet.
1092 ** The most important user visible change is that you now need to activate
1093 erc-completion-mode, to get TAB completion.  The new completion code
1094 is based on pcomplete.  To get the old code, manually load
1095 erc-complete and bind TAB to erc-complete in erc-mode-map.
1097 To activate completion on startup, put (erc-completion-mode 1) in your
1098 .emacs file.
1100 Same applies to timestamps.  You no longer need to (require
1101 'erc-stamp), you can customize the variable `erc-timestamp-mode', and
1102 the rest should be automatic.
1105 This file is part of GNU Emacs.
1107 GNU Emacs is free software; you can redistribute it and/or modify
1108 it under the terms of the GNU General Public License as published by
1109 the Free Software Foundation; either version 3, or (at your option)
1110 any later version.
1112 GNU Emacs is distributed in the hope that it will be useful,
1113 but WITHOUT ANY WARRANTY; without even the implied warranty of
1114 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1115 GNU General Public License for more details.
1117 You should have received a copy of the GNU General Public License
1118 along with GNU Emacs; see the file COPYING.  If not, write to the
1119 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
1120 Boston, MA 02110-1301, USA.
1122 arch-tag: 2b21b387-6cdc-4192-889c-6743cfffdcb1