Merge from gnus--rel--5.10
[emacs.git] / etc / ERC-NEWS
blob516c9605e094a164098051197b0b682bb6b9b463
1 ERC NEWS                                                       -*- outline -*-
3 Copyright (C) 2006, 2007, 2008  Free Software Foundation, Inc.
4 See the end of the file for license conditions.
6 * Changes in ERC 5.2
8 ** M-x erc RET now starts ERC.
9 `erc-select' has been changed to `erc'.  `erc-select' still remains as
10 an alias of `erc'. Likewise, `erc-select-ssl' has been renamed to
11 `erc-ssl' with `erc-select-ssl' as its alias.  The function that was
12 known as `erc' is now `erc-open'.
14 ** Open query buffers by default when private messages are received.
15 The default value of `erc-auto-query' has been changed to 'bury.
17 ** New command: /RECONNECT
18 This command tries to reconnect to the current IRC server exactly
19 once.  It does not work in server buffers (throws an error before the
20 command is run), but works in query and channel buffers.
22 ** In MS-DOS environments, look for _ercrc.el rather than .ercrc.el.
24 ** Fix buggy interaction with multi-tty Emacs.
26 ** After running /QUIT, make sure that the IRC process is killed within
27 4 seconds.  Freenode, in particular, needs this at times.
29 ** If the IRC process has not responded to our PINGs within a certain
30 time, kill it and restart the connection.  See
31 `erc-server-auto-reconnect', `erc-server-reconnect-attempts',
32 `erc-server-reconnect-timeout', `erc-server-send-ping-interval', and
33 `erc-server-send-ping-timeout' to fine-tune ERC's behavior.
35 ** Avoid getting into an infinite connection loop.
36 Previously, this could happen if your nick was banned, you were using
37 Tor, incorrect information was entered, or the connection was bad.
39 ** Make ban messages less confusing.
41 ** Restore the point correctly when reconnecting to an IRC server.
43 ** Make /IGNORE and /UNIGNORE prompt to determine whether their
44 argument is a user or a regexp.  This results in less-confusing
45 behavior when trying to ignore someone who has a bracket in their
46 nick.
48 ** Make the default port "6667" rather than "ircd", because some
49 operating systems don't know what port "ircd" maps to.
51 ** Fix several bugs in erc-iswitchb (C-c C-b).
53 ** Clean up internal documentation.
54 Special thanks go to Juanma Barranquero for the thorough vetting of
55 ERC's internal documentation.
57 ** Display a more informative message when a module is not found.
59 ** Fix a bug where paths were being colored like IRC commands.
61 ** In the customize interface for `erc-modules', add the name of the module.
62 This makes it easier to find modules by name.
64 ** erc-server-send-ping-interval: Change to use a default of 30 seconds.
66 ** Some files which are included with the release of ERC 5.2 will not
67 appear in the version of ERC that is bundled with Emacs 22.  These
68 extras files may be found at:
70  o http://ftp.gnu.org/gnu/erc/erc-5.2-extras.tar.gz, or
71  o http://ftp.gnu.org/gnu/erc/erc-5.2-extras.zip.
73 ** Renamed files
75 Several files were renamed so as to make them distinct to users of the
76 MS-DOS operating system.
78  o erc-autojoin.el -> erc-join.el
79  o erc-complete.el -> erc-hecomplete.el
80  o erc-nickserv.el -> erc-services.el
81  o ChangeLog.NNNN -> ChangeLog.NN
83 ** Header line changes
85 *** Remove "[IRC]" from the header line.
87 *** Add the %l format character to `erc-header-line-format',
89 *** Document how to remove the header line.
90 Namely: (setq erc-header-line-format nil).
92 ** New options
94 *** erc-server-reconnect-attempts: Determines the number of
95 reconnection attempts that ERC will make per server.
97 *** erc-server-reconnect-timeout: Determines the amount of time,
98 in seconds, that ERC will wait between successive reconnect attempts.
100 *** erc-server-send-ping-timeout: Determines when to consider a connection
101 stalled and restart it.  The default is after 120 seconds.
103 *** erc-system-name: Determines the system name to use when logging in.
104 The default is to figure this out by calling `system-name'.
106 ** New face: `erc-my-nick-face'
107 This helps make it easier to distinguish messages sent by yourself
108 from messages sent by other users when the value of the variable
109 `erc-show-my-nick' is non-nil.
111 ** Namespace changes
113 *** New macro: `erc-with-server-buffer'
114 Switches to the current ERC server buffer and runs some code.  If no
115 server buffer is available, return nil.  This is a useful way to
116 access variables in the server buffer.
118 *** New function: `erc-open-server-buffer-p'
119 Returns non-nil if the given buffer is an ERC server buffer that has
120 an open IRC process.
122 *** New function: `erc-format-lag-time'
123 Returns the estimated lag time to server, `erc-server-lag'.
125 *** Renamed items
127  o `erc-server-setup-periodical-server-ping' is now
128    `erc-server-setup-periodical-ping'
130  o `erc-away-p' is now `erc-away-time'
132 ** Changes to the ERC manual
134 *** New section: Sample Session.
135 Describes a sample ERC session for connecting to the #emacs channel on
136 Freenode.  Also mention the #erc channel.
138 *** New section: Special Features.
139 Describes some of the special features of ERC.
141 *** Getting Started: Mention ~/.emacs.d/.ercrc.el and the Customize
142 interface.
144 *** Development: Mention ErcDevelopment page on emacswiki.org.
146 *** Tips and Tricks: Remove empty section for now.
148 *** Options: Mention how to see available ERC options.
150 *** Sample Configuration: Add an example of how to configure ERC.
152 ** New modules
154 *** Autoaway (erc-autoaway.el)
156 **** Make this much more reliable.
158 **** Avoid duplicate messages when coming back from being away.
160 **** Fix bug where autoaway was enabled just by loading the file.
162 *** BBDB (erc-bbdb.el)
164 **** Display information on how to cancel merging of info or how to
165 create a new John Doe record.
167 **** Make it so that information from /whois continues to come in, even
168 while prompting for a record to merge.
170 **** Make hitting C-g correctly abort merging the record.
172 *** Capab identify (erc-capab.el)
173 Mark users who haven't identified to NickServ on servers supporting
174 CAPAB IDENTIFY-MSG.
176 ** Changes and additions to modules
178 *** Button (erc-button.el)
180 **** Make <backtab> go to the previous button.
182 *** Channel tracking (erc-track.el)
184 **** Use mouse-face and help-echo for channel names in the mode-line.
185 This helps people using a mouse know that they are buttons and can be
186 clicked on.
188 **** Fix issue where C-c C-SPC could conflict with user-defined keybindings.
189 This is accomplished by moving these bindings to their own global
190 minor mode.  Now the default is to check whether the user has bound
191 something to C-c C-SPC or C-c C-@.  If they have, prompt them about
192 whether to really override that binding.  This also has the effect of
193 preventing ERC from clobbering rcirc's keybinding, unless this is
194 desired.  See `erc-track-enable-keybindings' for more details.
196 **** New option: erc-track-enable-keybindings.
197 Determine whether or not to enable the C-c C-SPC and C-c C-@
198 keybindings.  The default is to ask whether to do this if a binding to
199 these keys already exists.  It can also be set to t or nil to always
200 bind or never bind, respectively.
202 **** Remove `track-when-inactive' module.
203 See `erc-track-when-inactive' for further details.
205 **** New option: erc-track-when-inactive.
206 This option replaces the track-when-inactive module.  Set it to
207 non-nil to track activity even in visible buffers when inactive.  The
208 default is nil.
210 **** Remove the `track-modified-channels' alias for the `track' module.
212 *** DCC support (erc-dcc.el)
214 **** Add Usage section to Commentary.
216 **** Fix a bug in the server message output.
218 *** Filling (erc-fill.el)
220 **** Fix bug involving messages that start with one or more blank lines.
222 *** Identd (erc-identd.el)
224 **** New option `erc-identd-port'
225 Specifies the port to use if none is given as an argument to
226 `erc-identd-start'.  This is placed in the new customization group
227 `erc-identd'.
229 **** New function: `erc-identd-quickstart'
230 Ignores any arguments and calls `erc-identd-start'.
232 *** Channel lists (erc-list.el)
234 **** Enable by default, except in the version of ERC bundled with Emacs 22.
236 *** Logging (erc-log.el)
238 **** Make sure filenames are safe to use before writing to them.
240 **** Save all log buffers when exiting Emacs.
242 **** erc-generate-log-file-name-function: Add option for
243 `erc-generate-log-file-name-network', which is a new function that
244 uses the network name rather than the server name when possible.
246 *** Menu (erc-menu.el)
248 **** Name the menu "ERC" instead of "IRC" to avoid confusion with rcirc
249 and other clients.
251 **** Make this into a proper module and load it by default.
253 **** Add "Current channel" submenu.
255 *** Networks (erc-networks.el)
257 **** Add support for Ars OpenIRC, LinuxChix, and OFTC networks.
259 **** Escape periods in Konfido.Net and Kewl.Org.
261 *** Internet services / Nickserv (erc-nickserv.el)
263 **** Add new 'both method for the `erc-nickserv-identify-mode' option
264 and make it the default.  This tries to do the right thing both when a
265 known nickserv message exists for an IRC network, and when it does
266 not.
268 **** Support nickserv authentication on OFTC, Azzurra, Ars, and QuakeNet.
270 **** Support authentication on BitlBee.
272 **** Make source code easier to understand by using accessor functions.
274 *** Sound support (erc-sound.el)
276 **** Make this work with both Emacs 21 and Emacs 22.
278 *** Timestamps (erc-stamp.el)
280 **** Exclude the newline from the erc-timestamp field.
282 **** New function: `erc-toggle-timestamps'.
283 Toggles display of timestamps.
285 * Changes in ERC 5.1.4
287 ** Make find-function and find-variable work in Emacs 22 for
288 names that are constructed by `define-erc-module'.
290 ** Fix bug introduced in ERC 5.1.3 that caused messages to go the
291 wrong buffer.
293 ** Changes and additions to modules
295 *** Highlighting (erc-match.el)
297 **** Don't activate view-mode.
299 *** Logging (erc-log.el)
301 **** When this module is activated, make sure logging is enabled on
302 already-opened buffers.  Ditto for disabling logging when the module
303 is deactivated.
305 **** Fix some errors that occur when exiting Emacs without first
306 quitting open IRC servers.
308 * Changes in ERC 5.1.3
310 ** Fix use of /quote command with no initial whitespace.
312 ** Make it possible to customize the colorization of the header line.
313 The `erc-header-line' face is used to color the header line.
314 The `erc-header-line-face-method' determines the method to use when
315 colorizing the header line.
317 ** Add the new function `erc-handle-irc-url', which is a suitable
318 candidate to use for `url-irc-function'.  This permits some
319 integration of url.el and ERC.
321 ** Fix several errors that occur when server or channel buffers are killed
322 prematurely.
324 ** Fix toggling of flood control.
326 ** Match the patterns in `erc-encoding-coding-alist' as regexps,
327 instead of verbatim text.  Also, match case-insensitively.
329 ** The /SMV command has been removed, since we no longer have
330 meaningful module-specific version information.
332 ** Fix a "(stringp nil)" error that can happen when doing /PART.
334 ** Use a better example in the `erc-part-reason-various-alist'
335 documentation.
337 ** When using `erc-quit-reason-various' and `erc-part-reason-various'
338 and no matches are found, default to using the ERC version string
339 rather than "nil".
341 ** Add the `list' and `page' modules to the `erc-modules' customize
342 interface.
344 ** Changes to the ERC manual
346 *** Update the list of available modules.
348 *** Revise information about releases and development.
350 *** Provide a simpler example in the "Getting Started" chapter.
352 *** Fully document how to connect to an IRC server in the new
353 "Connecting" chapter.
355 ** Changes and additions to modules
357 *** Autoaway (erc-autoaway.el)
359 **** Rename the `erc-autoaway-use-emacs-idle' option to
360 `erc-autoaway-idle-method'.
362 **** Add support for autoaway based on user idle time.
363 This is now the default.
365 **** If you set the AWAY status yourself, erc-autoaway will not
366 interfere by un-setting AWAY prematurely.
368 **** If you are set away while visiting a non-ERC buffer,
369 erc-autoaway used to fail in bringing the user back.  This is now
370 fixed.
372 *** BBDB (erc-bbdb.el)
374 **** Add new option `erc-bbdb-electric-p', which determines whether
375 to make the BBDB buffer electric.  This defaults to not electric.
377 *** Button (erc-button.el)
379 **** Use <backtab> instead of <C-tab> for `erc-button-previous'.
381 *** Identd (erc-identd.el)
383 **** Fix a bug that involves starting the identd server.
385 **** Make this work with Emacs 22.
387 **** Provide a real ERC module named `identd'.
389 **** Don't create an extra buffer for the identd process.
391 *** Channel lists (erc-list.el)
393 **** Enable by default, except in the version of ERC bundled with Emacs 22.
395 *** Logging (erc-log.el)
397 **** By default, don't insert old logs when opening an ERC buffer.
398 This may be changed by customizing `erc-log-insert-log-on-open'.
400 **** New option `erc-log-write-after-send' determines whether the
401 log file will be written to after every sent message.  The default is
402 not to do this.
404 **** New option `erc-log-write-after-insert' determines whether the
405 log file will be written to when new text is added to a logged ERC
406 buffer.  The default is not to do this.  With this option and the
407 previous option, logging should no longer slow down ERC as much.
409 **** Default to saving buffers and queries on quit.
410 This may be changed by customizing the `erc-save-buffer-on-quit' and
411 `erc-save-queries-on-quit' options, respectively.
413 **** Only perform logging when the `logging' module is added to
414 `erc-modules'.  This prevents logging from being activated just by
415 loading the erc-log.el file, and makes logging act like other ERC
416 modules.
418 *** Programmable completion (erc-pcomplete.el)
420 **** Don't complete the user's current nickname.
422 * Changes in ERC 5.1.2
424 ** Fix compiler errors in erc-autojoin.el and erc-dcc.el.
426 ** Move to end of prompt when ERC reconnects to a server.
428 ** Changes and additions to modules
430 *** Spell-checking (erc-spelling.el)
432 **** Don't spell-check nicks or words that are prefixed with '/'.
434 **** Remove flyspell properties from words we shouldn't spell-check.
436 **** Fix an issue that caused the ispell process to reload every time
437 we switch to an ERC buffer.
439 *** Timestamps (erc-stamp.el)
441 **** Fix an inconsistency in calculating width of right timestamps.
443 **** Rename option `erc-timestamp-right-align-by-pixel' to
444 `erc-timestamp-use-align-to'.  This controls whether to use the more
445 fail-proof method of aligning right timestamps, as mentioned below.
447 **** Fix a right timestamp spacing problem that used to occur when
448 erc-stamp.el was byte-compiled.  Now that this is fixed, it is safe to
449 use the method that aligns right timestamps perfectly in Emacs22 with
450 X.  If the current version of Emacs doesn't support this method, use
451 the simpler method, which is prone to alignment issues for math
452 symbols and other variable-width text.
454 A side effect of using this new method is that there will only be one
455 space before a right timestamp in any saved logs.  If this is
456 unacceptable, set `erc-timestamp-use-align-to' to nil.
458 * Changes in ERC 5.1.1
460 ** Fix a requirement on cl.el.
462 ** Use tls.el for SSL connections, rather than ssl.el.
464 ** Changes and additions to modules
466 *** ibuffer integration (erc-ibuffer.el)
468 **** Update this to work with the version of ibuffer.el that comes with
469 recent Emacs variants.
471 *** Old completion (erc-complete.el)
473 **** Fix a few errors.
475 *** Speedbar (erc-speedbar.el)
477 **** Make this work with the version of speedbar.el that comes with
478 recent Emacs variants.
480 *** Timestamps (erc-stamp.el)
482 **** By default, use a more failsafe method of displaying right timestamps.
483 To get right timestamps to align perfectly in Emacs22 using X, set the
484 new `erc-timestamp-right-align-by-pixel' option to non-nil.
486 *** Viper compatibility (erc-viper.el)
488 **** Since most of these changes are now merged into Emacs22, detect
489 whether we need these changes and install them only if necessary.
491 * Changes in ERC 5.1
493 ** Improve XEmacs compatibility.
495 ** Namespace changes
497 *** Now ERC doesn't use global variable space.
498 Renamed all variables that didn't start with "erc-".
500   o `away' is now `erc-away'
502   o `current-nick' is now `erc-server-current-nick'
504   o `last-peers' is now `erc-server-last-peers'
506   o `last-ping-time' is now `erc-server-last-ping-time'
508   o `last-sent-time' is now `erc-server-last-sent-time'
510   o `lines-sent' is now `erc-server-lines-sent'
512   o `quitting' is now `erc-server-quitting'
514 *** Remove the `with-erc-channel-buffer' function.
516 ** Bugfixes
518 *** Don't inadvertently destroy face properties.
520 *** Load erc scripts in a safer way.
522 *** Don't insert a timestamp if text at point is invisible.
524 *** Don't hide messages from those in `erc-fools' by default.
525 Color their nicks instead.
527 *** Use a more foolproof method of encoding and decoding strings
528 before sending to a channel.
530 ** Backend changes
532 *** Renamed some server-specific variables
534   o `erc-announced-server-name' is now `erc-server-announced-name'
536   o `erc-auto-reconnect' is now `erc-server-auto-reconnect'
538   o `erc-connect-function' is now `erc-server-connect-function'
540   o `erc-default-coding-system' is now `erc-server-coding-system'
542   o `erc-duplicate-timeout' is now `erc-server-duplicate-timeout'
544   o `erc-duplicates' is now `erc-server-duplicates'
546   o `erc-lag' is now `erc-server-lag'
548   o `erc-prevent-duplicates' is now `erc-server-prevent-duplicates'
550   o `erc-previous-read' is now `erc-server-filter-data'
552   o `erc-process' is now `erc-server-process'
554   o `erc-ping-handler' is now `erc-server-send-ping-handler'
556   o `erc-ping-interval' is now `erc-server-send-ping-interval'
558 *** Renamed some functions
560   o `erc-connect' is now `erc-server-connect'
562   o `erc-process-filter' is now `erc-server-filter-function'
564   o `erc-send-command' is now `erc-server-send'
566   o `erc-send-single-line' is now `erc-send-input'
568   o `erc-setup-periodical-server-ping' is now
569     `erc-server-setup-periodical-server-ping'
571   o `erc-split-command is now `erc-split-line'
573 *** New options
575   o erc-server-flood-margin, erc-server-flood-penalty: New options
576     that allow tweaking of flood control.
578   o erc-split-line-length: The maximum line length of a single
579     message.
581 *** New variables
583   o erc-server-flood-last-message, erc-server-flood-queue,
584     erc-server-flood-timer: Flood control.
586   o erc-server-processing-p: Indicate when we're currently processing
587     a message.
589 *** Remove some options
591   o `erc-flood-limit'
592   o `erc-flood-limit2'
594 ** New customization group `erc-server' for dealing with IRC servers.
596 ** ERC can now be installed by doing `make install' from the command line.
598 ** ERC now has a manual in erc.texi.
599 Type `make doc' to generate HTML and Info versions of it.
601 ** ERC no longer depends on cl.el.
602 Only the macros in cl-macs.el are used.
604 ** Fix an edge case when quitting as new messages come in.
606 ** Make flood protection toggle-able as on/off, removing the 'strict option.
608 ** If possible, re-use channel buffers when reconnecting to a server.
610 ** Text in ERC buffers is now read-only by default.
611 To get the previous behavior, 
613 ** Changes and additions to modules
615 *** Auto-join (erc-autojoin.el)
617 **** Recognize the Azzurra server.
619 *** BBDB (erc-bbdb.el)
621 **** When the user types /WHOIS, ask for a record to merge to.
623 **** Store the displayed name of a BitlBee contact.
624 The new `erc-bbdb-bitlbee-name-field' option specifies the field to use
625 to store this information.
627 **** Don't prompt for a name on /JOIN or /NICK.
629 *** Button (erc-button.el)
631 **** Fix customization of `erc-button-alist'
633 **** New option `erc-button-nickname-face' determines the face to use
634 when coloring ERC nicknames.
636 *** Channel tracking (erc-track.el)
638 **** Remove channels from the modified channels list if not currently
639 connected.  This should remove residue from the mode line after
640 quitting ERC.
642 **** Recognize buttonized text
644 *** Highlighting (erc-match.el)
646 **** Highlight current nickname by default.
648 **** Added the option of beeping when certain matches occur.
649 Add `erc-beep-on-match' to `erc-text-matched-hook' to enable
650 beeping.  Set the new variable `erc-beep-match-types' which match
651 types that make beeps.
653 *** Nicklist (erc-nicklist.el)
655 **** Fix a couple of errors.
657 **** Make sure a stray mouse click doesn't trigger an error.
659 **** Insert icons from the /images directory next to nicks.
660 This indicates their away status.  The location is customizable via
661 the new `erc-nicklist-icons-directory' option.
663 If you do not want these icons, set `erc-nicklist-use-icons' to nil.
665 *** Nickserv identification (erc-nickserv.el)
667 **** Recognize Azzurra and OFTC networks.
669 *** Old completion (erc-complete.el)
671 **** Disable by default.
673 *** Programmable completion (erc-pcomplete.el)
675 **** Enable by default.
677 *** Timestamps (erc-stamp.el)
679 **** On Emacs22, align right timestamps perfectly, even if variable-width
680 characters are used.  If we aren't using Emacs22, move text farther
681 away from the right margin when variable-width characters are used.
682 It is considered better to misalign the stamp by a bit than to go past
683 the right margin.
685 **** Enable by default
687 ** New modules
689 *** Spell-checking (erc-spelling.el)
691 **** Use flyspell in ERC.
693 *** Viper compatibility (erc-viper.el)
695 **** Helps ERC work correctly in viper-mode.
697 * Changes in ERC 5.0.4
699 ** Fix a problem with undo in channels.
701 * Changes in ERC 5.0.3
703 ** Fix typo in the `ctcp-request-to' entry of the English catalog.
705 ** Debugging with edegug has been made easier in all of the
706 erc-with-* and with-erc* macros.
708 ** Non-ASCII character sets should be better supported when sending
709 and processing messages.
711 ** A load failure with erc-autoaway.el and Emacs21 has been fixed.
713 ** A few XEmacs warnings were fixed.
715 ** Changes and additions to modules
717 *** Backend (erc-backend.el)
719 **** Move the check for hidden messages into `erc-display-message'
720 so there isn't so much replicated code.
722 **** Add `definition-name' property to constructed symbols so that
723 `find-function' and `find-variable' will be able to locate them.
725 **** Make sure logs are inserted info the correct channel buffers.
726 There was previously an error when using `erc-insert-log-on-open' in
727 combination with autojoin to multiple channels.
729 *** Button (erc-button.el)
731 **** The layering of `erc-button-face' on other faces in ERC buffers
732 has been improved.
734 *** Channel tracking (erc-track.el)
736 **** Use optimal amount of whitespace around modified channels
737 indicator.  Previously, there was an additional unnecessary space.
739 **** Fix an error that occurred when unchecked buffers existed when
740 invoking /QUIT.
742 * Changes in ERC 5.0.2
744 ** If a channel key is required for a certain channel, ERC will prompt
745 for one if `erc-prompt-for-channel-key' is non-nil.
747 ** ERC doesn't try to reconnect if the network connection is refused
748 when using `open-network-stream-nowait' as the `erc-connect-function'.
750 ** Messages from multiple servers will not go to the currently active
751 buffer.  The messages from each server will be contained in the most
752 recently active channel/server buffer that corresponds with the
753 server.
755 ** Some text messages were cleaned up slightly.
757 ** Button faces should no longer "cover" other faces.
759 ** Made some XEmacs compatibility fixes.
761 ** Nicknames containing a backslash are now correctly highlighted as
762 current-nick and buttonized as nicks.
764 ** `erc-server-select' doesn't offer networks without servers as a
765 choice anymore.
767 ** Non-ASCII character support has been improved.
769 ** Changes and additions to modules
771 *** Menu (erc-menu.el)
773 **** You can now save logs and truncate buffers from the menu-bar.
775 * Changes in ERC 5.0.1
777 ** Narrowing in ERC buffers no longer causes formatting errors.
779 ** The BBDB module now loads correctly when customizing `erc-modules'.
781 ** The value of `erc-button-face' is now respected.
783 ** Fixed a bug which caused a read-only error during connection.
785 ** Server buffers are now tracked correctly.
786 This means that `erc-track-priority-faces-only', `erc-track-exclude',
787 and `erc-track-exclude-types' now work with server buffers.
789 * Changes in ERC 5.0
791 ** Channel members are now stored as a hash-table.
792 `erc-server-users' and `erc-channel-users' are now hash-tables, rather
793 than alists.  This significantly increases performance, especially in
794 large channels.  Each channel member is stored as an `erc-server-user'
795 struct, with additional information about the channels they are on
796 stored in an `erc-channel-user' struct.  Code using old alist-style
797 channel members needs to be updated to work with hash-tables.
798 This new code also removes the need for erc-members.el, which has been
799 removed.
801 ** The way ERC deals with input from the server has changed.
802 All server response code is now in a new file, erc-backend.el.  There
803 should be no real user visible changes.  There are, however, a few
804 major changes for implementers, and module writers:
806 *** The PARSED response that all handlers get called with is
807     no longer a vector, but an `erc-response' struct.
809     This means LESS MAGIC NUMBERS in the ERC source code, but a few
810     changes in how you get at parsed responses.
812     The sender is accessed via `erc-response.sender'.
814     The command is accessed via `erc-response.command'.
816     The arguments to the command (everything after the command and
817     before the colon) are accessed via `erc-response.command-args'.
818     This is a /list/ of arguments in the order they appear in the
819     unparsed response.
821     The contents of the response is accessed via
822     `erc-response.contents'.
824     Should, for some reason, you want to do something with the
825     /unparsed/ response, you can get it via `erc-response.unparsed'.
827 *** The `erc-server-hook-list' mechanism is gone.
829     All server response handlers should be defined with
830     `define-erc-response-handler'.  This defines functions and
831     corresponding hook variables.
833     The mapping of server commands to hook variables is no longer
834     done via `erc-event-to-hook', but through an #'equal hashtable,
835     `erc-server-responses'.  In order to find a hook you do:
837     (erc-get-hook command)
839     See the docstring of `define-erc-response-handler' for more
840     information.
842 *** ALL hook variables have been renamed.
844     In accordance with recommendations in the Emacs Lisp manual,
845     the hook variables are no longer called `erc-server-FOO-hook',
846     but rather `erc-server-FOO-functions'.  This is to indicate
847     that the functions they call take arguments.
849     All the modules in ERC have been updated to reflect this change,
850     but external module authors should beware.
852 ** The values of `erc-mode-line-format' and `erc-header-line-format'
853 are now defined as strings to be formatted using `format-spec'.
854 `erc-mode-line-format' does not replace the whole mode-line anymore,
855 only `mode-line-buffer-identification' is set.  This way, personal
856 mode-line configurations are not modified and all key bindings work as
857 expected.  The process status (connecting, closed) is now shown in
858 `mode-line-process'.
860 ** Customization of ERC variables has been made easier.  Variables
861 have been split into more groups for better organization.
863 ** New variables
865   o `erc-send-whitespace-lines' - Set this to send lines even if they
866     are empty.
868   o `erc-manual-set-nick-on-bad-nick-p' - If the nickname you chose is
869     already taken or not allowed, your nick is not changed and you can
870     try again manually if this is non-nil.
872   o `erc-mode-line-away-status-format' - You can now set what is shown
873     in the mode-line when you are away.
875   o `erc-header-line-uses-help-echo-p' - The header-line now uses the
876     help-echo property. You can set this to nil to disable it.
878   o `erc-format-query-as-channel-p' - Set this to nil to have messages
879     in the query buffer formatted like private messages.
881   o `erc-show-channel-key-p' - The channel key is now shown with the
882     other channel modes in the header line. Set this to nil if you
883     want it hidden.
885   o `erc-prompt-for-channel-key' - Set this if you want to be prompted
886     for the channel key (channel's mode is +k) when you call
887     `erc-join-channel' interactively.
889   o `erc-kill-server-buffer-on-quit' - If non-nil, kill the server
890     buffer automatically when you quit.
892 ** New hooks
894   o `erc-join-hook' - Called when you join a channel.
896   o `erc-kick-hook' - Called when you are kicked from a channel. The
897     channel's buffer is sent as an argument to functions called from
898     this hook.
900   o `erc-nick-changed-functions' - Whenever your nickname changes
901     successfully, the functions in this hook are run with the
902     arguments NEW-NICK and OLD-NICK.
904 ** New command /WHOAMI - Do a /WHOIS on your current nickname.
906 ** The key binding for changing channel modes is now C-c C-o.
908 ** Removed variables
910   o `erc-echo-notices-in-minibuffer-flag' and
911     `erc-echo-notices-in-current-buffer' - You should use
912     `erc-echo-notice-hook' and `erc-echo-notice-always-hook' instead.
914   o `erc-prompt-interactive-input' has been removed (commented out)
915     because nickname completion does not work with it.
917   o All INFO buffer-related variables and functions have been removed.
919 ** You can now disable modules by setting `erc-modules' with the
920 customization interface.
922 ** Changes and additions to modules
924 *** Autoaway (erc-autoaway.el)
926 **** New variable `erc-autoaway-no-auto-back-regexp' - Add text which,
927 when you type anything matching it, will not automatically discard
928 your away status when `erc-auto-discard-away' is non-nil.
930 *** Filling (erc-fill.el)
932 **** New variable `erc-fill-variable-maximum-indentation' - Don't
933 indent more than this many characters when indenting a message from a
934 user with a long nickname.
936 *** Goodies (erc-goodies.el)
938 **** Miscellaneous small modules have been moved from erc.el.
939 The functions erc-add-scroll-to-bottom, erc-make-read-only,
940 erc-send-distinguish-noncommands, erc-interpret-controls, erc-unmorse,
941 erc-smiley, and erc-occur, which were defined in the main erc.el file
942 have been moved to erc-goodies.el and have mostly been translated to
943 the modules scrolltobottom, readonly, noncommands, irccontrols, smiley
944 and unmorse.
946 **** New variables
948   o `erc-input-line-position' - The line number to use with
949     `erc-scroll-to-bottom'.
951   o `erc-beep-p' - Beep if there is a \C-g control character in a
952     message.
954 *** Channel lists (erc-list.el)
956 **** New variable `erc-chanlist-highlight-face' - A face used for
957 highlighting the current line.
959 *** Highlighting (erc-match.el)
961 **** `erc-current-nick-highlight-type' has new options: 'keyword and
962 'nick-or-keyword.
964 *** Menu (erc-menu.el)
966 **** The `IRC' menu is now automatically added to `erc-mode' buffers.
968 *** Networks (erc-nets.el)
970 **** The functions for determining current network are in this file.
971 There were a couple of functions spread about in different files which
972 each had a different way of determining the current network.  The
973 methods have been combined, and the big list of known networks
974 (`erc-networks-alist') is being put to use.  You can access the
975 network's name by calling the new function `erc-network'.  This
976 returns the name of the current network as a symbol or 'Unknown if it
977 could not determine which network it is.
979 *** Nicklist (erc-nicklist.el)
981 **** ERC has a new way of displaying nicknames in a channel.
982 The new file erc-nicklist.el defines a new command `erc-nicklist'
983 which pops up a small Emacs window showing the nicknames of all
984 members of the current channel.  The implementation is not complete
985 and is rather proof-of-concept for now.  The result is something a bit
986 like erc-speedbar, but not quite as invasive, and doesn't require use
987 of a new frame.
989 *** Internet services / Nickserv (erc-nickserv.el)
991 **** Network detection is now taken care of by erc-nets.el.
992 The function `erc-current-network' is deprecated, use `erc-network'
993 instead.  The variable `erc-networks' has been removed, use
994 `erc-networks-alist'.  The network symbols used in
995 `erc-nickserv-alist' now match those in `erc-networks-alist'.
997 **** New variable `erc-nickserv-identify-mode' - Choose which method
998 to use for automatic identification: you can wait for Nickserv to ask
999 you to identify (the default), or send an identify message
1000 automatically after you change your nickname.
1002 *** Speedbar (erc-speedbar.el)
1004 **** New variable `erc-speedbar-sort-users-type' - Sort users in a
1005 channel by activity, alphabetically, or not at all.
1007 *** Timestamps (erc-stamp.el)
1009 **** `erc-timestamp-only-if-changed-flag' now works when
1010 `erc-insert-timestamp-function' is set to 'erc-insert-timestamp-left.
1012 **** New variable `erc-timestamp-intangible' - Set this to nil if
1013 timestamps should not have the 'intangible property.
1015 *** Channel tracking (erc-track.el)
1017 **** Using faces to indicate channel activity in the modeline now works
1018 in XEmacs.
1020 **** New variables
1022   o `erc-track-priority-faces-only' - Ignore changes in a channel
1023     unless there is a face from the `erc-track-faces-priority-list' in
1024     the message.
1026   o `erc-track-exclude-server-buffer' - Ignore changes in the server
1027     buffer.
1029   o `erc-track-position-in-mode-line' - Set the position in the
1030     mode-line where modified channels are shown (only works in GNU
1031     Emacs versions above 21.3).
1033 * Changes in ERC 4.0
1035 ** The module system has again changed a lot.  You can now customize
1036   the variable `erc-modules' and define once and for all which
1037   extension modules you want to use.  This unfortunately may require
1038   you to change your current erc initialisation code a bit, if you
1039   have some existing customsations.  On the other hand, this change
1040   makes the configuration of extension modules a lot easier for new
1041   users.  In theory, you should be able to configure all aspects of
1042   ERC by using the customize interface, you should no longer really
1043   need to write Lisp code for trivial customizations.
1045   By default, the following modules are now loaded: (pcomplete
1046   netsplit fill track ring button autojoin)
1048   Please use M-x customize-variable RET erc-modules RET to change the
1049   default if it does not suite your needs.
1051 ** THe symbol used in `erc-nickserv-passwords' for debian.org IRC servers
1052   (formerly called OpenProjects, now FreeNode) has changed from
1053   openprojects to freenode.  You may need to update your configuration
1054   for a successful automatic nickserv identification.
1056 * Changes in ERC 3.0.cvs.20030119
1058 ** New module erc-dcc:
1060 This finally implements DCC.  It requires server sockets to fully work
1061 in both directions.  This feature is currently only available in Emacs
1062 21.3.50 (CVS). Here is a short list of what should work though.
1064 ** Compatibility:
1065   * Emacs 21.2, DCC get, and accepting DCC chat offers.
1066   * XEmacs 21, Only accepting DCC chat offers.
1068 ** erc is switching to global-minor-modes for activation of submodules.
1070 This allows you to customize such a mode and get automatic loading of
1071 the module.  No longer putting a lot of require statments in .emacs.
1072 At least this is the long-term plan, not all modules are converted
1073 yet.
1075 ** The most important user visible change is that you now need to activate
1076 erc-completion-mode, to get TAB completion.  The new completion code
1077 is based on pcomplete.  To get the old code, manually load
1078 erc-complete and bind TAB to erc-complete in erc-mode-map.
1080 To activate completion on startup, put (erc-completion-mode 1) in your
1081 .emacs file.
1083 Same applies to timestamps.  You no longer need to (require
1084 'erc-stamp), you can customize the variable `erc-timestamp-mode', and
1085 the rest should be automatic.
1088 This file is part of GNU Emacs.
1090 GNU Emacs is free software; you can redistribute it and/or modify
1091 it under the terms of the GNU General Public License as published by
1092 the Free Software Foundation; either version 3, or (at your option)
1093 any later version.
1095 GNU Emacs is distributed in the hope that it will be useful,
1096 but WITHOUT ANY WARRANTY; without even the implied warranty of
1097 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1098 GNU General Public License for more details.
1100 You should have received a copy of the GNU General Public License
1101 along with GNU Emacs; see the file COPYING.  If not, write to the
1102 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
1103 Boston, MA 02110-1301, USA.
1105 arch-tag: 2b21b387-6cdc-4192-889c-6743cfffdcb1