Initial revision
[emacs.git] / etc / ERC-NEWS
blob409dcf03da6d6e4c25aef247e3460e40487701ae
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 The function `erc-ssl' should never be used for that purpose any
10 longer, which was the case with the version of ERC that is included
11 with Emacs.
13 ** Changes and additions to modules
15 *** Channel tracking (erc-track.el)
17 If erc-track-position-in-mode-line is set to nil, the tracking
18 information won't be shown in the mode line, which is a change
19 from the previous behavior of showing it "After all other
20 information".
22 * Changes in ERC 5.2
24 ** M-x erc RET now starts ERC.
25 `erc-select' has been changed to `erc'.  `erc-select' still remains as
26 an alias of `erc'. Likewise, `erc-select-ssl' has been renamed to
27 `erc-ssl' with `erc-select-ssl' as its alias.  The function that was
28 known as `erc' is now `erc-open'.
30 ** Open query buffers by default when private messages are received.
31 The default value of `erc-auto-query' has been changed to 'bury.
33 ** New command: /RECONNECT
34 This command tries to reconnect to the current IRC server exactly
35 once.  It does not work in server buffers (throws an error before the
36 command is run), but works in query and channel buffers.
38 ** In MS-DOS environments, look for _ercrc.el rather than .ercrc.el.
40 ** Fix buggy interaction with multi-tty Emacs.
42 ** After running /QUIT, make sure that the IRC process is killed within
43 4 seconds.  Freenode, in particular, needs this at times.
45 ** If the IRC process has not responded to our PINGs within a certain
46 time, kill it and restart the connection.  See
47 `erc-server-auto-reconnect', `erc-server-reconnect-attempts',
48 `erc-server-reconnect-timeout', `erc-server-send-ping-interval', and
49 `erc-server-send-ping-timeout' to fine-tune ERC's behavior.
51 ** Avoid getting into an infinite connection loop.
52 Previously, this could happen if your nick was banned, you were using
53 Tor, incorrect information was entered, or the connection was bad.
55 ** Make ban messages less confusing.
57 ** Restore the point correctly when reconnecting to an IRC server.
59 ** Make /IGNORE and /UNIGNORE prompt to determine whether their
60 argument is a user or a regexp.  This results in less-confusing
61 behavior when trying to ignore someone who has a bracket in their
62 nick.
64 ** Make the default port "6667" rather than "ircd", because some
65 operating systems don't know what port "ircd" maps to.
67 ** Fix several bugs in erc-iswitchb (C-c C-b).
69 ** Clean up internal documentation.
70 Special thanks go to Juanma Barranquero for the thorough vetting of
71 ERC's internal documentation.
73 ** Display a more informative message when a module is not found.
75 ** Fix a bug where paths were being colored like IRC commands.
77 ** In the customize interface for `erc-modules', add the name of the module.
78 This makes it easier to find modules by name.
80 ** erc-server-send-ping-interval: Change to use a default of 30 seconds.
82 ** Some files which are included with the release of ERC 5.2 will not
83 appear in the version of ERC that is bundled with Emacs 22.  These
84 extras files may be found at:
86  o http://ftp.gnu.org/gnu/erc/erc-5.2-extras.tar.gz, or
87  o http://ftp.gnu.org/gnu/erc/erc-5.2-extras.zip.
89 ** Renamed files
91 Several files were renamed so as to make them distinct to users of the
92 MS-DOS operating system.
94  o erc-autojoin.el -> erc-join.el
95  o erc-complete.el -> erc-hecomplete.el
96  o erc-nickserv.el -> erc-services.el
97  o ChangeLog.NNNN -> ChangeLog.NN
99 ** Header line changes
101 *** Remove "[IRC]" from the header line.
103 *** Add the %l format character to `erc-header-line-format',
105 *** Document how to remove the header line.
106 Namely: (setq erc-header-line-format nil).
108 ** New options
110 *** erc-server-reconnect-attempts: Determines the number of
111 reconnection attempts that ERC will make per server.
113 *** erc-server-reconnect-timeout: Determines the amount of time,
114 in seconds, that ERC will wait between successive reconnect attempts.
116 *** erc-server-send-ping-timeout: Determines when to consider a connection
117 stalled and restart it.  The default is after 120 seconds.
119 *** erc-system-name: Determines the system name to use when logging in.
120 The default is to figure this out by calling `system-name'.
122 ** New face: `erc-my-nick-face'
123 This helps make it easier to distinguish messages sent by yourself
124 from messages sent by other users when the value of the variable
125 `erc-show-my-nick' is non-nil.
127 ** Namespace changes
129 *** New macro: `erc-with-server-buffer'
130 Switches to the current ERC server buffer and runs some code.  If no
131 server buffer is available, return nil.  This is a useful way to
132 access variables in the server buffer.
134 *** New function: `erc-open-server-buffer-p'
135 Returns non-nil if the given buffer is an ERC server buffer that has
136 an open IRC process.
138 *** New function: `erc-format-lag-time'
139 Returns the estimated lag time to server, `erc-server-lag'.
141 *** Renamed items
143  o `erc-server-setup-periodical-server-ping' is now
144    `erc-server-setup-periodical-ping'
146  o `erc-away-p' is now `erc-away-time'
148 ** Changes to the ERC manual
150 *** New section: Sample Session.
151 Describes a sample ERC session for connecting to the #emacs channel on
152 Freenode.  Also mention the #erc channel.
154 *** New section: Special Features.
155 Describes some of the special features of ERC.
157 *** Getting Started: Mention ~/.emacs.d/.ercrc.el and the Customize
158 interface.
160 *** Development: Mention ErcDevelopment page on emacswiki.org.
162 *** Tips and Tricks: Remove empty section for now.
164 *** Options: Mention how to see available ERC options.
166 *** Sample Configuration: Add an example of how to configure ERC.
168 ** New modules
170 *** Autoaway (erc-autoaway.el)
172 **** Make this much more reliable.
174 **** Avoid duplicate messages when coming back from being away.
176 **** Fix bug where autoaway was enabled just by loading the file.
178 *** BBDB (erc-bbdb.el)
180 **** Display information on how to cancel merging of info or how to
181 create a new John Doe record.
183 **** Make it so that information from /whois continues to come in, even
184 while prompting for a record to merge.
186 **** Make hitting C-g correctly abort merging the record.
188 *** Capab identify (erc-capab.el)
189 Mark users who haven't identified to NickServ on servers supporting
190 CAPAB IDENTIFY-MSG.
192 ** Changes and additions to modules
194 *** Button (erc-button.el)
196 **** Make <backtab> go to the previous button.
198 *** Channel tracking (erc-track.el)
200 **** Use mouse-face and help-echo for channel names in the mode-line.
201 This helps people using a mouse know that they are buttons and can be
202 clicked on.
204 **** Fix issue where C-c C-SPC could conflict with user-defined keybindings.
205 This is accomplished by moving these bindings to their own global
206 minor mode.  Now the default is to check whether the user has bound
207 something to C-c C-SPC or C-c C-@.  If they have, prompt them about
208 whether to really override that binding.  This also has the effect of
209 preventing ERC from clobbering rcirc's keybinding, unless this is
210 desired.  See `erc-track-enable-keybindings' for more details.
212 **** New option: erc-track-enable-keybindings.
213 Determine whether or not to enable the C-c C-SPC and C-c C-@
214 keybindings.  The default is to ask whether to do this if a binding to
215 these keys already exists.  It can also be set to t or nil to always
216 bind or never bind, respectively.
218 **** Remove `track-when-inactive' module.
219 See `erc-track-when-inactive' for further details.
221 **** New option: erc-track-when-inactive.
222 This option replaces the track-when-inactive module.  Set it to
223 non-nil to track activity even in visible buffers when inactive.  The
224 default is nil.
226 **** Remove the `track-modified-channels' alias for the `track' module.
228 *** DCC support (erc-dcc.el)
230 **** Add Usage section to Commentary.
232 **** Fix a bug in the server message output.
234 *** Filling (erc-fill.el)
236 **** Fix bug involving messages that start with one or more blank lines.
238 *** Identd (erc-identd.el)
240 **** New option `erc-identd-port'
241 Specifies the port to use if none is given as an argument to
242 `erc-identd-start'.  This is placed in the new customization group
243 `erc-identd'.
245 **** New function: `erc-identd-quickstart'
246 Ignores any arguments and calls `erc-identd-start'.
248 *** Channel lists (erc-list.el)
250 **** Enable by default, except in the version of ERC bundled with Emacs 22.
252 *** Logging (erc-log.el)
254 **** Make sure filenames are safe to use before writing to them.
256 **** Save all log buffers when exiting Emacs.
258 **** erc-generate-log-file-name-function: Add option for
259 `erc-generate-log-file-name-network', which is a new function that
260 uses the network name rather than the server name when possible.
262 *** Menu (erc-menu.el)
264 **** Name the menu "ERC" instead of "IRC" to avoid confusion with rcirc
265 and other clients.
267 **** Make this into a proper module and load it by default.
269 **** Add "Current channel" submenu.
271 *** Networks (erc-networks.el)
273 **** Add support for Ars OpenIRC, LinuxChix, and OFTC networks.
275 **** Escape periods in Konfido.Net and Kewl.Org.
277 *** Internet services / Nickserv (erc-nickserv.el)
279 **** Add new 'both method for the `erc-nickserv-identify-mode' option
280 and make it the default.  This tries to do the right thing both when a
281 known nickserv message exists for an IRC network, and when it does
282 not.
284 **** Support nickserv authentication on OFTC, Azzurra, Ars, and QuakeNet.
286 **** Support authentication on BitlBee.
288 **** Make source code easier to understand by using accessor functions.
290 *** Sound support (erc-sound.el)
292 **** Make this work with both Emacs 21 and Emacs 22.
294 *** Timestamps (erc-stamp.el)
296 **** Exclude the newline from the erc-timestamp field.
298 **** New function: `erc-toggle-timestamps'.
299 Toggles display of timestamps.
301 * Changes in ERC 5.1.4
303 ** Make find-function and find-variable work in Emacs 22 for
304 names that are constructed by `define-erc-module'.
306 ** Fix bug introduced in ERC 5.1.3 that caused messages to go the
307 wrong buffer.
309 ** Changes and additions to modules
311 *** Highlighting (erc-match.el)
313 **** Don't activate view-mode.
315 *** Logging (erc-log.el)
317 **** When this module is activated, make sure logging is enabled on
318 already-opened buffers.  Ditto for disabling logging when the module
319 is deactivated.
321 **** Fix some errors that occur when exiting Emacs without first
322 quitting open IRC servers.
324 * Changes in ERC 5.1.3
326 ** Fix use of /quote command with no initial whitespace.
328 ** Make it possible to customize the colorization of the header line.
329 The `erc-header-line' face is used to color the header line.
330 The `erc-header-line-face-method' determines the method to use when
331 colorizing the header line.
333 ** Add the new function `erc-handle-irc-url', which is a suitable
334 candidate to use for `url-irc-function'.  This permits some
335 integration of url.el and ERC.
337 ** Fix several errors that occur when server or channel buffers are killed
338 prematurely.
340 ** Fix toggling of flood control.
342 ** Match the patterns in `erc-encoding-coding-alist' as regexps,
343 instead of verbatim text.  Also, match case-insensitively.
345 ** The /SMV command has been removed, since we no longer have
346 meaningful module-specific version information.
348 ** Fix a "(stringp nil)" error that can happen when doing /PART.
350 ** Use a better example in the `erc-part-reason-various-alist'
351 documentation.
353 ** When using `erc-quit-reason-various' and `erc-part-reason-various'
354 and no matches are found, default to using the ERC version string
355 rather than "nil".
357 ** Add the `list' and `page' modules to the `erc-modules' customize
358 interface.
360 ** Changes to the ERC manual
362 *** Update the list of available modules.
364 *** Revise information about releases and development.
366 *** Provide a simpler example in the "Getting Started" chapter.
368 *** Fully document how to connect to an IRC server in the new
369 "Connecting" chapter.
371 ** Changes and additions to modules
373 *** Autoaway (erc-autoaway.el)
375 **** Rename the `erc-autoaway-use-emacs-idle' option to
376 `erc-autoaway-idle-method'.
378 **** Add support for autoaway based on user idle time.
379 This is now the default.
381 **** If you set the AWAY status yourself, erc-autoaway will not
382 interfere by un-setting AWAY prematurely.
384 **** If you are set away while visiting a non-ERC buffer,
385 erc-autoaway used to fail in bringing the user back.  This is now
386 fixed.
388 *** BBDB (erc-bbdb.el)
390 **** Add new option `erc-bbdb-electric-p', which determines whether
391 to make the BBDB buffer electric.  This defaults to not electric.
393 *** Button (erc-button.el)
395 **** Use <backtab> instead of <C-tab> for `erc-button-previous'.
397 *** Identd (erc-identd.el)
399 **** Fix a bug that involves starting the identd server.
401 **** Make this work with Emacs 22.
403 **** Provide a real ERC module named `identd'.
405 **** Don't create an extra buffer for the identd process.
407 *** Channel lists (erc-list.el)
409 **** Enable by default, except in the version of ERC bundled with Emacs 22.
411 *** Logging (erc-log.el)
413 **** By default, don't insert old logs when opening an ERC buffer.
414 This may be changed by customizing `erc-log-insert-log-on-open'.
416 **** New option `erc-log-write-after-send' determines whether the
417 log file will be written to after every sent message.  The default is
418 not to do this.
420 **** New option `erc-log-write-after-insert' determines whether the
421 log file will be written to when new text is added to a logged ERC
422 buffer.  The default is not to do this.  With this option and the
423 previous option, logging should no longer slow down ERC as much.
425 **** Default to saving buffers and queries on quit.
426 This may be changed by customizing the `erc-save-buffer-on-quit' and
427 `erc-save-queries-on-quit' options, respectively.
429 **** Only perform logging when the `logging' module is added to
430 `erc-modules'.  This prevents logging from being activated just by
431 loading the erc-log.el file, and makes logging act like other ERC
432 modules.
434 *** Programmable completion (erc-pcomplete.el)
436 **** Don't complete the user's current nickname.
438 * Changes in ERC 5.1.2
440 ** Fix compiler errors in erc-autojoin.el and erc-dcc.el.
442 ** Move to end of prompt when ERC reconnects to a server.
444 ** Changes and additions to modules
446 *** Spell-checking (erc-spelling.el)
448 **** Don't spell-check nicks or words that are prefixed with '/'.
450 **** Remove flyspell properties from words we shouldn't spell-check.
452 **** Fix an issue that caused the ispell process to reload every time
453 we switch to an ERC buffer.
455 *** Timestamps (erc-stamp.el)
457 **** Fix an inconsistency in calculating width of right timestamps.
459 **** Rename option `erc-timestamp-right-align-by-pixel' to
460 `erc-timestamp-use-align-to'.  This controls whether to use the more
461 fail-proof method of aligning right timestamps, as mentioned below.
463 **** Fix a right timestamp spacing problem that used to occur when
464 erc-stamp.el was byte-compiled.  Now that this is fixed, it is safe to
465 use the method that aligns right timestamps perfectly in Emacs22 with
466 X.  If the current version of Emacs doesn't support this method, use
467 the simpler method, which is prone to alignment issues for math
468 symbols and other variable-width text.
470 A side effect of using this new method is that there will only be one
471 space before a right timestamp in any saved logs.  If this is
472 unacceptable, set `erc-timestamp-use-align-to' to nil.
474 * Changes in ERC 5.1.1
476 ** Fix a requirement on cl.el.
478 ** Use tls.el for SSL connections, rather than ssl.el.
480 ** Changes and additions to modules
482 *** ibuffer integration (erc-ibuffer.el)
484 **** Update this to work with the version of ibuffer.el that comes with
485 recent Emacs variants.
487 *** Old completion (erc-complete.el)
489 **** Fix a few errors.
491 *** Speedbar (erc-speedbar.el)
493 **** Make this work with the version of speedbar.el that comes with
494 recent Emacs variants.
496 *** Timestamps (erc-stamp.el)
498 **** By default, use a more failsafe method of displaying right timestamps.
499 To get right timestamps to align perfectly in Emacs22 using X, set the
500 new `erc-timestamp-right-align-by-pixel' option to non-nil.
502 *** Viper compatibility (erc-viper.el)
504 **** Since most of these changes are now merged into Emacs22, detect
505 whether we need these changes and install them only if necessary.
507 * Changes in ERC 5.1
509 ** Improve XEmacs compatibility.
511 ** Namespace changes
513 *** Now ERC doesn't use global variable space.
514 Renamed all variables that didn't start with "erc-".
516   o `away' is now `erc-away'
518   o `current-nick' is now `erc-server-current-nick'
520   o `last-peers' is now `erc-server-last-peers'
522   o `last-ping-time' is now `erc-server-last-ping-time'
524   o `last-sent-time' is now `erc-server-last-sent-time'
526   o `lines-sent' is now `erc-server-lines-sent'
528   o `quitting' is now `erc-server-quitting'
530 *** Remove the `with-erc-channel-buffer' function.
532 ** Bugfixes
534 *** Don't inadvertently destroy face properties.
536 *** Load erc scripts in a safer way.
538 *** Don't insert a timestamp if text at point is invisible.
540 *** Don't hide messages from those in `erc-fools' by default.
541 Color their nicks instead.
543 *** Use a more foolproof method of encoding and decoding strings
544 before sending to a channel.
546 ** Backend changes
548 *** Renamed some server-specific variables
550   o `erc-announced-server-name' is now `erc-server-announced-name'
552   o `erc-auto-reconnect' is now `erc-server-auto-reconnect'
554   o `erc-connect-function' is now `erc-server-connect-function'
556   o `erc-default-coding-system' is now `erc-server-coding-system'
558   o `erc-duplicate-timeout' is now `erc-server-duplicate-timeout'
560   o `erc-duplicates' is now `erc-server-duplicates'
562   o `erc-lag' is now `erc-server-lag'
564   o `erc-prevent-duplicates' is now `erc-server-prevent-duplicates'
566   o `erc-previous-read' is now `erc-server-filter-data'
568   o `erc-process' is now `erc-server-process'
570   o `erc-ping-handler' is now `erc-server-send-ping-handler'
572   o `erc-ping-interval' is now `erc-server-send-ping-interval'
574 *** Renamed some functions
576   o `erc-connect' is now `erc-server-connect'
578   o `erc-process-filter' is now `erc-server-filter-function'
580   o `erc-send-command' is now `erc-server-send'
582   o `erc-send-single-line' is now `erc-send-input'
584   o `erc-setup-periodical-server-ping' is now
585     `erc-server-setup-periodical-server-ping'
587   o `erc-split-command is now `erc-split-line'
589 *** New options
591   o erc-server-flood-margin, erc-server-flood-penalty: New options
592     that allow tweaking of flood control.
594   o erc-split-line-length: The maximum line length of a single
595     message.
597 *** New variables
599   o erc-server-flood-last-message, erc-server-flood-queue,
600     erc-server-flood-timer: Flood control.
602   o erc-server-processing-p: Indicate when we're currently processing
603     a message.
605 *** Remove some options
607   o `erc-flood-limit'
608   o `erc-flood-limit2'
610 ** New customization group `erc-server' for dealing with IRC servers.
612 ** ERC can now be installed by doing `make install' from the command line.
614 ** ERC now has a manual in erc.texi.
615 Type `make doc' to generate HTML and Info versions of it.
617 ** ERC no longer depends on cl.el.
618 Only the macros in cl-macs.el are used.
620 ** Fix an edge case when quitting as new messages come in.
622 ** Make flood protection toggle-able as on/off, removing the 'strict option.
624 ** If possible, re-use channel buffers when reconnecting to a server.
626 ** Text in ERC buffers is now read-only by default.
627 To get the previous behavior, 
629 ** Changes and additions to modules
631 *** Auto-join (erc-autojoin.el)
633 **** Recognize the Azzurra server.
635 *** BBDB (erc-bbdb.el)
637 **** When the user types /WHOIS, ask for a record to merge to.
639 **** Store the displayed name of a BitlBee contact.
640 The new `erc-bbdb-bitlbee-name-field' option specifies the field to use
641 to store this information.
643 **** Don't prompt for a name on /JOIN or /NICK.
645 *** Button (erc-button.el)
647 **** Fix customization of `erc-button-alist'
649 **** New option `erc-button-nickname-face' determines the face to use
650 when coloring ERC nicknames.
652 *** Channel tracking (erc-track.el)
654 **** Remove channels from the modified channels list if not currently
655 connected.  This should remove residue from the mode line after
656 quitting ERC.
658 **** Recognize buttonized text
660 *** Highlighting (erc-match.el)
662 **** Highlight current nickname by default.
664 **** Added the option of beeping when certain matches occur.
665 Add `erc-beep-on-match' to `erc-text-matched-hook' to enable
666 beeping.  Set the new variable `erc-beep-match-types' which match
667 types that make beeps.
669 *** Nicklist (erc-nicklist.el)
671 **** Fix a couple of errors.
673 **** Make sure a stray mouse click doesn't trigger an error.
675 **** Insert icons from the /images directory next to nicks.
676 This indicates their away status.  The location is customizable via
677 the new `erc-nicklist-icons-directory' option.
679 If you do not want these icons, set `erc-nicklist-use-icons' to nil.
681 *** Nickserv identification (erc-nickserv.el)
683 **** Recognize Azzurra and OFTC networks.
685 *** Old completion (erc-complete.el)
687 **** Disable by default.
689 *** Programmable completion (erc-pcomplete.el)
691 **** Enable by default.
693 *** Timestamps (erc-stamp.el)
695 **** On Emacs22, align right timestamps perfectly, even if variable-width
696 characters are used.  If we aren't using Emacs22, move text farther
697 away from the right margin when variable-width characters are used.
698 It is considered better to misalign the stamp by a bit than to go past
699 the right margin.
701 **** Enable by default
703 ** New modules
705 *** Spell-checking (erc-spelling.el)
707 **** Use flyspell in ERC.
709 *** Viper compatibility (erc-viper.el)
711 **** Helps ERC work correctly in viper-mode.
713 * Changes in ERC 5.0.4
715 ** Fix a problem with undo in channels.
717 * Changes in ERC 5.0.3
719 ** Fix typo in the `ctcp-request-to' entry of the English catalog.
721 ** Debugging with edegug has been made easier in all of the
722 erc-with-* and with-erc* macros.
724 ** Non-ASCII character sets should be better supported when sending
725 and processing messages.
727 ** A load failure with erc-autoaway.el and Emacs21 has been fixed.
729 ** A few XEmacs warnings were fixed.
731 ** Changes and additions to modules
733 *** Backend (erc-backend.el)
735 **** Move the check for hidden messages into `erc-display-message'
736 so there isn't so much replicated code.
738 **** Add `definition-name' property to constructed symbols so that
739 `find-function' and `find-variable' will be able to locate them.
741 **** Make sure logs are inserted info the correct channel buffers.
742 There was previously an error when using `erc-insert-log-on-open' in
743 combination with autojoin to multiple channels.
745 *** Button (erc-button.el)
747 **** The layering of `erc-button-face' on other faces in ERC buffers
748 has been improved.
750 *** Channel tracking (erc-track.el)
752 **** Use optimal amount of whitespace around modified channels
753 indicator.  Previously, there was an additional unnecessary space.
755 **** Fix an error that occurred when unchecked buffers existed when
756 invoking /QUIT.
758 * Changes in ERC 5.0.2
760 ** If a channel key is required for a certain channel, ERC will prompt
761 for one if `erc-prompt-for-channel-key' is non-nil.
763 ** ERC doesn't try to reconnect if the network connection is refused
764 when using `open-network-stream-nowait' as the `erc-connect-function'.
766 ** Messages from multiple servers will not go to the currently active
767 buffer.  The messages from each server will be contained in the most
768 recently active channel/server buffer that corresponds with the
769 server.
771 ** Some text messages were cleaned up slightly.
773 ** Button faces should no longer "cover" other faces.
775 ** Made some XEmacs compatibility fixes.
777 ** Nicknames containing a backslash are now correctly highlighted as
778 current-nick and buttonized as nicks.
780 ** `erc-server-select' doesn't offer networks without servers as a
781 choice anymore.
783 ** Non-ASCII character support has been improved.
785 ** Changes and additions to modules
787 *** Menu (erc-menu.el)
789 **** You can now save logs and truncate buffers from the menu-bar.
791 * Changes in ERC 5.0.1
793 ** Narrowing in ERC buffers no longer causes formatting errors.
795 ** The BBDB module now loads correctly when customizing `erc-modules'.
797 ** The value of `erc-button-face' is now respected.
799 ** Fixed a bug which caused a read-only error during connection.
801 ** Server buffers are now tracked correctly.
802 This means that `erc-track-priority-faces-only', `erc-track-exclude',
803 and `erc-track-exclude-types' now work with server buffers.
805 * Changes in ERC 5.0
807 ** Channel members are now stored as a hash-table.
808 `erc-server-users' and `erc-channel-users' are now hash-tables, rather
809 than alists.  This significantly increases performance, especially in
810 large channels.  Each channel member is stored as an `erc-server-user'
811 struct, with additional information about the channels they are on
812 stored in an `erc-channel-user' struct.  Code using old alist-style
813 channel members needs to be updated to work with hash-tables.
814 This new code also removes the need for erc-members.el, which has been
815 removed.
817 ** The way ERC deals with input from the server has changed.
818 All server response code is now in a new file, erc-backend.el.  There
819 should be no real user visible changes.  There are, however, a few
820 major changes for implementers, and module writers:
822 *** The PARSED response that all handlers get called with is
823     no longer a vector, but an `erc-response' struct.
825     This means LESS MAGIC NUMBERS in the ERC source code, but a few
826     changes in how you get at parsed responses.
828     The sender is accessed via `erc-response.sender'.
830     The command is accessed via `erc-response.command'.
832     The arguments to the command (everything after the command and
833     before the colon) are accessed via `erc-response.command-args'.
834     This is a /list/ of arguments in the order they appear in the
835     unparsed response.
837     The contents of the response is accessed via
838     `erc-response.contents'.
840     Should, for some reason, you want to do something with the
841     /unparsed/ response, you can get it via `erc-response.unparsed'.
843 *** The `erc-server-hook-list' mechanism is gone.
845     All server response handlers should be defined with
846     `define-erc-response-handler'.  This defines functions and
847     corresponding hook variables.
849     The mapping of server commands to hook variables is no longer
850     done via `erc-event-to-hook', but through an #'equal hashtable,
851     `erc-server-responses'.  In order to find a hook you do:
853     (erc-get-hook command)
855     See the docstring of `define-erc-response-handler' for more
856     information.
858 *** ALL hook variables have been renamed.
860     In accordance with recommendations in the Emacs Lisp manual,
861     the hook variables are no longer called `erc-server-FOO-hook',
862     but rather `erc-server-FOO-functions'.  This is to indicate
863     that the functions they call take arguments.
865     All the modules in ERC have been updated to reflect this change,
866     but external module authors should beware.
868 ** The values of `erc-mode-line-format' and `erc-header-line-format'
869 are now defined as strings to be formatted using `format-spec'.
870 `erc-mode-line-format' does not replace the whole mode-line anymore,
871 only `mode-line-buffer-identification' is set.  This way, personal
872 mode-line configurations are not modified and all key bindings work as
873 expected.  The process status (connecting, closed) is now shown in
874 `mode-line-process'.
876 ** Customization of ERC variables has been made easier.  Variables
877 have been split into more groups for better organization.
879 ** New variables
881   o `erc-send-whitespace-lines' - Set this to send lines even if they
882     are empty.
884   o `erc-manual-set-nick-on-bad-nick-p' - If the nickname you chose is
885     already taken or not allowed, your nick is not changed and you can
886     try again manually if this is non-nil.
888   o `erc-mode-line-away-status-format' - You can now set what is shown
889     in the mode-line when you are away.
891   o `erc-header-line-uses-help-echo-p' - The header-line now uses the
892     help-echo property. You can set this to nil to disable it.
894   o `erc-format-query-as-channel-p' - Set this to nil to have messages
895     in the query buffer formatted like private messages.
897   o `erc-show-channel-key-p' - The channel key is now shown with the
898     other channel modes in the header line. Set this to nil if you
899     want it hidden.
901   o `erc-prompt-for-channel-key' - Set this if you want to be prompted
902     for the channel key (channel's mode is +k) when you call
903     `erc-join-channel' interactively.
905   o `erc-kill-server-buffer-on-quit' - If non-nil, kill the server
906     buffer automatically when you quit.
908 ** New hooks
910   o `erc-join-hook' - Called when you join a channel.
912   o `erc-kick-hook' - Called when you are kicked from a channel. The
913     channel's buffer is sent as an argument to functions called from
914     this hook.
916   o `erc-nick-changed-functions' - Whenever your nickname changes
917     successfully, the functions in this hook are run with the
918     arguments NEW-NICK and OLD-NICK.
920 ** New command /WHOAMI - Do a /WHOIS on your current nickname.
922 ** The key binding for changing channel modes is now C-c C-o.
924 ** Removed variables
926   o `erc-echo-notices-in-minibuffer-flag' and
927     `erc-echo-notices-in-current-buffer' - You should use
928     `erc-echo-notice-hook' and `erc-echo-notice-always-hook' instead.
930   o `erc-prompt-interactive-input' has been removed (commented out)
931     because nickname completion does not work with it.
933   o All INFO buffer-related variables and functions have been removed.
935 ** You can now disable modules by setting `erc-modules' with the
936 customization interface.
938 ** Changes and additions to modules
940 *** Autoaway (erc-autoaway.el)
942 **** New variable `erc-autoaway-no-auto-back-regexp' - Add text which,
943 when you type anything matching it, will not automatically discard
944 your away status when `erc-auto-discard-away' is non-nil.
946 *** Filling (erc-fill.el)
948 **** New variable `erc-fill-variable-maximum-indentation' - Don't
949 indent more than this many characters when indenting a message from a
950 user with a long nickname.
952 *** Goodies (erc-goodies.el)
954 **** Miscellaneous small modules have been moved from erc.el.
955 The functions erc-add-scroll-to-bottom, erc-make-read-only,
956 erc-send-distinguish-noncommands, erc-interpret-controls, erc-unmorse,
957 erc-smiley, and erc-occur, which were defined in the main erc.el file
958 have been moved to erc-goodies.el and have mostly been translated to
959 the modules scrolltobottom, readonly, noncommands, irccontrols, smiley
960 and unmorse.
962 **** New variables
964   o `erc-input-line-position' - The line number to use with
965     `erc-scroll-to-bottom'.
967   o `erc-beep-p' - Beep if there is a \C-g control character in a
968     message.
970 *** Channel lists (erc-list.el)
972 **** New variable `erc-chanlist-highlight-face' - A face used for
973 highlighting the current line.
975 *** Highlighting (erc-match.el)
977 **** `erc-current-nick-highlight-type' has new options: 'keyword and
978 'nick-or-keyword.
980 *** Menu (erc-menu.el)
982 **** The `IRC' menu is now automatically added to `erc-mode' buffers.
984 *** Networks (erc-nets.el)
986 **** The functions for determining current network are in this file.
987 There were a couple of functions spread about in different files which
988 each had a different way of determining the current network.  The
989 methods have been combined, and the big list of known networks
990 (`erc-networks-alist') is being put to use.  You can access the
991 network's name by calling the new function `erc-network'.  This
992 returns the name of the current network as a symbol or 'Unknown if it
993 could not determine which network it is.
995 *** Nicklist (erc-nicklist.el)
997 **** ERC has a new way of displaying nicknames in a channel.
998 The new file erc-nicklist.el defines a new command `erc-nicklist'
999 which pops up a small Emacs window showing the nicknames of all
1000 members of the current channel.  The implementation is not complete
1001 and is rather proof-of-concept for now.  The result is something a bit
1002 like erc-speedbar, but not quite as invasive, and doesn't require use
1003 of a new frame.
1005 *** Internet services / Nickserv (erc-nickserv.el)
1007 **** Network detection is now taken care of by erc-nets.el.
1008 The function `erc-current-network' is deprecated, use `erc-network'
1009 instead.  The variable `erc-networks' has been removed, use
1010 `erc-networks-alist'.  The network symbols used in
1011 `erc-nickserv-alist' now match those in `erc-networks-alist'.
1013 **** New variable `erc-nickserv-identify-mode' - Choose which method
1014 to use for automatic identification: you can wait for Nickserv to ask
1015 you to identify (the default), or send an identify message
1016 automatically after you change your nickname.
1018 *** Speedbar (erc-speedbar.el)
1020 **** New variable `erc-speedbar-sort-users-type' - Sort users in a
1021 channel by activity, alphabetically, or not at all.
1023 *** Timestamps (erc-stamp.el)
1025 **** `erc-timestamp-only-if-changed-flag' now works when
1026 `erc-insert-timestamp-function' is set to 'erc-insert-timestamp-left.
1028 **** New variable `erc-timestamp-intangible' - Set this to nil if
1029 timestamps should not have the 'intangible property.
1031 *** Channel tracking (erc-track.el)
1033 **** Using faces to indicate channel activity in the modeline now works
1034 in XEmacs.
1036 **** New variables
1038   o `erc-track-priority-faces-only' - Ignore changes in a channel
1039     unless there is a face from the `erc-track-faces-priority-list' in
1040     the message.
1042   o `erc-track-exclude-server-buffer' - Ignore changes in the server
1043     buffer.
1045   o `erc-track-position-in-mode-line' - Set the position in the
1046     mode-line where modified channels are shown (only works in GNU
1047     Emacs versions above 21.3).
1049 * Changes in ERC 4.0
1051 ** The module system has again changed a lot.  You can now customize
1052   the variable `erc-modules' and define once and for all which
1053   extension modules you want to use.  This unfortunately may require
1054   you to change your current erc initialisation code a bit, if you
1055   have some existing customsations.  On the other hand, this change
1056   makes the configuration of extension modules a lot easier for new
1057   users.  In theory, you should be able to configure all aspects of
1058   ERC by using the customize interface, you should no longer really
1059   need to write Lisp code for trivial customizations.
1061   By default, the following modules are now loaded: (pcomplete
1062   netsplit fill track ring button autojoin)
1064   Please use M-x customize-variable RET erc-modules RET to change the
1065   default if it does not suite your needs.
1067 ** THe symbol used in `erc-nickserv-passwords' for debian.org IRC servers
1068   (formerly called OpenProjects, now FreeNode) has changed from
1069   openprojects to freenode.  You may need to update your configuration
1070   for a successful automatic nickserv identification.
1072 * Changes in ERC 3.0.cvs.20030119
1074 ** New module erc-dcc:
1076 This finally implements DCC.  It requires server sockets to fully work
1077 in both directions.  This feature is currently only available in Emacs
1078 21.3.50 (CVS). Here is a short list of what should work though.
1080 ** Compatibility:
1081   * Emacs 21.2, DCC get, and accepting DCC chat offers.
1082   * XEmacs 21, Only accepting DCC chat offers.
1084 ** erc is switching to global-minor-modes for activation of submodules.
1086 This allows you to customize such a mode and get automatic loading of
1087 the module.  No longer putting a lot of require statments in .emacs.
1088 At least this is the long-term plan, not all modules are converted
1089 yet.
1091 ** The most important user visible change is that you now need to activate
1092 erc-completion-mode, to get TAB completion.  The new completion code
1093 is based on pcomplete.  To get the old code, manually load
1094 erc-complete and bind TAB to erc-complete in erc-mode-map.
1096 To activate completion on startup, put (erc-completion-mode 1) in your
1097 .emacs file.
1099 Same applies to timestamps.  You no longer need to (require
1100 'erc-stamp), you can customize the variable `erc-timestamp-mode', and
1101 the rest should be automatic.
1104 This file is part of GNU Emacs.
1106 GNU Emacs is free software; you can redistribute it and/or modify
1107 it under the terms of the GNU General Public License as published by
1108 the Free Software Foundation; either version 3, or (at your option)
1109 any later version.
1111 GNU Emacs is distributed in the hope that it will be useful,
1112 but WITHOUT ANY WARRANTY; without even the implied warranty of
1113 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1114 GNU General Public License for more details.
1116 You should have received a copy of the GNU General Public License
1117 along with GNU Emacs; see the file COPYING.  If not, write to the
1118 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
1119 Boston, MA 02110-1301, USA.
1121 arch-tag: 2b21b387-6cdc-4192-889c-6743cfffdcb1