Add 2012 to FSF copyright years for Emacs files
[bpt/emacs.git] / etc / ERC-NEWS
CommitLineData
597993cf
MB
1ERC NEWS -*- outline -*-
2
acaf905b 3Copyright (C) 2006-2012 Free Software Foundation, Inc.
5b87ad55 4See the end of the file for license conditions.
c2e309f2 5
526dc846
MO
6* Changes in ERC 5.3
7
8** New function `erc-tls' is to be used for connecting to a server via TLS.
c10b0597
MO
9It requires the tls.el library.
10
11** The function `erc-ssl' will now always use ssl.el, even in the version
12of ERC that comes with Emacs.
526dc846 13
b6675b2d
MO
14** Type `C-u' before `C-c C-j' to prompt for a channel key
15`erc-join-channel' now accepts a prefix-argument to prompt for the key
16when channels are protected by keywords.
17
5e56b3fb
MO
18** ERC will now automatically determine which nick prefixes are valid
19when joining a server.
20
21** Figure out which directory contains startup files when looking for
22.erc.el. For Emacs this is usually ~/.emacs.d, and for XEmacs this is
23usually ~/.xemacs.
24
25** Fix bug with view-mode when running erc-toggle-debug-irc-protocol.
26
27** Permit several commands to be run even when the server connection is dead.
28This includes /CLEAR, /COUNTRY, /HELP, /LASTLOG, /QUIT, /GQUIT,
29/RECONNECT, /SERVER, and /SET.
30
31** Make /RECONNECT work better when the server connection is dead.
32Also, handle case where the server buffer has been killed.
33
34** Better handle interaction with /RECONNECT and indefinite reconnect
35attempts. Display message which tells the user that they can stop the
36reconnect attempts by killing the server buffer.
37
38** New option `erc-reuse-frames' determines whether new frames are always
39created. It defaults to not creating a new frame for an ERC buffer if
40there is already a window displaying it. This only has an effect when
41the `erc-join-buffer' option is set to 'frame.
42
43** New command /ME'S handles the case where someone types "/me's" in an
44ERC buffer. It concatenates the text " 's" to the beginning of the
45input and then sends the result like a normal /ME command.
46
47** Fix bug where some messages were being sent to the server too soon.
48In the past, this may have resulted in strange problems like seeing
49the connection attempt stall, which may have especially affected
50spotty or traffic-shaped connections.
51
52** Handle 307 (nick has identified) responses from the server.
53
54** Display a less-confusing message if the connection attempt fails.
55
56** On a tty, make sure that notices are displayed in blue rather than pink.
57
58** By default, open query buffers that are initiated by others in a new
59unselected window. This may be changed by customizing the
60`erc-auto-query' option. This should make ERC more friendly to new
61users.
62
63** New option `erc-query-display' indicates how to display a query buffer
64that is made using the /QUERY command. The default is to display the
65query in a new selected window.
66
67** By default, display network name rather than server name in the modeline.
68This should ERC use less space in the modeline. To get the old
69behavior back, set `erc-mode-line-format' to "%s %a".
70
71** New option `erc-remove-parsed-property' determines whether to remove
72the 'erc-parsed property. This should save some memory in channels
73with large amounts of text on screen. It is enabled by default.
74
75** Modules newly enabled by default
76
77*** move-to-prompt: Move to the prompt when typing text.
78*** networks: Provide data about IRC networks.
79
80** New formatting variables allowed in `erc-format-network':
81
82*** `%N': the name of the network.
83*** `%S': much like %s, but let the network name trump the server name.
84
85** Compatibility with old releases
86
87*** In `erc-server-coding-system' and `erc-coding-system-for-target', pass
88the `target' argument as the first and only argument to the function
89named by these options.
90
91*** In `erc-track-faces-priority-list', permit list entries to be lists of
92faces. This can be used to differentiate between, for example,
93buttons in default text and buttons in notices.
94
95*** The `erc-assert' function has been removed in favor of using `assert'
96from cl-macs.el.
97
98*** If your application uses the 'erc-parsed text property outside of
99the insert hooks, you will need to set `erc-remove-parsed-property'
100to nil.
101
526dc846
MO
102** Changes and additions to modules
103
5e56b3fb
MO
104*** BBDB (erc-bbdb.el)
105
106**** Work around bug in XEmacs 21.4 that causes an error to be thrown when
107the first argument to `run-at-time' is nil.
108
109*** Button (erc-button.el)
110
111**** Recognize parentheses that are part of URLs.
112
113**** When in a channel, only buttonize nicks from that channel.
114
115*** DCC support (erc-dcc.el)
116
117**** Turn this into the "dcc" module for ERC, so that it can be more
118easily enabled.
119
120**** New option `erc-dcc-listen-host' determines which IP address to listen
121on for outside connection attempts.
122
123**** New option `erc-dcc-public-host' determines which IP address to advertise
124when sending a file. This is useful for people who are on a local
125subnet. Together, these two options replace the `erc-dcc-host'
126option.
127
128**** New option `erc-dcc-receive-cache' indicates how much of a received
129file to store in an Emacs buffer before flushing it to disk. The
130default is 0.5 MB.
131
132**** Save only parts of received files in buffers, writing repeatedly to
133disk after we get at least `erc-dcc-receive-cache' bytes. This allows
134users to receive very large files without running out of memory.
135
136**** Rename `erc-verbose-dcc' option to `erc-dcc-verbose' and also
137default it to nil.
138
139**** Fix edge case in erc-dcc-send-sentinel.
140
141**** If client confirms too much, then display byte count and kill the
142file buffer.
143
144*** Goodies (erc-goodies.el)
145
146**** New module move-to-prompt causes the point to be moved to the prompt
147if a user tries to type elsewhere in the buffer, and then inserts
148their keystrokes after the prompt. It is enabled by default.
149
150**** New module keep-place keeps your place in unvisited ERC buffers
151when new messages arrive.
152
153**** Enable scroll-to-bottom in all ERC buffers when the module is enabled,
154rather than having the user do it manually.
155
156**** Fix bug with buffer ordering and scroll-to-bottom module.
157
158**** In the unmorse module, handle the morse code style that has "/ " at
159the end of every letter.
160
161*** Identd (erc-identd.el)
162
163**** Fix bad behavior when closing the identd process.
164
165*** Channel lists (erc-list.el)
166
167**** Replace the old module with a rewritten one, so that we can include
168it with Emacs. The old version of erc-list.el has been renamed to
169erc-list-old.el, and is available as the list-old module.
170
171The new version does not yet have support for XEmacs.
172
173**** Don't display lots of output in the server buffer when running /LIST.
174
175*** Logging (erc-log.el)
176
177**** Permit the `erc-log-channels-directory' option to be set to a function
178name. This makes it easier to write custom functions that determine
179where log files should be placed.
180
181**** New option `erc-log-filter-function' specifies the function to call
182for filtering text before writing it to a log file. By default, no
183filtering is performed.
184
185*** Networks (erc-networks.el)
186
187**** Turn this into the "networks" module for ERC, so that it can be more
188easily enabled. Enable it by default.
189
190**** Add support for Rizon.
191
192*** Internet services / Nickserv (erc-services.el)
193
194**** New hook option `erc-nickserv-identified-hook' is run after NickServ
195acknowledges a successful identification.
196
197**** Add support for the GRnet and Rizon networks.
198
199*** Timestamps (erc-stamp.el)
200
201**** By default, place timestamps on both the left and the right.
202The left timestamps appear once a day, and the right timestamps appear
203once a minute when new messages arrive. To change this, customize the
204`erc-insert-timestamp-function' and
205`erc-insert-away-timestamp-function' options.
206
526dc846
MO
207*** Channel tracking (erc-track.el)
208
5e56b3fb
MO
209**** If `erc-track-position-in-mode-line' is set to nil, the tracking
210information won't be shown in the mode line, which is a change from
211the previous behavior of showing it "After all other information".
212
213If this variable is set to t, then the information will be added to
214the very end of the mode line.
215
216**** New option `erc-track-remove-disconnected-buffers' controls whether
217buffers associated with a server that is disconnected should be
218removed from the modified buffers list. The default is to keep them
219in the list.
220
221**** New hook option `erc-track-list-changed-hook' is run whenever the
222contents of the modified channels list changes. It is useful for
223people who use a separate mechanism to provide notification of channel
224activity.
225
226**** The `erc-track-switch-direction' option now can be set to the value
227'importance. If set to this value, ERC will switch to channels in
228order of importance, which is determined by the position of the
229channel's face in `erc-track-faces-priority-list'.
230
231**** Activate erc-track-minor-mode earlier in the connection process.
232
233**** Don't track buttons in notices.
234
235**** Get a rough idea for which channels are currently active by
236switching between several normal conversation faces in the modeline.
237This behavior can be modified by changing the new
238`erc-track-faces-normal-list' option.
239
240**** Ignore display of who set the default channel topic and listing of
241users on the current channel. Customize the `erc-track-exclude-types'
242option to indicate the types of messages to exclude. These two
243message types are "333" and "353", respectively.
244
245*** Support for acting as an XDCC file-server (erc-xdcc.el)
246
247**** Turn this into the "xdcc" module for ERC, so that it can be more
248easily enabled.
526dc846 249
ff59d266 250* Changes in ERC 5.2
83dc6995
MB
251
252** M-x erc RET now starts ERC.
253`erc-select' has been changed to `erc'. `erc-select' still remains as
254an alias of `erc'. Likewise, `erc-select-ssl' has been renamed to
255`erc-ssl' with `erc-select-ssl' as its alias. The function that was
256known as `erc' is now `erc-open'.
257
ff59d266
MB
258** Open query buffers by default when private messages are received.
259The default value of `erc-auto-query' has been changed to 'bury.
260
10dc9f9e
MB
261** New command: /RECONNECT
262This command tries to reconnect to the current IRC server exactly
263once. It does not work in server buffers (throws an error before the
264command is run), but works in query and channel buffers.
265
ff59d266
MB
266** In MS-DOS environments, look for _ercrc.el rather than .ercrc.el.
267
268** Fix buggy interaction with multi-tty Emacs.
269
270** After running /QUIT, make sure that the IRC process is killed within
2714 seconds. Freenode, in particular, needs this at times.
272
273** If the IRC process has not responded to our PINGs within a certain
274time, kill it and restart the connection. See
275`erc-server-auto-reconnect', `erc-server-reconnect-attempts',
276`erc-server-reconnect-timeout', `erc-server-send-ping-interval', and
277`erc-server-send-ping-timeout' to fine-tune ERC's behavior.
278
279** Avoid getting into an infinite connection loop.
280Previously, this could happen if your nick was banned, you were using
281Tor, incorrect information was entered, or the connection was bad.
282
283** Make ban messages less confusing.
284
285** Restore the point correctly when reconnecting to an IRC server.
286
287** Make /IGNORE and /UNIGNORE prompt to determine whether their
288argument is a user or a regexp. This results in less-confusing
289behavior when trying to ignore someone who has a bracket in their
290nick.
291
292** Make the default port "6667" rather than "ircd", because some
293operating systems don't know what port "ircd" maps to.
294
295** Fix several bugs in erc-iswitchb (C-c C-b).
296
297** Clean up internal documentation.
298Special thanks go to Juanma Barranquero for the thorough vetting of
299ERC's internal documentation.
300
301** Display a more informative message when a module is not found.
302
303** Fix a bug where paths were being colored like IRC commands.
304
305** In the customize interface for `erc-modules', add the name of the module.
306This makes it easier to find modules by name.
307
308** erc-server-send-ping-interval: Change to use a default of 30 seconds.
309
310** Some files which are included with the release of ERC 5.2 will not
311appear in the version of ERC that is bundled with Emacs 22. These
312extras files may be found at:
313
314 o http://ftp.gnu.org/gnu/erc/erc-5.2-extras.tar.gz, or
315 o http://ftp.gnu.org/gnu/erc/erc-5.2-extras.zip.
316
317** Renamed files
318
319Several files were renamed so as to make them distinct to users of the
320MS-DOS operating system.
321
322 o erc-autojoin.el -> erc-join.el
323 o erc-complete.el -> erc-hecomplete.el
324 o erc-nickserv.el -> erc-services.el
325 o ChangeLog.NNNN -> ChangeLog.NN
326
327** Header line changes
328
329*** Remove "[IRC]" from the header line.
330
331*** Add the %l format character to `erc-header-line-format',
332
333*** Document how to remove the header line.
334Namely: (setq erc-header-line-format nil).
335
10dc9f9e
MB
336** New options
337
338*** erc-server-reconnect-attempts: Determines the number of
339reconnection attempts that ERC will make per server.
340
ff59d266
MB
341*** erc-server-reconnect-timeout: Determines the amount of time,
342in seconds, that ERC will wait between successive reconnect attempts.
343
344*** erc-server-send-ping-timeout: Determines when to consider a connection
345stalled and restart it. The default is after 120 seconds.
346
347*** erc-system-name: Determines the system name to use when logging in.
348The default is to figure this out by calling `system-name'.
10dc9f9e 349
6904f7fe
MB
350** New face: `erc-my-nick-face'
351This helps make it easier to distinguish messages sent by yourself
352from messages sent by other users when the value of the variable
353`erc-show-my-nick' is non-nil.
354
ff59d266
MB
355** Namespace changes
356
357*** New macro: `erc-with-server-buffer'
358Switches to the current ERC server buffer and runs some code. If no
359server buffer is available, return nil. This is a useful way to
360access variables in the server buffer.
361
362*** New function: `erc-open-server-buffer-p'
363Returns non-nil if the given buffer is an ERC server buffer that has
364an open IRC process.
365
366*** New function: `erc-format-lag-time'
367Returns the estimated lag time to server, `erc-server-lag'.
368
369*** Renamed items
370
371 o `erc-server-setup-periodical-server-ping' is now
372 `erc-server-setup-periodical-ping'
373
374 o `erc-away-p' is now `erc-away-time'
375
376** Changes to the ERC manual
377
378*** New section: Sample Session.
379Describes a sample ERC session for connecting to the #emacs channel on
380Freenode. Also mention the #erc channel.
381
382*** New section: Special Features.
383Describes some of the special features of ERC.
384
385*** Getting Started: Mention ~/.emacs.d/.ercrc.el and the Customize
386interface.
387
388*** Development: Mention ErcDevelopment page on emacswiki.org.
389
390*** Tips and Tricks: Remove empty section for now.
391
392*** Options: Mention how to see available ERC options.
393
394*** Sample Configuration: Add an example of how to configure ERC.
395
6904f7fe
MB
396** New modules
397
ff59d266
MB
398*** Autoaway (erc-autoaway.el)
399
400**** Make this much more reliable.
401
402**** Avoid duplicate messages when coming back from being away.
403
404**** Fix bug where autoaway was enabled just by loading the file.
405
406*** BBDB (erc-bbdb.el)
407
408**** Display information on how to cancel merging of info or how to
409create a new John Doe record.
410
411**** Make it so that information from /whois continues to come in, even
412while prompting for a record to merge.
413
414**** Make hitting C-g correctly abort merging the record.
415
6904f7fe
MB
416*** Capab identify (erc-capab.el)
417Mark users who haven't identified to NickServ on servers supporting
418CAPAB IDENTIFY-MSG.
419
83dc6995
MB
420** Changes and additions to modules
421
ff59d266 422*** Button (erc-button.el)
cb0a26d3 423
ff59d266 424**** Make <backtab> go to the previous button.
cb0a26d3 425
83dc6995
MB
426*** Channel tracking (erc-track.el)
427
428**** Use mouse-face and help-echo for channel names in the mode-line.
429This helps people using a mouse know that they are buttons and can be
430clicked on.
431
ff59d266
MB
432**** Fix issue where C-c C-SPC could conflict with user-defined keybindings.
433This is accomplished by moving these bindings to their own global
434minor mode. Now the default is to check whether the user has bound
435something to C-c C-SPC or C-c C-@. If they have, prompt them about
436whether to really override that binding. This also has the effect of
437preventing ERC from clobbering rcirc's keybinding, unless this is
438desired. See `erc-track-enable-keybindings' for more details.
439
440**** New option: erc-track-enable-keybindings.
441Determine whether or not to enable the C-c C-SPC and C-c C-@
442keybindings. The default is to ask whether to do this if a binding to
443these keys already exists. It can also be set to t or nil to always
444bind or never bind, respectively.
445
446**** Remove `track-when-inactive' module.
447See `erc-track-when-inactive' for further details.
448
449**** New option: erc-track-when-inactive.
450This option replaces the track-when-inactive module. Set it to
451non-nil to track activity even in visible buffers when inactive. The
452default is nil.
453
454**** Remove the `track-modified-channels' alias for the `track' module.
455
456*** DCC support (erc-dcc.el)
457
458**** Add Usage section to Commentary.
459
460**** Fix a bug in the server message output.
461
462*** Filling (erc-fill.el)
463
464**** Fix bug involving messages that start with one or more blank lines.
465
466*** Identd (erc-identd.el)
467
468**** New option `erc-identd-port'
469Specifies the port to use if none is given as an argument to
470`erc-identd-start'. This is placed in the new customization group
471`erc-identd'.
472
473**** New function: `erc-identd-quickstart'
474Ignores any arguments and calls `erc-identd-start'.
475
476*** Channel lists (erc-list.el)
477
478**** Enable by default, except in the version of ERC bundled with Emacs 22.
479
480*** Logging (erc-log.el)
481
482**** Make sure filenames are safe to use before writing to them.
483
484**** Save all log buffers when exiting Emacs.
485
486**** erc-generate-log-file-name-function: Add option for
487`erc-generate-log-file-name-network', which is a new function that
488uses the network name rather than the server name when possible.
489
490*** Menu (erc-menu.el)
491
492**** Name the menu "ERC" instead of "IRC" to avoid confusion with rcirc
493and other clients.
494
495**** Make this into a proper module and load it by default.
496
497**** Add "Current channel" submenu.
498
499*** Networks (erc-networks.el)
500
501**** Add support for Ars OpenIRC, LinuxChix, and OFTC networks.
502
503**** Escape periods in Konfido.Net and Kewl.Org.
504
505*** Internet services / Nickserv (erc-nickserv.el)
506
507**** Add new 'both method for the `erc-nickserv-identify-mode' option
508and make it the default. This tries to do the right thing both when a
509known nickserv message exists for an IRC network, and when it does
510not.
511
512**** Support nickserv authentication on OFTC, Azzurra, Ars, and QuakeNet.
513
514**** Support authentication on BitlBee.
515
516**** Make source code easier to understand by using accessor functions.
517
518*** Sound support (erc-sound.el)
519
520**** Make this work with both Emacs 21 and Emacs 22.
521
522*** Timestamps (erc-stamp.el)
523
524**** Exclude the newline from the erc-timestamp field.
525
526**** New function: `erc-toggle-timestamps'.
527Toggles display of timestamps.
528
2e3ef421
MB
529* Changes in ERC 5.1.4
530
531** Make find-function and find-variable work in Emacs 22 for
532names that are constructed by `define-erc-module'.
533
534** Fix bug introduced in ERC 5.1.3 that caused messages to go the
535wrong buffer.
536
537** Changes and additions to modules
538
539*** Highlighting (erc-match.el)
540
541**** Don't activate view-mode.
542
543*** Logging (erc-log.el)
544
545**** When this module is activated, make sure logging is enabled on
546already-opened buffers. Ditto for disabling logging when the module
547is deactivated.
548
549**** Fix some errors that occur when exiting Emacs without first
550quitting open IRC servers.
d8bd1ad4 551
0b6bb130
MB
552* Changes in ERC 5.1.3
553
554** Fix use of /quote command with no initial whitespace.
555
556** Make it possible to customize the colorization of the header line.
557The `erc-header-line' face is used to color the header line.
558The `erc-header-line-face-method' determines the method to use when
559colorizing the header line.
560
561** Add the new function `erc-handle-irc-url', which is a suitable
562candidate to use for `url-irc-function'. This permits some
563integration of url.el and ERC.
564
565** Fix several errors that occur when server or channel buffers are killed
566prematurely.
567
568** Fix toggling of flood control.
569
570** Match the patterns in `erc-encoding-coding-alist' as regexps,
571instead of verbatim text. Also, match case-insensitively.
572
573** The /SMV command has been removed, since we no longer have
574meaningful module-specific version information.
575
576** Fix a "(stringp nil)" error that can happen when doing /PART.
577
578** Use a better example in the `erc-part-reason-various-alist'
579documentation.
580
581** When using `erc-quit-reason-various' and `erc-part-reason-various'
582and no matches are found, default to using the ERC version string
583rather than "nil".
584
585** Add the `list' and `page' modules to the `erc-modules' customize
586interface.
587
588** Changes to the ERC manual
589
590*** Update the list of available modules.
591
592*** Revise information about releases and development.
593
594*** Provide a simpler example in the "Getting Started" chapter.
595
596*** Fully document how to connect to an IRC server in the new
597"Connecting" chapter.
598
599** Changes and additions to modules
600
601*** Autoaway (erc-autoaway.el)
602
603**** Rename the `erc-autoaway-use-emacs-idle' option to
604`erc-autoaway-idle-method'.
605
606**** Add support for autoaway based on user idle time.
607This is now the default.
608
609**** If you set the AWAY status yourself, erc-autoaway will not
610interfere by un-setting AWAY prematurely.
611
612**** If you are set away while visiting a non-ERC buffer,
613erc-autoaway used to fail in bringing the user back. This is now
614fixed.
615
616*** BBDB (erc-bbdb.el)
617
618**** Add new option `erc-bbdb-electric-p', which determines whether
619to make the BBDB buffer electric. This defaults to not electric.
620
621*** Button (erc-button.el)
622
623**** Use <backtab> instead of <C-tab> for `erc-button-previous'.
624
625*** Identd (erc-identd.el)
626
627**** Fix a bug that involves starting the identd server.
628
629**** Make this work with Emacs 22.
630
631**** Provide a real ERC module named `identd'.
632
633**** Don't create an extra buffer for the identd process.
634
ff59d266
MB
635*** Channel lists (erc-list.el)
636
637**** Enable by default, except in the version of ERC bundled with Emacs 22.
638
0b6bb130
MB
639*** Logging (erc-log.el)
640
641**** By default, don't insert old logs when opening an ERC buffer.
642This may be changed by customizing `erc-log-insert-log-on-open'.
643
644**** New option `erc-log-write-after-send' determines whether the
645log file will be written to after every sent message. The default is
646not to do this.
647
648**** New option `erc-log-write-after-insert' determines whether the
649log file will be written to when new text is added to a logged ERC
650buffer. The default is not to do this. With this option and the
651previous option, logging should no longer slow down ERC as much.
652
653**** Default to saving buffers and queries on quit.
654This may be changed by customizing the `erc-save-buffer-on-quit' and
655`erc-save-queries-on-quit' options, respectively.
656
657**** Only perform logging when the `logging' module is added to
658`erc-modules'. This prevents logging from being activated just by
659loading the erc-log.el file, and makes logging act like other ERC
660modules.
661
662*** Programmable completion (erc-pcomplete.el)
663
664**** Don't complete the user's current nickname.
665
d8bd1ad4 666* Changes in ERC 5.1.2
e7559e30
MB
667
668** Fix compiler errors in erc-autojoin.el and erc-dcc.el.
669
670** Move to end of prompt when ERC reconnects to a server.
671
672** Changes and additions to modules
673
674*** Spell-checking (erc-spelling.el)
675
676**** Don't spell-check nicks or words that are prefixed with '/'.
677
678**** Remove flyspell properties from words we shouldn't spell-check.
679
680**** Fix an issue that caused the ispell process to reload every time
681we switch to an ERC buffer.
682
683*** Timestamps (erc-stamp.el)
684
685**** Fix an inconsistency in calculating width of right timestamps.
686
687**** Rename option `erc-timestamp-right-align-by-pixel' to
688`erc-timestamp-use-align-to'. This controls whether to use the more
689fail-proof method of aligning right timestamps, as mentioned below.
690
691**** Fix a right timestamp spacing problem that used to occur when
692erc-stamp.el was byte-compiled. Now that this is fixed, it is safe to
693use the method that aligns right timestamps perfectly in Emacs22 with
694X. If the current version of Emacs doesn't support this method, use
695the simpler method, which is prone to alignment issues for math
696symbols and other variable-width text.
697
698A side effect of using this new method is that there will only be one
699space before a right timestamp in any saved logs. If this is
700unacceptable, set `erc-timestamp-use-align-to' to nil.
701
8508e990
MB
702* Changes in ERC 5.1.1
703
704** Fix a requirement on cl.el.
705
706** Use tls.el for SSL connections, rather than ssl.el.
707
708** Changes and additions to modules
709
710*** ibuffer integration (erc-ibuffer.el)
711
712**** Update this to work with the version of ibuffer.el that comes with
713recent Emacs variants.
714
715*** Old completion (erc-complete.el)
716
717**** Fix a few errors.
718
719*** Speedbar (erc-speedbar.el)
720
721**** Make this work with the version of speedbar.el that comes with
722recent Emacs variants.
723
724*** Timestamps (erc-stamp.el)
725
726**** By default, use a more failsafe method of displaying right timestamps.
727To get right timestamps to align perfectly in Emacs22 using X, set the
728new `erc-timestamp-right-align-by-pixel' option to non-nil.
729
730*** Viper compatibility (erc-viper.el)
731
732**** Since most of these changes are now merged into Emacs22, detect
733whether we need these changes and install them only if necessary.
734
735* Changes in ERC 5.1
597993cf
MB
736
737** Improve XEmacs compatibility.
738
739** Namespace changes
740
741*** Now ERC doesn't use global variable space.
742Renamed all variables that didn't start with "erc-".
743
744 o `away' is now `erc-away'
745
746 o `current-nick' is now `erc-server-current-nick'
747
748 o `last-peers' is now `erc-server-last-peers'
749
750 o `last-ping-time' is now `erc-server-last-ping-time'
751
752 o `last-sent-time' is now `erc-server-last-sent-time'
753
754 o `lines-sent' is now `erc-server-lines-sent'
755
756 o `quitting' is now `erc-server-quitting'
757
758*** Remove the `with-erc-channel-buffer' function.
759
760** Bugfixes
761
762*** Don't inadvertently destroy face properties.
763
764*** Load erc scripts in a safer way.
765
766*** Don't insert a timestamp if text at point is invisible.
767
768*** Don't hide messages from those in `erc-fools' by default.
769Color their nicks instead.
770
771*** Use a more foolproof method of encoding and decoding strings
772before sending to a channel.
773
774** Backend changes
775
776*** Renamed some server-specific variables
777
778 o `erc-announced-server-name' is now `erc-server-announced-name'
779
780 o `erc-auto-reconnect' is now `erc-server-auto-reconnect'
781
782 o `erc-connect-function' is now `erc-server-connect-function'
783
784 o `erc-default-coding-system' is now `erc-server-coding-system'
785
786 o `erc-duplicate-timeout' is now `erc-server-duplicate-timeout'
787
788 o `erc-duplicates' is now `erc-server-duplicates'
789
790 o `erc-lag' is now `erc-server-lag'
791
792 o `erc-prevent-duplicates' is now `erc-server-prevent-duplicates'
793
794 o `erc-previous-read' is now `erc-server-filter-data'
795
796 o `erc-process' is now `erc-server-process'
797
798 o `erc-ping-handler' is now `erc-server-send-ping-handler'
799
800 o `erc-ping-interval' is now `erc-server-send-ping-interval'
801
802*** Renamed some functions
803
804 o `erc-connect' is now `erc-server-connect'
805
806 o `erc-process-filter' is now `erc-server-filter-function'
807
808 o `erc-send-command' is now `erc-server-send'
809
810 o `erc-send-single-line' is now `erc-send-input'
811
812 o `erc-setup-periodical-server-ping' is now
813 `erc-server-setup-periodical-server-ping'
814
815 o `erc-split-command is now `erc-split-line'
816
817*** New options
818
819 o erc-server-flood-margin, erc-server-flood-penalty: New options
820 that allow tweaking of flood control.
821
822 o erc-split-line-length: The maximum line length of a single
823 message.
824
825*** New variables
826
827 o erc-server-flood-last-message, erc-server-flood-queue,
828 erc-server-flood-timer: Flood control.
829
830 o erc-server-processing-p: Indicate when we're currently processing
831 a message.
832
833*** Remove some options
834
835 o `erc-flood-limit'
836 o `erc-flood-limit2'
837
838** New customization group `erc-server' for dealing with IRC servers.
839
840** ERC can now be installed by doing `make install' from the command line.
841
842** ERC now has a manual in erc.texi.
843Type `make doc' to generate HTML and Info versions of it.
844
845** ERC no longer depends on cl.el.
846Only the macros in cl-macs.el are used.
847
848** Fix an edge case when quitting as new messages come in.
849
850** Make flood protection toggle-able as on/off, removing the 'strict option.
851
852** If possible, re-use channel buffers when reconnecting to a server.
853
854** Text in ERC buffers is now read-only by default.
da6062e6 855To get the previous behavior,
597993cf
MB
856
857** Changes and additions to modules
858
859*** Auto-join (erc-autojoin.el)
860
861**** Recognize the Azzurra server.
862
863*** BBDB (erc-bbdb.el)
864
865**** When the user types /WHOIS, ask for a record to merge to.
866
867**** Store the displayed name of a BitlBee contact.
868The new `erc-bbdb-bitlbee-name-field' option specifies the field to use
869to store this information.
870
871**** Don't prompt for a name on /JOIN or /NICK.
872
873*** Button (erc-button.el)
874
875**** Fix customization of `erc-button-alist'
876
877**** New option `erc-button-nickname-face' determines the face to use
878when coloring ERC nicknames.
879
880*** Channel tracking (erc-track.el)
881
882**** Remove channels from the modified channels list if not currently
883connected. This should remove residue from the mode line after
884quitting ERC.
885
886**** Recognize buttonized text
887
888*** Highlighting (erc-match.el)
889
890**** Highlight current nickname by default.
891
892**** Added the option of beeping when certain matches occur.
893Add `erc-beep-on-match' to `erc-text-matched-hook' to enable
894beeping. Set the new variable `erc-beep-match-types' which match
895types that make beeps.
896
897*** Nicklist (erc-nicklist.el)
898
899**** Fix a couple of errors.
900
901**** Make sure a stray mouse click doesn't trigger an error.
902
903**** Insert icons from the /images directory next to nicks.
904This indicates their away status. The location is customizable via
905the new `erc-nicklist-icons-directory' option.
906
907If you do not want these icons, set `erc-nicklist-use-icons' to nil.
908
909*** Nickserv identification (erc-nickserv.el)
910
911**** Recognize Azzurra and OFTC networks.
912
913*** Old completion (erc-complete.el)
914
915**** Disable by default.
916
917*** Programmable completion (erc-pcomplete.el)
918
919**** Enable by default.
920
921*** Timestamps (erc-stamp.el)
922
923**** On Emacs22, align right timestamps perfectly, even if variable-width
924characters are used. If we aren't using Emacs22, move text farther
925away from the right margin when variable-width characters are used.
926It is considered better to misalign the stamp by a bit than to go past
927the right margin.
928
929**** Enable by default
930
931** New modules
932
933*** Spell-checking (erc-spelling.el)
934
935**** Use flyspell in ERC.
936
937*** Viper compatibility (erc-viper.el)
938
939**** Helps ERC work correctly in viper-mode.
940
8508e990 941* Changes in ERC 5.0.4
597993cf
MB
942
943** Fix a problem with undo in channels.
944
8508e990 945* Changes in ERC 5.0.3
597993cf
MB
946
947** Fix typo in the `ctcp-request-to' entry of the English catalog.
948
949** Debugging with edegug has been made easier in all of the
950erc-with-* and with-erc* macros.
951
952** Non-ASCII character sets should be better supported when sending
953and processing messages.
954
955** A load failure with erc-autoaway.el and Emacs21 has been fixed.
956
957** A few XEmacs warnings were fixed.
958
959** Changes and additions to modules
960
961*** Backend (erc-backend.el)
962
963**** Move the check for hidden messages into `erc-display-message'
964so there isn't so much replicated code.
965
966**** Add `definition-name' property to constructed symbols so that
967`find-function' and `find-variable' will be able to locate them.
968
969**** Make sure logs are inserted info the correct channel buffers.
970There was previously an error when using `erc-insert-log-on-open' in
971combination with autojoin to multiple channels.
972
973*** Button (erc-button.el)
974
975**** The layering of `erc-button-face' on other faces in ERC buffers
976has been improved.
977
978*** Channel tracking (erc-track.el)
979
980**** Use optimal amount of whitespace around modified channels
981indicator. Previously, there was an additional unnecessary space.
982
983**** Fix an error that occurred when unchecked buffers existed when
984invoking /QUIT.
985
8508e990 986* Changes in ERC 5.0.2
597993cf
MB
987
988** If a channel key is required for a certain channel, ERC will prompt
989for one if `erc-prompt-for-channel-key' is non-nil.
990
991** ERC doesn't try to reconnect if the network connection is refused
992when using `open-network-stream-nowait' as the `erc-connect-function'.
993
994** Messages from multiple servers will not go to the currently active
995buffer. The messages from each server will be contained in the most
996recently active channel/server buffer that corresponds with the
997server.
998
999** Some text messages were cleaned up slightly.
1000
1001** Button faces should no longer "cover" other faces.
1002
1003** Made some XEmacs compatibility fixes.
1004
1005** Nicknames containing a backslash are now correctly highlighted as
1006current-nick and buttonized as nicks.
1007
1008** `erc-server-select' doesn't offer networks without servers as a
1009choice anymore.
1010
1011** Non-ASCII character support has been improved.
1012
1013** Changes and additions to modules
1014
1015*** Menu (erc-menu.el)
1016
1017**** You can now save logs and truncate buffers from the menu-bar.
1018
8508e990 1019* Changes in ERC 5.0.1
597993cf
MB
1020
1021** Narrowing in ERC buffers no longer causes formatting errors.
1022
1023** The BBDB module now loads correctly when customizing `erc-modules'.
1024
1025** The value of `erc-button-face' is now respected.
1026
1027** Fixed a bug which caused a read-only error during connection.
1028
1029** Server buffers are now tracked correctly.
1030This means that `erc-track-priority-faces-only', `erc-track-exclude',
1031and `erc-track-exclude-types' now work with server buffers.
1032
8508e990 1033* Changes in ERC 5.0
597993cf
MB
1034
1035** Channel members are now stored as a hash-table.
1036`erc-server-users' and `erc-channel-users' are now hash-tables, rather
1037than alists. This significantly increases performance, especially in
1038large channels. Each channel member is stored as an `erc-server-user'
1039struct, with additional information about the channels they are on
1040stored in an `erc-channel-user' struct. Code using old alist-style
1041channel members needs to be updated to work with hash-tables.
1042This new code also removes the need for erc-members.el, which has been
1043removed.
1044
1045** The way ERC deals with input from the server has changed.
1046All server response code is now in a new file, erc-backend.el. There
1047should be no real user visible changes. There are, however, a few
1048major changes for implementers, and module writers:
1049
1050*** The PARSED response that all handlers get called with is
1051 no longer a vector, but an `erc-response' struct.
1052
1053 This means LESS MAGIC NUMBERS in the ERC source code, but a few
1054 changes in how you get at parsed responses.
1055
1056 The sender is accessed via `erc-response.sender'.
1057
1058 The command is accessed via `erc-response.command'.
1059
1060 The arguments to the command (everything after the command and
1061 before the colon) are accessed via `erc-response.command-args'.
1062 This is a /list/ of arguments in the order they appear in the
1063 unparsed response.
1064
1065 The contents of the response is accessed via
1066 `erc-response.contents'.
1067
1068 Should, for some reason, you want to do something with the
1069 /unparsed/ response, you can get it via `erc-response.unparsed'.
1070
1071*** The `erc-server-hook-list' mechanism is gone.
1072
1073 All server response handlers should be defined with
1074 `define-erc-response-handler'. This defines functions and
1075 corresponding hook variables.
1076
1077 The mapping of server commands to hook variables is no longer
1078 done via `erc-event-to-hook', but through an #'equal hashtable,
1079 `erc-server-responses'. In order to find a hook you do:
1080
1081 (erc-get-hook command)
1082
1083 See the docstring of `define-erc-response-handler' for more
1084 information.
1085
1086*** ALL hook variables have been renamed.
1087
1088 In accordance with recommendations in the Emacs Lisp manual,
1089 the hook variables are no longer called `erc-server-FOO-hook',
1090 but rather `erc-server-FOO-functions'. This is to indicate
1091 that the functions they call take arguments.
1092
1093 All the modules in ERC have been updated to reflect this change,
1094 but external module authors should beware.
1095
1096** The values of `erc-mode-line-format' and `erc-header-line-format'
1097are now defined as strings to be formatted using `format-spec'.
1098`erc-mode-line-format' does not replace the whole mode-line anymore,
1099only `mode-line-buffer-identification' is set. This way, personal
1100mode-line configurations are not modified and all key bindings work as
1101expected. The process status (connecting, closed) is now shown in
1102`mode-line-process'.
1103
1104** Customization of ERC variables has been made easier. Variables
1105have been split into more groups for better organization.
1106
1107** New variables
1108
1109 o `erc-send-whitespace-lines' - Set this to send lines even if they
1110 are empty.
1111
1112 o `erc-manual-set-nick-on-bad-nick-p' - If the nickname you chose is
1113 already taken or not allowed, your nick is not changed and you can
1114 try again manually if this is non-nil.
1115
1116 o `erc-mode-line-away-status-format' - You can now set what is shown
1117 in the mode-line when you are away.
1118
1119 o `erc-header-line-uses-help-echo-p' - The header-line now uses the
1120 help-echo property. You can set this to nil to disable it.
1121
1122 o `erc-format-query-as-channel-p' - Set this to nil to have messages
1123 in the query buffer formatted like private messages.
1124
1125 o `erc-show-channel-key-p' - The channel key is now shown with the
1126 other channel modes in the header line. Set this to nil if you
1127 want it hidden.
1128
1129 o `erc-prompt-for-channel-key' - Set this if you want to be prompted
1130 for the channel key (channel's mode is +k) when you call
1131 `erc-join-channel' interactively.
1132
1133 o `erc-kill-server-buffer-on-quit' - If non-nil, kill the server
1134 buffer automatically when you quit.
1135
1136** New hooks
1137
1138 o `erc-join-hook' - Called when you join a channel.
1139
1140 o `erc-kick-hook' - Called when you are kicked from a channel. The
1141 channel's buffer is sent as an argument to functions called from
1142 this hook.
1143
1144 o `erc-nick-changed-functions' - Whenever your nickname changes
1145 successfully, the functions in this hook are run with the
1146 arguments NEW-NICK and OLD-NICK.
1147
1148** New command /WHOAMI - Do a /WHOIS on your current nickname.
1149
1150** The key binding for changing channel modes is now C-c C-o.
1151
1152** Removed variables
1153
1154 o `erc-echo-notices-in-minibuffer-flag' and
1155 `erc-echo-notices-in-current-buffer' - You should use
1156 `erc-echo-notice-hook' and `erc-echo-notice-always-hook' instead.
1157
1158 o `erc-prompt-interactive-input' has been removed (commented out)
1159 because nickname completion does not work with it.
1160
1161 o All INFO buffer-related variables and functions have been removed.
1162
1163** You can now disable modules by setting `erc-modules' with the
1164customization interface.
1165
1166** Changes and additions to modules
1167
1168*** Autoaway (erc-autoaway.el)
1169
1170**** New variable `erc-autoaway-no-auto-back-regexp' - Add text which,
1171when you type anything matching it, will not automatically discard
1172your away status when `erc-auto-discard-away' is non-nil.
1173
1174*** Filling (erc-fill.el)
1175
1176**** New variable `erc-fill-variable-maximum-indentation' - Don't
1177indent more than this many characters when indenting a message from a
1178user with a long nickname.
1179
1180*** Goodies (erc-goodies.el)
1181
1182**** Miscellaneous small modules have been moved from erc.el.
1183The functions erc-add-scroll-to-bottom, erc-make-read-only,
1184erc-send-distinguish-noncommands, erc-interpret-controls, erc-unmorse,
1185erc-smiley, and erc-occur, which were defined in the main erc.el file
1186have been moved to erc-goodies.el and have mostly been translated to
1187the modules scrolltobottom, readonly, noncommands, irccontrols, smiley
1188and unmorse.
1189
1190**** New variables
1191
1192 o `erc-input-line-position' - The line number to use with
1193 `erc-scroll-to-bottom'.
1194
1195 o `erc-beep-p' - Beep if there is a \C-g control character in a
1196 message.
1197
1198*** Channel lists (erc-list.el)
1199
1200**** New variable `erc-chanlist-highlight-face' - A face used for
1201highlighting the current line.
1202
1203*** Highlighting (erc-match.el)
1204
1205**** `erc-current-nick-highlight-type' has new options: 'keyword and
1206'nick-or-keyword.
1207
1208*** Menu (erc-menu.el)
1209
1210**** The `IRC' menu is now automatically added to `erc-mode' buffers.
1211
1212*** Networks (erc-nets.el)
1213
1214**** The functions for determining current network are in this file.
1215There were a couple of functions spread about in different files which
1216each had a different way of determining the current network. The
1217methods have been combined, and the big list of known networks
1218(`erc-networks-alist') is being put to use. You can access the
1219network's name by calling the new function `erc-network'. This
1220returns the name of the current network as a symbol or 'Unknown if it
1221could not determine which network it is.
1222
1223*** Nicklist (erc-nicklist.el)
1224
1225**** ERC has a new way of displaying nicknames in a channel.
1226The new file erc-nicklist.el defines a new command `erc-nicklist'
1227which pops up a small Emacs window showing the nicknames of all
1228members of the current channel. The implementation is not complete
1229and is rather proof-of-concept for now. The result is something a bit
1230like erc-speedbar, but not quite as invasive, and doesn't require use
1231of a new frame.
1232
1233*** Internet services / Nickserv (erc-nickserv.el)
1234
1235**** Network detection is now taken care of by erc-nets.el.
1236The function `erc-current-network' is deprecated, use `erc-network'
1237instead. The variable `erc-networks' has been removed, use
1238`erc-networks-alist'. The network symbols used in
1239`erc-nickserv-alist' now match those in `erc-networks-alist'.
1240
1241**** New variable `erc-nickserv-identify-mode' - Choose which method
1242to use for automatic identification: you can wait for Nickserv to ask
1243you to identify (the default), or send an identify message
1244automatically after you change your nickname.
1245
1246*** Speedbar (erc-speedbar.el)
1247
1248**** New variable `erc-speedbar-sort-users-type' - Sort users in a
1249channel by activity, alphabetically, or not at all.
1250
1251*** Timestamps (erc-stamp.el)
1252
1253**** `erc-timestamp-only-if-changed-flag' now works when
1254`erc-insert-timestamp-function' is set to 'erc-insert-timestamp-left.
1255
1256**** New variable `erc-timestamp-intangible' - Set this to nil if
1257timestamps should not have the 'intangible property.
1258
1259*** Channel tracking (erc-track.el)
1260
1261**** Using faces to indicate channel activity in the modeline now works
1262in XEmacs.
1263
1264**** New variables
1265
1266 o `erc-track-priority-faces-only' - Ignore changes in a channel
1267 unless there is a face from the `erc-track-faces-priority-list' in
1268 the message.
1269
1270 o `erc-track-exclude-server-buffer' - Ignore changes in the server
1271 buffer.
1272
1273 o `erc-track-position-in-mode-line' - Set the position in the
1274 mode-line where modified channels are shown (only works in GNU
1275 Emacs versions above 21.3).
1276
8508e990 1277* Changes in ERC 4.0
597993cf
MB
1278
1279** The module system has again changed a lot. You can now customize
1280 the variable `erc-modules' and define once and for all which
1281 extension modules you want to use. This unfortunately may require
e1dbe924 1282 you to change your current erc initialization code a bit, if you
da6062e6 1283 have some existing customizations. On the other hand, this change
597993cf
MB
1284 makes the configuration of extension modules a lot easier for new
1285 users. In theory, you should be able to configure all aspects of
1286 ERC by using the customize interface, you should no longer really
1287 need to write Lisp code for trivial customizations.
1288
1289 By default, the following modules are now loaded: (pcomplete
1290 netsplit fill track ring button autojoin)
1291
1292 Please use M-x customize-variable RET erc-modules RET to change the
1293 default if it does not suite your needs.
1294
1295** THe symbol used in `erc-nickserv-passwords' for debian.org IRC servers
1296 (formerly called OpenProjects, now FreeNode) has changed from
1297 openprojects to freenode. You may need to update your configuration
1298 for a successful automatic nickserv identification.
1299
8508e990 1300* Changes in ERC 3.0.cvs.20030119
597993cf
MB
1301
1302** New module erc-dcc:
1303
1304This finally implements DCC. It requires server sockets to fully work
1305in both directions. This feature is currently only available in Emacs
130621.3.50 (CVS). Here is a short list of what should work though.
1307
1308** Compatibility:
1309 * Emacs 21.2, DCC get, and accepting DCC chat offers.
1310 * XEmacs 21, Only accepting DCC chat offers.
1311
1312** erc is switching to global-minor-modes for activation of submodules.
1313
1314This allows you to customize such a mode and get automatic loading of
b643362c
JB
1315the module. No longer putting a lot of require statements in .emacs.
1316At least this is the long-term plan, not all modules are converted yet.
597993cf
MB
1317
1318** The most important user visible change is that you now need to activate
1319erc-completion-mode, to get TAB completion. The new completion code
1320is based on pcomplete. To get the old code, manually load
1321erc-complete and bind TAB to erc-complete in erc-mode-map.
1322
1323To activate completion on startup, put (erc-completion-mode 1) in your
1324.emacs file.
1325
1326Same applies to timestamps. You no longer need to (require
1327'erc-stamp), you can customize the variable `erc-timestamp-mode', and
1328the rest should be automatic.
1329
5b87ad55
GM
1330\f
1331This file is part of GNU Emacs.
1332
ab73e885 1333GNU Emacs is free software: you can redistribute it and/or modify
5b87ad55 1334it under the terms of the GNU General Public License as published by
ab73e885
GM
1335the Free Software Foundation, either version 3 of the License, or
1336(at your option) any later version.
5b87ad55
GM
1337
1338GNU Emacs is distributed in the hope that it will be useful,
1339but WITHOUT ANY WARRANTY; without even the implied warranty of
1340MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1341GNU General Public License for more details.
1342
1343You should have received a copy of the GNU General Public License
ab73e885 1344along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.