(define-globalized-minor-mode): Improve doc string of generated command.
[emacs.git] / etc / NEWS.21
blob476853746f5d0545efd30f38cfb4099ce54cfc2f
1 GNU Emacs NEWS -- history of user-visible changes.  2006-05-31
3 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
4   Free Software Foundation, Inc.
5 See the end of the file for license conditions.
8 This file is about changes in emacs version 21.
12 * Emacs 21.4 is a bug-fix release with no user-visible changes.
16 * Installation changes in Emacs 21.3
18 ** Support for GNU/Linux on little-endian MIPS and on IBM S390 has
19 been added.
22 * Changes in Emacs 21.3
24 ** The obsolete C mode (c-mode.el) has been removed to avoid problems
25 with Custom.
27 ** UTF-16 coding systems are available, encoding the same characters
28 as mule-utf-8.
30 ** There is a new language environment for UTF-8 (set up automatically
31 in UTF-8 locales).
33 ** Translation tables are available between equivalent characters in
34 different Emacs charsets -- for instance `e with acute' coming from the
35 Latin-1 and Latin-2 charsets.  User options `unify-8859-on-encoding-mode'
36 and `unify-8859-on-decoding-mode' respectively turn on translation
37 between ISO 8859 character sets (`unification') on encoding
38 (e.g. writing a file) and decoding (e.g. reading a file).  Note that
39 `unify-8859-on-encoding-mode' is useful and safe, but
40 `unify-8859-on-decoding-mode' can cause text to change when you read
41 it and write it out again without edits, so it is not generally advisable.
42 By default `unify-8859-on-encoding-mode' is turned on.
44 ** In Emacs running on the X window system, the default value of
45 `selection-coding-system' is now `compound-text-with-extensions'.
47 If you want the old behavior, set selection-coding-system to
48 compound-text, which may be significantly more efficient.  Using
49 compound-text-with-extensions seems to be necessary only for decoding
50 text from applications under XFree86 4.2, whose behavior is actually
51 contrary to the compound text specification.
55 * Installation changes in Emacs 21.2
57 ** Support for BSD/OS 5.0 has been added.
59 ** Support for AIX 5.1 was added.
62 * Changes in Emacs 21.2
64 ** Emacs now supports compound-text extended segments in X selections.
66 X applications can use `extended segments' to encode characters in
67 compound text that belong to character sets which are not part of the
68 list of approved standard encodings for X, e.g. Big5.  To paste
69 selections with such characters into Emacs, use the new coding system
70 compound-text-with-extensions as the value of selection-coding-system.
72 ** The default values of `tooltip-delay' and `tooltip-hide-delay'
73 were changed.
75 ** On terminals whose erase-char is ^H (Backspace), Emacs
76 now uses normal-erase-is-backspace-mode.
78 ** When the *scratch* buffer is recreated, its mode is set from
79 initial-major-mode, which normally is lisp-interaction-mode,
80 instead of using default-major-mode.
82 ** The new option `Info-scroll-prefer-subnodes' causes Info to behave
83 like the stand-alone Info reader (from the GNU Texinfo package) as far
84 as motion between nodes and their subnodes is concerned.  If it is t
85 (the default), Emacs behaves as before when you type SPC in a menu: it
86 visits the subnode pointed to by the first menu entry.  If this option
87 is nil, SPC scrolls to the end of the current node, and only then goes
88 to the first menu item, like the stand-alone reader does.
90 This change was already in Emacs 21.1, but wasn't advertised in the
91 NEWS.
94 * Lisp Changes in Emacs 21.2
96 ** The meanings of scroll-up-aggressively and scroll-down-aggressively
97 have been interchanged, so that the former now controls scrolling up,
98 and the latter now controls scrolling down.
100 ** The variable `compilation-parse-errors-filename-function' can
101 be used to transform filenames found in compilation output.
105 * Installation Changes in Emacs 21.1
107 See the INSTALL file for information on installing extra libraries and
108 fonts to take advantage of the new graphical features and extra
109 charsets in this release.
111 ** Support for GNU/Linux on IA64 machines has been added.
113 ** Support for LynxOS has been added.
115 ** There are new configure options associated with the support for
116 images and toolkit scrollbars.  Use the --help option in `configure'
117 to list them.
119 ** You can build a 64-bit Emacs for SPARC/Solaris systems which
120 support 64-bit executables and also on Irix 6.5.  This increases the
121 maximum buffer size.  See etc/MACHINES for instructions.  Changes to
122 build on other 64-bit systems should be straightforward modulo any
123 necessary changes to unexec.
125 ** There is a new configure option `--disable-largefile' to omit
126 Unix-98-style support for large files if that is available.
128 ** There is a new configure option `--without-xim' that instructs
129 Emacs to not use X Input Methods (XIM), if these are available.
131 ** `movemail' defaults to supporting POP.  You can turn this off using
132 the --without-pop configure option, should that be necessary.
134 ** This version can be built for the Macintosh, but does not implement
135 all of the new display features described below.  The port currently
136 lacks unexec, asynchronous processes, and networking support.  See the
137 "Emacs and the Mac OS" appendix in the Emacs manual, for the
138 description of aspects specific to the Mac.
140 ** Note that the MS-Windows port does not yet implement various of the
141 new display features described below.
144 * Changes in Emacs 21.1
146 ** Emacs has a new redisplay engine.
148 The new redisplay handles characters of variable width and height.
149 Italic text can be used without redisplay problems.  Fonts containing
150 oversized characters, i.e. characters larger than the logical height
151 of a font can be used.  Images of various formats can be displayed in
152 the text.
154 ** Emacs has a new face implementation.
156 The new faces no longer fundamentally use X font names to specify the
157 font.  Instead, each face has several independent attributes--family,
158 height, width, weight and slant--that it may or may not specify.
159 These attributes can be merged from various faces, and then together
160 specify a font.
162 Faces are supported on terminals that can display color or fonts.
163 These terminal capabilities are auto-detected.  Details can be found
164 under Lisp changes, below.
166 ** Emacs can display faces on TTY frames.
168 Emacs automatically detects terminals that are able to display colors.
169 Faces with a weight greater than normal are displayed extra-bright, if
170 the terminal supports it.  Faces with a weight less than normal and
171 italic faces are displayed dimmed, if the terminal supports it.
172 Underlined faces are displayed underlined if possible.  Other face
173 attributes such as `overline', `strike-through', and `box' are ignored
174 on terminals.
176 The command-line options `-fg COLOR', `-bg COLOR', and `-rv' are now
177 supported on character terminals.
179 Emacs automatically remaps all X-style color specifications to one of
180 the colors supported by the terminal.  This means you could have the
181 same color customizations that work both on a windowed display and on
182 a TTY or when Emacs is invoked with the -nw option.
184 ** New default font is Courier 12pt under X.
186 ** Sound support
188 Emacs supports playing sound files on GNU/Linux and FreeBSD (Voxware
189 driver and native BSD driver, a.k.a. Luigi's driver).  Currently
190 supported file formats are RIFF-WAVE (*.wav) and Sun Audio (*.au).
191 You must configure Emacs with the option `--with-sound=yes' to enable
192 sound support.
194 ** Emacs now resizes mini-windows if appropriate.
196 If a message is longer than one line, or minibuffer contents are
197 longer than one line, Emacs can resize the minibuffer window unless it
198 is on a frame of its own.  You can control resizing and the maximum
199 minibuffer window size by setting the following variables:
201 - User option: max-mini-window-height
203 Maximum height for resizing mini-windows.  If a float, it specifies a
204 fraction of the mini-window frame's height.  If an integer, it
205 specifies a number of lines.
207 Default is 0.25.
209 - User option: resize-mini-windows
211 How to resize mini-windows.  If nil, don't resize.  If t, always
212 resize to fit the size of the text.  If `grow-only', let mini-windows
213 grow only, until they become empty, at which point they are shrunk
214 again.
216 Default is `grow-only'.
218 ** LessTif support.
220 Emacs now runs with the LessTif toolkit (see
221 <http://www.lesstif.org>).  You will need version 0.92.26, or later.
223 ** LessTif/Motif file selection dialog.
225 When Emacs is configured to use LessTif or Motif, reading a file name
226 from a menu will pop up a file selection dialog if `use-dialog-box' is
227 non-nil.
229 ** File selection dialog on MS-Windows is supported.
231 When a file is visited by clicking File->Open, the MS-Windows version
232 now pops up a standard file selection dialog where you can select a
233 file to visit.  File->Save As also pops up that dialog.
235 ** Toolkit scroll bars.
237 Emacs now uses toolkit scroll bars if available.  When configured for
238 LessTif/Motif, it will use that toolkit's scroll bar.  Otherwise, when
239 configured for Lucid and Athena widgets, it will use the Xaw3d scroll
240 bar if Xaw3d is available.  You can turn off the use of toolkit scroll
241 bars by specifying `--with-toolkit-scroll-bars=no' when configuring
242 Emacs.
244 When you encounter problems with the Xaw3d scroll bar, watch out how
245 Xaw3d is compiled on your system.  If the Makefile generated from
246 Xaw3d's Imakefile contains a `-DNARROWPROTO' compiler option, and your
247 Emacs system configuration file `s/your-system.h' does not contain a
248 define for NARROWPROTO, you might consider adding it.  Take
249 `s/freebsd.h' as an example.
251 Alternatively, if you don't have access to the Xaw3d source code, take
252 a look at your system's imake configuration file, for example in the
253 directory `/usr/X11R6/lib/X11/config' (paths are different on
254 different systems).  You will find files `*.cf' there.  If your
255 system's cf-file contains a line like `#define NeedWidePrototypes NO',
256 add a `#define NARROWPROTO' to your Emacs system configuration file.
258 The reason for this is that one Xaw3d function uses `double' or
259 `float' function parameters depending on the setting of NARROWPROTO.
260 This is not a problem when Imakefiles are used because each system's
261 imake configuration file contains the necessary information.  Since
262 Emacs doesn't use imake, this has do be done manually.
264 ** Tool bar support.
266 Emacs supports a tool bar at the top of a frame under X.  For details
267 of how to define a tool bar, see the page describing Lisp-level
268 changes.  Tool-bar global minor mode controls whether or not it is
269 displayed and is on by default.  The appearance of the bar is improved
270 if Emacs has been built with XPM image support.  Otherwise monochrome
271 icons will be used.
273 To make the tool bar more useful, we need contributions of extra icons
274 for specific modes (with copyright assignments).
276 ** Tooltips.
278 Tooltips are small X windows displaying a help string at the current
279 mouse position.  The Lisp package `tooltip' implements them.  You can
280 turn them off via the user option `tooltip-mode'.
282 Tooltips also provides support for GUD debugging.  If activated,
283 variable values can be displayed in tooltips by pointing at them with
284 the mouse in source buffers.  You can customize various aspects of the
285 tooltip display in the group `tooltip'.
287 ** Automatic Hscrolling
289 Horizontal scrolling now happens automatically if
290 `automatic-hscrolling' is set (the default).  This setting can be
291 customized.
293 If a window is scrolled horizontally with set-window-hscroll, or
294 scroll-left/scroll-right (C-x <, C-x >), this serves as a lower bound
295 for automatic horizontal scrolling.  Automatic scrolling will scroll
296 the text more to the left if necessary, but won't scroll the text more
297 to the right than the column set with set-window-hscroll etc.
299 ** When using a windowing terminal, each Emacs window now has a cursor
300 of its own.  By default, when a window is selected, the cursor is
301 solid; otherwise, it is hollow.  The user-option
302 `cursor-in-non-selected-windows' controls how to display the
303 cursor in non-selected windows.  If nil, no cursor is shown, if
304 non-nil a hollow box cursor is shown.
306 ** Fringes to the left and right of windows are used to display
307 truncation marks, continuation marks, overlay arrows and alike.  The
308 foreground, background, and stipple of these areas can be changed by
309 customizing face `fringe'.
311 ** The mode line under X is now drawn with shadows by default.
312 You can change its appearance by modifying the face `mode-line'.
313 In particular, setting the `:box' attribute to nil turns off the 3D
314 appearance of the mode line.  (The 3D appearance makes the mode line
315 occupy more space, and thus might cause the first or the last line of
316 the window to be partially obscured.)
318 The variable `mode-line-inverse-video', which was used in older
319 versions of emacs to make the mode-line stand out, is now deprecated.
320 However, setting it to nil will cause the `mode-line' face to be
321 ignored, and mode-lines to be drawn using the default text face.
323 ** Mouse-sensitive mode line.
325 Different parts of the mode line have been made mouse-sensitive on all
326 systems which support the mouse.  Moving the mouse to a
327 mouse-sensitive part in the mode line changes the appearance of the
328 mouse pointer to an arrow, and help about available mouse actions is
329 displayed either in the echo area, or in the tooltip window if you
330 have enabled one.
332 Currently, the following actions have been defined:
334 - Mouse-1 on the buffer name in the mode line goes to the next buffer.
336 - Mouse-3 on the buffer-name goes to the previous buffer.
338 - Mouse-2 on the read-only or modified status in the mode line (`%' or
339 `*') toggles the status.
341 - Mouse-3 on the major mode name displays a major mode menu.
343 - Mouse-3 on the mode name displays a minor-mode menu.
345 ** Hourglass pointer
347 Emacs can optionally display an hourglass pointer under X.  You can
348 turn the display on or off by customizing group `cursor'.
350 ** Blinking cursor
352 M-x blink-cursor-mode toggles a blinking cursor under X and on
353 terminals having terminal capabilities `vi', `vs', and `ve'.  Blinking
354 and related parameters like frequency and delay can be customized in
355 the group `cursor'.
357 ** New font-lock support mode `jit-lock-mode'.
359 This support mode is roughly equivalent to `lazy-lock' but is
360 generally faster.  It supports stealth and deferred fontification.
361 See the documentation of the function `jit-lock-mode' for more
362 details.
364 Font-lock uses jit-lock-mode as default support mode, so you don't
365 have to do anything to activate it.
367 ** The default binding of the Delete key has changed.
369 The new user-option `normal-erase-is-backspace' can be set to
370 determine the effect of the Delete and Backspace function keys.
372 On window systems, the default value of this option is chosen
373 according to the keyboard used.  If the keyboard has both a Backspace
374 key and a Delete key, and both are mapped to their usual meanings, the
375 option's default value is set to t, so that Backspace can be used to
376 delete backward, and Delete can be used to delete forward.  On
377 keyboards which either have only one key (usually labeled DEL), or two
378 keys DEL and BS which produce the same effect, the option's value is
379 set to nil, and these keys delete backward.
381 If not running under a window system, setting this option accomplishes
382 a similar effect by mapping C-h, which is usually generated by the
383 Backspace key, to DEL, and by mapping DEL to C-d via
384 `keyboard-translate'.  The former functionality of C-h is available on
385 the F1 key.  You should probably not use this setting on a text-only
386 terminal if you don't have both Backspace, Delete and F1 keys.
388 Programmatically, you can call function normal-erase-is-backspace-mode
389 to toggle the behavior of the Delete and Backspace keys.
391 ** The default for user-option `next-line-add-newlines' has been
392 changed to nil, i.e. C-n will no longer add newlines at the end of a
393 buffer by default.
395 ** The <home> and <end> keys now move to the beginning or end of the
396 current line, respectively.  C-<home> and C-<end> move to the
397 beginning and end of the buffer.
399 ** Emacs now checks for recursive loads of Lisp files.  If the
400 recursion depth exceeds `recursive-load-depth-limit', an error is
401 signaled.
403 ** When an error is signaled during the loading of the user's init
404 file, Emacs now pops up the *Messages* buffer.
406 ** Emacs now refuses to load compiled Lisp files which weren't
407 compiled with Emacs.  Set `load-dangerous-libraries' to t to change
408 this behavior.
410 The reason for this change is an incompatible change in XEmacs's byte
411 compiler.  Files compiled with XEmacs can contain byte codes that let
412 Emacs dump core.
414 ** Toggle buttons and radio buttons in menus.
416 When compiled with LessTif (or Motif) support, Emacs uses toolkit
417 widgets for radio and toggle buttons in menus.  When configured for
418 Lucid, Emacs draws radio buttons and toggle buttons similar to Motif.
420 ** The menu bar configuration has changed.  The new configuration is
421 more CUA-compliant.  The most significant change is that Options is
422 now a separate menu-bar item, with Mule and Customize as its submenus.
424 ** Item Save Options on the Options menu allows saving options set
425 using that menu.
427 ** Highlighting of trailing whitespace.
429 When `show-trailing-whitespace' is non-nil, Emacs displays trailing
430 whitespace in the face `trailing-whitespace'.  Trailing whitespace is
431 defined as spaces or tabs at the end of a line.  To avoid busy
432 highlighting when entering new text, trailing whitespace is not
433 displayed if point is at the end of the line containing the
434 whitespace.
436 ** C-x 5 1 runs the new command delete-other-frames which deletes
437 all frames except the selected one.
439 ** The new user-option `confirm-kill-emacs' can be customized to
440 let Emacs ask for confirmation before exiting.
442 ** The header line in an Info buffer is now displayed as an emacs
443 header-line (which is like a mode-line, but at the top of the window),
444 so that it remains visible even when the buffer has been scrolled.
445 This behavior may be disabled by customizing the option
446 `Info-use-header-line'.
448 ** Polish, Czech, German, and French translations of Emacs' reference card
449 have been added.  They are named `pl-refcard.tex', `cs-refcard.tex',
450 `de-refcard.tex' and `fr-refcard.tex'.  Postscript files are included.
452 ** An `Emacs Survival Guide', etc/survival.tex, is available.
454 ** A reference card for Dired has been added.  Its name is
455 `dired-ref.tex'.  A French translation is available in
456 `fr-drdref.tex'.
458 ** C-down-mouse-3 is bound differently.  Now if the menu bar is not
459 displayed it pops up a menu containing the items which would be on the
460 menu bar.  If the menu bar is displayed, it pops up the major mode
461 menu or the Edit menu if there is no major mode menu.
463 ** Variable `load-path' is no longer customizable through Customize.
465 You can no longer use `M-x customize-variable' to customize `load-path'
466 because it now contains a version-dependent component.  You can still
467 use `add-to-list' and `setq' to customize this variable in your
468 `~/.emacs' init file or to modify it from any Lisp program in general.
470 ** C-u C-x = provides detailed information about the character at
471 point in a pop-up window.
473 ** Emacs can now support 'wheeled' mice (such as the MS IntelliMouse)
474 under XFree86.  To enable this, use the `mouse-wheel-mode' command, or
475 customize the variable `mouse-wheel-mode'.
477 The variables `mouse-wheel-follow-mouse' and `mouse-wheel-scroll-amount'
478 determine where and by how much buffers are scrolled.
480 ** Emacs' auto-save list files are now by default stored in a
481 sub-directory `.emacs.d/auto-save-list/' of the user's home directory.
482 (On MS-DOS, this subdirectory's name is `_emacs.d/auto-save.list/'.)
483 You can customize `auto-save-list-file-prefix' to change this location.
485 ** The function `getenv' is now callable interactively.
487 ** The new user-option `even-window-heights' can be set to nil
488 to prevent `display-buffer' from evening out window heights.
490 ** The new command M-x delete-trailing-whitespace RET will delete the
491 trailing whitespace within the current restriction.  You can also add
492 this function to `write-file-hooks' or `local-write-file-hooks'.
494 ** When visiting a file with M-x find-file-literally, no newlines will
495 be added to the end of the buffer even if `require-final-newline' is
496 non-nil.
498 ** The new user-option `find-file-suppress-same-file-warnings' can be
499 set to suppress warnings ``X and Y are the same file'' when visiting a
500 file that is already visited under a different name.
502 ** The new user-option `electric-help-shrink-window' can be set to
503 nil to prevent adjusting the help window size to the buffer size.
505 ** New command M-x describe-character-set reads a character set name
506 and displays information about that.
508 ** The new variable `auto-mode-interpreter-regexp' contains a regular
509 expression matching interpreters, for file mode determination.
511 This regular expression is matched against the first line of a file to
512 determine the file's mode in `set-auto-mode' when Emacs can't deduce a
513 mode from the file's name.  If it matches, the file is assumed to be
514 interpreted by the interpreter matched by the second group of the
515 regular expression.  The mode is then determined as the mode
516 associated with that interpreter in `interpreter-mode-alist'.
518 ** New function executable-make-buffer-file-executable-if-script-p is
519 suitable as an after-save-hook as an alternative to `executable-chmod'.
521 ** The most preferred coding-system is now used to save a buffer if
522 buffer-file-coding-system is `undecided' and it is safe for the buffer
523 contents.  (The most preferred is set by set-language-environment or
524 by M-x prefer-coding-system.)  Thus if you visit an ASCII file and
525 insert a non-ASCII character from your current language environment,
526 the file will be saved silently with the appropriate coding.
527 Previously you would be prompted for a safe coding system.
529 ** The many obsolete language `setup-...-environment' commands have
530 been removed -- use `set-language-environment'.
532 ** The new Custom option `keyboard-coding-system' specifies a coding
533 system for keyboard input.
535 ** New variable `inhibit-iso-escape-detection' determines if Emacs'
536 coding system detection algorithm should pay attention to ISO2022's
537 escape sequences.  If this variable is non-nil, the algorithm ignores
538 such escape sequences.  The default value is nil, and it is
539 recommended not to change it except for the special case that you
540 always want to read any escape code verbatim.  If you just want to
541 read a specific file without decoding escape codes, use C-x RET c
542 (`universal-coding-system-argument').  For instance, C-x RET c latin-1
543 RET C-x C-f filename RET.
545 ** Variable `default-korean-keyboard' is initialized properly from the
546 environment variable `HANGUL_KEYBOARD_TYPE'.
548 ** New command M-x list-charset-chars reads a character set name and
549 displays all characters in that character set.
551 ** M-x set-terminal-coding-system (C-x RET t) now allows CCL-based
552 coding systems such as cpXXX and cyrillic-koi8.
554 ** Emacs now attempts to determine the initial language environment
555 and preferred and locale coding systems systematically from the
556 LC_ALL, LC_CTYPE, and LANG environment variables during startup.
558 ** New language environments `Polish', `Latin-8' and `Latin-9'.
559 Latin-8 and Latin-9 correspond respectively to the ISO character sets
560 8859-14 (Celtic) and 8859-15 (updated Latin-1, with the Euro sign).
561 GNU Intlfonts doesn't support these yet but recent X releases have
562 8859-15.  See etc/INSTALL for information on obtaining extra fonts.
563 There are new Leim input methods for Latin-8 and Latin-9 prefix (only)
564 and Polish `slash'.
566 ** New language environments `Dutch' and `Spanish'.
567 These new environments mainly select appropriate translations
568 of the tutorial.
570 ** In Ethiopic language environment, special key bindings for
571 function keys are changed as follows.  This is to conform to "Emacs
572 Lisp Coding Convention".
574     new  command                            old-binding
575     ---  -------                            -----------
576     f3   ethio-fidel-to-sera-buffer         f5
577     S-f3 ethio-fidel-to-sera-region         f5
578     C-f3 ethio-fidel-to-sera-mail-or-marker f5
580     f4   ethio-sera-to-fidel-buffer         unchanged
581     S-f4 ethio-sera-to-fidel-region         unchanged
582     C-f4 ethio-sera-to-fidel-mail-or-marker unchanged
584     S-f5 ethio-toggle-punctuation           f3
585     S-f6 ethio-modify-vowel                 f6
586     S-f7 ethio-replace-space                f7
587     S-f8 ethio-input-special-character      f8
588     S-f9 ethio-replace-space                unchanged
589     C-f9 ethio-toggle-space                 f2
591 ** There are new Leim input methods.
592 New input methods "turkish-postfix", "turkish-alt-postfix",
593 "greek-mizuochi", "TeX", and "greek-babel" are now part of the Leim
594 package.
596 ** The rule of input method "slovak" is slightly changed.  Now the
597 rules for translating "q" and "Q" to "`" (backquote) are deleted, thus
598 typing them inserts "q" and "Q" respectively.  Rules for translating
599 "=q", "+q", "=Q", and "+Q" to "`" are also deleted.  Now, to input
600 "`", you must type "=q".
602 ** When your terminal can't display characters from some of the ISO
603 8859 character sets but can display Latin-1, you can display
604 more-or-less mnemonic sequences of ASCII/Latin-1 characters instead of
605 empty boxes (under a window system) or question marks (not under a
606 window system).  Customize the option `latin1-display' to turn this
609 ** M-; now calls comment-dwim which tries to do something clever based
610 on the context.  M-x kill-comment is now an alias to comment-kill,
611 defined in newcomment.el.  You can choose different styles of region
612 commenting with the variable `comment-style'.
614 ** New user options `display-time-mail-face' and
615 `display-time-use-mail-icon' control the appearance of mode-line mail
616 indicator used by the display-time package.  On a suitable display the
617 indicator can be an icon and is mouse-sensitive.
619 ** On window-systems, additional space can be put between text lines
620 on the display using several methods
622 - By setting frame parameter `line-spacing' to PIXELS.  PIXELS must be
623 a positive integer, and specifies that PIXELS number of pixels should
624 be put below text lines on the affected frame or frames.
626 - By setting X resource `lineSpacing', class `LineSpacing'.  This is
627 equivalent to specifying the frame parameter.
629 - By specifying `--line-spacing=N' or `-lsp N' on the command line.
631 - By setting buffer-local variable `line-spacing'.  The meaning is
632 the same, but applies to the a particular buffer only.
634 ** The new command `clone-indirect-buffer' can be used to create
635 an indirect buffer that is a twin copy of the current buffer.  The
636 command `clone-indirect-buffer-other-window', bound to C-x 4 c,
637 does the same but displays the indirect buffer in another window.
639 ** New user options `backup-directory-alist' and
640 `make-backup-file-name-function' control the placement of backups,
641 typically in a single directory or in an invisible sub-directory.
643 ** New commands iso-iso2sgml and iso-sgml2iso convert between Latin-1
644 characters and the corresponding SGML (HTML) entities.
646 ** New X resources recognized
648 *** The X resource `synchronous', class `Synchronous', specifies
649 whether Emacs should run in synchronous mode.  Synchronous mode
650 is useful for debugging X problems.
652 Example:
654   emacs.synchronous: true
656 *** The X resource `visualClass, class `VisualClass', specifies the
657 visual Emacs should use.  The resource's value should be a string of
658 the form `CLASS-DEPTH', where CLASS is the name of the visual class,
659 and DEPTH is the requested color depth as a decimal number.  Valid
660 visual class names are
662   TrueColor
663   PseudoColor
664   DirectColor
665   StaticColor
666   GrayScale
667   StaticGray
669 Visual class names specified as X resource are case-insensitive, i.e.
670 `pseudocolor', `Pseudocolor' and `PseudoColor' all have the same
671 meaning.
673 The program `xdpyinfo' can be used to list the visual classes
674 supported on your display, and which depths they have.  If
675 `visualClass' is not specified, Emacs uses the display's default
676 visual.
678 Example:
680   emacs.visualClass: TrueColor-8
682 *** The X resource `privateColormap', class `PrivateColormap',
683 specifies that Emacs should use a private colormap if it is using the
684 default visual, and that visual is of class PseudoColor.  Recognized
685 resource values are `true' or `on'.
687 Example:
689   emacs.privateColormap: true
691 ** Faces and frame parameters.
693 There are four new faces `scroll-bar', `border', `cursor' and `mouse'.
694 Setting the frame parameters `scroll-bar-foreground' and
695 `scroll-bar-background' sets foreground and background color of face
696 `scroll-bar' and vice versa.  Setting frame parameter `border-color'
697 sets the background color of face `border' and vice versa.  Likewise
698 for frame parameters `cursor-color' and face `cursor', and frame
699 parameter `mouse-color' and face `mouse'.
701 Changing frame parameter `font' sets font-related attributes of the
702 `default' face and vice versa.  Setting frame parameters
703 `foreground-color' or `background-color' sets the colors of the
704 `default' face and vice versa.
706 ** New face `menu'.
708 The face `menu' can be used to change colors and font of Emacs' menus.
710 ** New frame parameter `screen-gamma' for gamma correction.
712 The new frame parameter `screen-gamma' specifies gamma-correction for
713 colors.  Its value may be nil, the default, in which case no gamma
714 correction occurs, or a number > 0, usually a float, that specifies
715 the screen gamma of a frame's display.
717 PC monitors usually have a screen gamma of 2.2.  smaller values result
718 in darker colors.  You might want to try a screen gamma of 1.5 for LCD
719 color displays.  The viewing gamma Emacs uses is 0.4545. (1/2.2).
721 The X resource name of this parameter is `screenGamma', class
722 `ScreenGamma'.
724 ** Tabs and variable-width text.
726 Tabs are now displayed with stretch properties; the width of a tab is
727 defined as a multiple of the normal character width of a frame, and is
728 independent of the fonts used in the text where the tab appears.
729 Thus, tabs can be used to line up text in different fonts.
731 ** Enhancements of the Lucid menu bar
733 *** The Lucid menu bar now supports the resource "margin".
735         emacs.pane.menubar.margin: 5
737 The default margin is 4 which makes the menu bar appear like the
738 LessTif/Motif one.
740 *** Arrows that indicate sub-menus are now drawn with shadows, as in
741 LessTif and Motif.
743 ** A block cursor can be drawn as wide as the glyph under it under X.
745 As an example: if a block cursor is over a tab character, it will be
746 drawn as wide as that tab on the display.  To do this, set
747 `x-stretch-cursor' to a non-nil value.
749 ** Empty display lines at the end of a buffer may be marked with a
750 bitmap (this is similar to the tilde displayed by vi and Less).
752 This behavior is activated by setting the buffer-local variable
753 `indicate-empty-lines' to a non-nil value.  The default value of this
754 variable is found in `default-indicate-empty-lines'.
756 ** There is a new "aggressive" scrolling method.
758 When scrolling up because point is above the window start, if the
759 value of the buffer-local variable `scroll-up-aggressively' is a
760 number, Emacs chooses a new window start so that point ends up that
761 fraction of the window's height from the top of the window.
763 When scrolling down because point is below the window end, if the
764 value of the buffer-local variable `scroll-down-aggressively' is a
765 number, Emacs chooses a new window start so that point ends up that
766 fraction of the window's height from the bottom of the window.
768 ** You can now easily create new *Info* buffers using either
769 M-x clone-buffer, C-u m <entry> RET or C-u g <entry> RET.
770 M-x clone-buffer can also be used on *Help* and several other special
771 buffers.
773 ** The command `Info-search' now uses a search history.
775 ** Listing buffers with M-x list-buffers (C-x C-b) now shows
776 abbreviated file names.  Abbreviations can be customized by changing
777 `directory-abbrev-alist'.
779 ** A new variable, backup-by-copying-when-privileged-mismatch, gives
780 the highest file uid for which backup-by-copying-when-mismatch will be
781 forced on.  The assumption is that uids less than or equal to this
782 value are special uids (root, bin, daemon, etc.--not real system
783 users) and that files owned by these users should not change ownership,
784 even if your system policy allows users other than root to edit them.
786 The default is 200; set the variable to nil to disable the feature.
788 ** The rectangle commands now avoid inserting undesirable spaces,
789 notably at the end of lines.
791 All these functions have been rewritten to avoid inserting unwanted
792 spaces, and an optional prefix now allows them to behave the old way.
794 ** The function `replace-rectangle' is an alias for `string-rectangle'.
796 ** The new command M-x string-insert-rectangle is like `string-rectangle',
797 but inserts text instead of replacing it.
799 ** The new command M-x query-replace-regexp-eval acts like
800 query-replace-regexp, but takes a Lisp expression which is evaluated
801 after each match to get the replacement text.
803 ** M-x query-replace recognizes a new command `e' (or `E') that lets
804 you edit the replacement string.
806 ** The new command mail-abbrev-complete-alias, bound to `M-TAB'
807 (if you load the library `mailabbrev'), lets you complete mail aliases
808 in the text, analogous to lisp-complete-symbol.
810 ** The variable `echo-keystrokes' may now have a floating point value.
812 ** If your init file is compiled (.emacs.elc), `user-init-file' is set
813 to the source name (.emacs.el), if that exists, after loading it.
815 ** The help string specified for a menu-item whose definition contains
816 the property `:help HELP' is now displayed under X, on MS-Windows, and
817 MS-DOS, either in the echo area or with tooltips.  Many standard menus
818 displayed by Emacs now have help strings.
821 ** New user option `read-mail-command' specifies a command to use to
822 read mail from the menu etc.
824 ** The environment variable `EMACSLOCKDIR' is no longer used on MS-Windows.
825 This environment variable was used when creating lock files.  Emacs on
826 MS-Windows does not use this variable anymore.  This change was made
827 before Emacs 21.1, but wasn't documented until now.
829 ** Highlighting of mouse-sensitive regions is now supported in the
830 MS-DOS version of Emacs.
832 ** The new command `msdos-set-mouse-buttons' forces the MS-DOS version
833 of Emacs to behave as if the mouse had a specified number of buttons.
834 This comes handy with mice that don't report their number of buttons
835 correctly.  One example is the wheeled mice, which report 3 buttons,
836 but clicks on the middle button are not passed to the MS-DOS version
837 of Emacs.
839 ** Customize changes
841 *** Customize now supports comments about customized items.  Use the
842 `State' menu to add comments, or give a prefix argument to
843 M-x customize-set-variable or M-x customize-set-value.  Note that
844 customization comments will cause the customizations to fail in
845 earlier versions of Emacs.
847 *** The new option `custom-buffer-done-function' says whether to kill
848 Custom buffers when you've done with them or just bury them (the
849 default).
851 *** If Emacs was invoked with the `-q' or `--no-init-file' options, it
852 does not allow you to save customizations in your `~/.emacs' init
853 file.  This is because saving customizations from such a session would
854 wipe out all the other customizationss you might have on your init
855 file.
857 ** If Emacs was invoked with the `-q' or `--no-init-file' options, it
858 does not save disabled and enabled commands for future sessions, to
859 avoid overwriting existing customizations of this kind that are
860 already in your init file.
862 ** New features in evaluation commands
864 *** The commands to evaluate Lisp expressions, such as C-M-x in Lisp
865 modes, C-j in Lisp Interaction mode, and M-:, now bind the variables
866 print-level, print-length, and debug-on-error based on the new
867 customizable variables eval-expression-print-level,
868 eval-expression-print-length, and eval-expression-debug-on-error.
870 The default values for the first two of these variables are 12 and 4
871 respectively, which means that `eval-expression' now prints at most
872 the first 12 members of a list and at most 4 nesting levels deep (if
873 the list is longer or deeper than that, an ellipsis `...'  is
874 printed).
876 <RET> or <mouse-2> on the printed text toggles between an abbreviated
877 printed representation and an unabbreviated one.
879 The default value of eval-expression-debug-on-error is t, so any error
880 during evaluation produces a backtrace.
882 *** The function `eval-defun' (C-M-x) now loads Edebug and instruments
883 code when called with a prefix argument.
885 ** CC mode changes.
887 Note: This release contains changes that might not be compatible with
888 current user setups (although it's believed that these
889 incompatibilities will only show in very uncommon circumstances).
890 However, since the impact is uncertain, these changes may be rolled
891 back depending on user feedback.  Therefore there's no forward
892 compatibility guarantee wrt the new features introduced in this
893 release.
895 *** The hardcoded switch to "java" style in Java mode is gone.
896 CC Mode used to automatically set the style to "java" when Java mode
897 is entered.  This has now been removed since it caused too much
898 confusion.
900 However, to keep backward compatibility to a certain extent, the
901 default value for c-default-style now specifies the "java" style for
902 java-mode, but "gnu" for all other modes (as before).  So you won't
903 notice the change if you haven't touched that variable.
905 *** New cleanups, space-before-funcall and compact-empty-funcall.
906 Two new cleanups have been added to c-cleanup-list:
908 space-before-funcall causes a space to be inserted before the opening
909 parenthesis of a function call, which gives the style "foo (bar)".
911 compact-empty-funcall causes any space before a function call opening
912 parenthesis to be removed if there are no arguments to the function.
913 It's typically useful together with space-before-funcall to get the
914 style "foo (bar)" and "foo()".
916 *** Some keywords now automatically trigger reindentation.
917 Keywords like "else", "while", "catch" and "finally" have been made
918 "electric" to make them reindent automatically when they continue an
919 earlier statement.  An example:
921 for (i = 0; i < 17; i++)
922   if (a[i])
923     res += a[i]->offset;
924 else
926 Here, the "else" should be indented like the preceding "if", since it
927 continues that statement. CC Mode will automatically reindent it after
928 the "else" has been typed in full, since it's not until then it's
929 possible to decide whether it's a new statement or a continuation of
930 the preceding "if".
932 CC Mode uses Abbrev mode to achieve this, which is therefore turned on
933 by default.
935 *** M-a and M-e now moves by sentence in multiline strings.
936 Previously these two keys only moved by sentence in comments, which
937 meant that sentence movement didn't work in strings containing
938 documentation or other natural language text.
940 The reason it's only activated in multiline strings (i.e. strings that
941 contain a newline, even when escaped by a '\') is to avoid stopping in
942 the short strings that often reside inside statements.  Multiline
943 strings almost always contain text in a natural language, as opposed
944 to other strings that typically contain format specifications,
945 commands, etc.  Also, it's not that bothersome that M-a and M-e misses
946 sentences in single line strings, since they're short anyway.
948 *** Support for autodoc comments in Pike mode.
949 Autodoc comments for Pike are used to extract documentation from the
950 source, like Javadoc in Java.  Pike mode now recognize this markup in
951 comment prefixes and paragraph starts.
953 *** The comment prefix regexps on c-comment-prefix may be mode specific.
954 When c-comment-prefix is an association list, it specifies the comment
955 line prefix on a per-mode basis, like c-default-style does.  This
956 change came about to support the special autodoc comment prefix in
957 Pike mode only.
959 *** Better handling of syntactic errors.
960 The recovery after unbalanced parens earlier in the buffer has been
961 improved; CC Mode now reports them by dinging and giving a message
962 stating the offending line, but still recovers and indent the
963 following lines in a sane way (most of the time).  An "else" with no
964 matching "if" is handled similarly.  If an error is discovered while
965 indenting a region, the whole region is still indented and the error
966 is reported afterwards.
968 *** Lineup functions may now return absolute columns.
969 A lineup function can give an absolute column to indent the line to by
970 returning a vector with the desired column as the first element.
972 *** More robust and warning-free byte compilation.
973 Although this is strictly not a user visible change (well, depending
974 on the view of a user), it's still worth mentioning that CC Mode now
975 can be compiled in the standard ways without causing trouble.  Some
976 code have also been moved between the subpackages to enhance the
977 modularity somewhat.  Thanks to Martin Buchholz for doing the
978 groundwork.
980 *** c-style-variables-are-local-p now defaults to t.
981 This is an incompatible change that has been made to make the behavior
982 of the style system wrt global variable settings less confusing for
983 non-advanced users.  If you know what this variable does you might
984 want to set it to nil in your .emacs, otherwise you probably don't
985 have to bother.
987 Defaulting c-style-variables-are-local-p to t avoids the confusing
988 situation that occurs when a user sets some style variables globally
989 and edits both a Java and a non-Java file in the same Emacs session.
990 If the style variables aren't buffer local in this case, loading of
991 the second file will cause the default style (either "gnu" or "java"
992 by default) to override the global settings made by the user.
994 *** New initialization procedure for the style system.
995 When the initial style for a buffer is determined by CC Mode (from the
996 variable c-default-style), the global values of style variables now
997 take precedence over the values specified by the chosen style.  This
998 is different than the old behavior: previously, the style-specific
999 settings would override the global settings.  This change makes it
1000 possible to do simple configuration in the intuitive way with
1001 Customize or with setq lines in one's .emacs file.
1003 By default, the global value of every style variable is the new
1004 special symbol set-from-style, which causes the value to be taken from
1005 the style system.  This means that in effect, only an explicit setting
1006 of a style variable will cause the "overriding" behavior described
1007 above.
1009 Also note that global settings override style-specific settings *only*
1010 when the initial style of a buffer is chosen by a CC Mode major mode
1011 function.  When a style is chosen in other ways --- for example, by a
1012 call like (c-set-style "gnu") in a hook, or via M-x c-set-style ---
1013 then the style-specific values take precedence over any global style
1014 values.  In Lisp terms, global values override style-specific values
1015 only when the new second argument to c-set-style is non-nil; see the
1016 function documentation for more info.
1018 The purpose of these changes is to make it easier for users,
1019 especially novice users, to do simple customizations with Customize or
1020 with setq in their .emacs files.  On the other hand, the new system is
1021 intended to be compatible with advanced users' customizations as well,
1022 such as those that choose styles in hooks or whatnot.  This new system
1023 is believed to be almost entirely compatible with current
1024 configurations, in spite of the changed precedence between style and
1025 global variable settings when a buffer's default style is set.
1027 (Thanks to Eric Eide for clarifying this explanation a bit.)
1029 **** c-offsets-alist is now a customizable variable.
1030 This became possible as a result of the new initialization behavior.
1032 This variable is treated slightly differently from the other style
1033 variables; instead of using the symbol set-from-style, it will be
1034 completed with the syntactic symbols it doesn't already contain when
1035 the style is first initialized.  This means it now defaults to the
1036 empty list to make all syntactic elements get their values from the
1037 style system.
1039 **** Compatibility variable to restore the old behavior.
1040 In case your configuration doesn't work with this change, you can set
1041 c-old-style-variable-behavior to non-nil to get the old behavior back
1042 as far as possible.
1044 *** Improvements to line breaking and text filling.
1045 CC Mode now handles this more intelligently and seamlessly wrt the
1046 surrounding code, especially inside comments.  For details see the new
1047 chapter about this in the manual.
1049 **** New variable to recognize comment line prefix decorations.
1050 The variable c-comment-prefix-regexp has been added to properly
1051 recognize the line prefix in both block and line comments.  It's
1052 primarily used to initialize the various paragraph recognition and
1053 adaptive filling variables that the text handling functions uses.
1055 **** New variable c-block-comment-prefix.
1056 This is a generalization of the now obsolete variable
1057 c-comment-continuation-stars to handle arbitrary strings.
1059 **** CC Mode now uses adaptive fill mode.
1060 This to make it adapt better to the paragraph style inside comments.
1062 It's also possible to use other adaptive filling packages inside CC
1063 Mode, notably Kyle E. Jones' Filladapt mode (http://wonderworks.com/).
1064 A new convenience function c-setup-filladapt sets up Filladapt for use
1065 inside CC Mode.
1067 Note though that the 2.12 version of Filladapt lacks a feature that
1068 causes it to work suboptimally when c-comment-prefix-regexp can match
1069 the empty string (which it commonly does).  A patch for that is
1070 available from the CC Mode web site (http://www.python.org/emacs/
1071 cc-mode/).
1073 **** The variables `c-hanging-comment-starter-p' and
1074 `c-hanging-comment-ender-p', which controlled how comment starters and
1075 enders were filled, are not used anymore.  The new version of the
1076 function `c-fill-paragraph' keeps the comment starters and enders as
1077 they were before the filling.
1079 **** It's now possible to selectively turn off auto filling.
1080 The variable c-ignore-auto-fill is used to ignore auto fill mode in
1081 specific contexts, e.g. in preprocessor directives and in string
1082 literals.
1084 **** New context sensitive line break function c-context-line-break.
1085 It works like newline-and-indent in normal code, and adapts the line
1086 prefix according to the comment style when used inside comments.  If
1087 you're normally using newline-and-indent, you might want to switch to
1088 this function.
1090 *** Fixes to IDL mode.
1091 It now does a better job in recognizing only the constructs relevant
1092 to IDL.  E.g. it no longer matches "class" as the beginning of a
1093 struct block, but it does match the CORBA 2.3 "valuetype" keyword.
1094 Thanks to Eric Eide.
1096 *** Improvements to the Whitesmith style.
1097 It now keeps the style consistently on all levels and both when
1098 opening braces hangs and when they don't.
1100 **** New lineup function c-lineup-whitesmith-in-block.
1102 *** New lineup functions c-lineup-template-args and c-indent-multi-line-block.
1103 See their docstrings for details.  c-lineup-template-args does a
1104 better job of tracking the brackets used as parens in C++ templates,
1105 and is used by default to line up continued template arguments.
1107 *** c-lineup-comment now preserves alignment with a comment on the
1108 previous line.  It used to instead preserve comments that started in
1109 the column specified by comment-column.
1111 *** c-lineup-C-comments handles "free form" text comments.
1112 In comments with a long delimiter line at the start, the indentation
1113 is kept unchanged for lines that start with an empty comment line
1114 prefix.  This is intended for the type of large block comments that
1115 contain documentation with its own formatting.  In these you normally
1116 don't want CC Mode to change the indentation.
1118 *** The `c' syntactic symbol is now relative to the comment start
1119 instead of the previous line, to make integers usable as lineup
1120 arguments.
1122 *** All lineup functions have gotten docstrings.
1124 *** More preprocessor directive movement functions.
1125 c-down-conditional does the reverse of c-up-conditional.
1126 c-up-conditional-with-else and c-down-conditional-with-else are
1127 variants of these that also stops at "#else" lines (suggested by Don
1128 Provan).
1130 *** Minor improvements to many movement functions in tricky situations.
1132 ** Dired changes
1134 *** New variable `dired-recursive-deletes' determines if the delete
1135 command will delete non-empty directories recursively.  The default
1136 is, delete only empty directories.
1138 *** New variable `dired-recursive-copies' determines if the copy
1139 command will copy directories recursively.  The default is, do not
1140 copy directories recursively.
1142 *** In command `dired-do-shell-command' (usually bound to `!') a `?'
1143 in the shell command has a special meaning similar to `*', but with
1144 the difference that the command will be run on each file individually.
1146 *** The new command `dired-find-alternate-file' (usually bound to `a')
1147 replaces the Dired buffer with the buffer for an alternate file or
1148 directory.
1150 *** The new command `dired-show-file-type' (usually bound to `y') shows
1151 a message in the echo area describing what type of file the point is on.
1152 This command invokes the external program `file' do its work, and so
1153 will only work on systems with that program, and will be only as
1154 accurate or inaccurate as it is.
1156 *** Dired now properly handles undo changes of adding/removing `-R'
1157 from ls switches.
1159 *** Dired commands that prompt for a destination file now allow the use
1160 of the `M-n' command in the minibuffer to insert the source filename,
1161 which the user can then edit.  This only works if there is a single
1162 source file, not when operating on multiple marked files.
1164 ** Gnus changes.
1166 The Gnus NEWS entries are short, but they reflect sweeping changes in
1167 four areas: Article display treatment, MIME treatment,
1168 internationalization and mail-fetching.
1170 *** The mail-fetching functions have changed.  See the manual for the
1171 many details.  In particular, all procmail fetching variables are gone.
1173 If you used procmail like in
1175 (setq nnmail-use-procmail t)
1176 (setq nnmail-spool-file 'procmail)
1177 (setq nnmail-procmail-directory "~/mail/incoming/")
1178 (setq nnmail-procmail-suffix "\\.in")
1180 this now has changed to
1182 (setq mail-sources
1183       '((directory :path "~/mail/incoming/"
1184                    :suffix ".in")))
1186 More information is available in the info doc at Select Methods ->
1187 Getting Mail -> Mail Sources
1189 *** Gnus is now a MIME-capable reader.  This affects many parts of
1190 Gnus, and adds a slew of new commands.  See the manual for details.
1191 Separate MIME packages like RMIME, mime-compose etc., will probably no
1192 longer work; remove them and use the native facilities.
1194 The FLIM/SEMI package still works with Emacs 21, but if you want to
1195 use the native facilities, you must remove any mailcap.el[c] that was
1196 installed by FLIM/SEMI version 1.13 or earlier.
1198 *** Gnus has also been multilingualized.  This also affects too many
1199 parts of Gnus to summarize here, and adds many new variables.  There
1200 are built-in facilities equivalent to those of gnus-mule.el, which is
1201 now just a compatibility layer.
1203 *** gnus-mule.el is now just a compatibility layer over the built-in
1204 Gnus facilities.
1206 *** gnus-auto-select-first can now be a function to be
1207 called to position point.
1209 *** The user can now decide which extra headers should be included in
1210 summary buffers and NOV files.
1212 *** `gnus-article-display-hook' has been removed.  Instead, a number
1213 of variables starting with `gnus-treat-' have been added.
1215 *** The Gnus posting styles have been redone again and now work in a
1216 subtly different manner.
1218 *** New web-based backends have been added: nnslashdot, nnwarchive
1219 and nnultimate.  nnweb has been revamped, again, to keep up with
1220 ever-changing layouts.
1222 *** Gnus can now read IMAP mail via nnimap.
1224 *** There is image support of various kinds and some sound support.
1226 ** Changes in Texinfo mode.
1228 *** A couple of new key bindings have been added for inserting Texinfo
1229 macros
1231   Key binding   Macro
1232   -------------------------
1233   C-c C-c C-s   @strong
1234   C-c C-c C-e   @emph
1235   C-c C-c u     @uref
1236   C-c C-c q     @quotation
1237   C-c C-c m     @email
1238   C-c C-o       @<block> ... @end <block>
1239   M-RET         @item
1241 *** The " key now inserts either " or `` or '' depending on context.
1243 ** Changes in Outline mode.
1245 There is now support for Imenu to index headings.  A new command
1246 `outline-headers-as-kill' copies the visible headings in the region to
1247 the kill ring, e.g. to produce a table of contents.
1249 ** Changes to Emacs Server
1251 *** The new option `server-kill-new-buffers' specifies what to do
1252 with buffers when done with them.  If non-nil, the default, buffers
1253 are killed, unless they were already present before visiting them with
1254 Emacs Server.  If nil, `server-temp-file-regexp' specifies which
1255 buffers to kill, as before.
1257 Please note that only buffers are killed that still have a client,
1258 i.e. buffers visited with `emacsclient --no-wait' are never killed in
1259 this way.
1261 ** Both emacsclient and Emacs itself now accept command line options
1262 of the form +LINE:COLUMN in addition to +LINE.
1264 ** Changes to Show Paren mode.
1266 *** Overlays used by Show Paren mode now use a priority property.
1267 The new user option show-paren-priority specifies the priority to
1268 use.  Default is 1000.
1270 ** New command M-x check-parens can be used to find unbalanced paren
1271 groups and strings in buffers in Lisp mode (or other modes).
1273 ** Changes to hideshow.el
1275 *** Generalized block selection and traversal
1277 A block is now recognized by its start and end regexps (both strings),
1278 and an integer specifying which sub-expression in the start regexp
1279 serves as the place where a `forward-sexp'-like function can operate.
1280 See the documentation of variable `hs-special-modes-alist'.
1282 *** During incremental search, if Hideshow minor mode is active,
1283 hidden blocks are temporarily shown.  The variable `hs-headline' can
1284 be used in the mode line format to show the line at the beginning of
1285 the open block.
1287 *** User option `hs-hide-all-non-comment-function' specifies a
1288 function to be called at each top-level block beginning, instead of
1289 the normal block-hiding function.
1291 *** The command `hs-show-region' has been removed.
1293 *** The key bindings have changed to fit the Emacs conventions,
1294 roughly imitating those of Outline minor mode.  Notably, the prefix
1295 for all bindings is now `C-c @'.  For details, see the documentation
1296 for `hs-minor-mode'.
1298 *** The variable `hs-show-hidden-short-form' has been removed, and
1299 hideshow.el now always behaves as if this variable were set to t.
1301 ** Changes to Change Log mode and Add-Log functions
1303 *** If you invoke `add-change-log-entry' from a backup file, it makes
1304 an entry appropriate for the file's parent.  This is useful for making
1305 log entries by comparing a version with deleted functions.
1307 **** New command M-x change-log-merge merges another log into the
1308 current buffer.
1310 *** New command M-x change-log-redate fixes any old-style date entries
1311 in a log file.
1313 *** Change Log mode now adds a file's version number to change log
1314 entries if user-option `change-log-version-info-enabled' is non-nil.
1315 Unless the file is under version control the search for a file's
1316 version number is performed based on regular expressions from
1317 `change-log-version-number-regexp-list' which can be customized.
1318 Version numbers are only found in the first 10 percent of a file.
1320 *** Change Log mode now defines its own faces for font-lock highlighting.
1322 ** Changes to cmuscheme
1324 *** The user-option `scheme-program-name' has been renamed
1325 `cmuscheme-program-name' due to conflicts with xscheme.el.
1327 ** Changes in Font Lock
1329 *** The new function `font-lock-remove-keywords' can be used to remove
1330 font-lock keywords from the current buffer or from a specific major mode.
1332 *** Multi-line patterns are now supported.  Modes using this, should
1333 set font-lock-multiline to t in their font-lock-defaults.
1335 *** `font-lock-syntactic-face-function' allows major-modes to choose
1336 the face used for each string/comment.
1338 *** A new standard face `font-lock-doc-face'.
1339 Meant for Lisp docstrings, Javadoc comments and other "documentation in code".
1341 ** Changes to Shell mode
1343 *** The `shell' command now accepts an optional argument to specify the buffer
1344 to use, which defaults to "*shell*".  When used interactively, a
1345 non-default buffer may be specified by giving the `shell' command a
1346 prefix argument (causing it to prompt for the buffer name).
1348 ** Comint (subshell) changes
1350 These changes generally affect all modes derived from comint mode, which
1351 include shell-mode, gdb-mode, scheme-interaction-mode, etc.
1353 *** Comint now by default interprets some carriage-control characters.
1354 Comint now removes CRs from CR LF sequences, and treats single CRs and
1355 BSs in the output in a way similar to a terminal (by deleting to the
1356 beginning of the line, or deleting the previous character,
1357 respectively).  This is achieved by adding `comint-carriage-motion' to
1358 the `comint-output-filter-functions' hook by default.
1360 *** By default, comint no longer uses the variable `comint-prompt-regexp'
1361 to distinguish prompts from user-input.  Instead, it notices which
1362 parts of the text were output by the process, and which entered by the
1363 user, and attaches `field' properties to allow emacs commands to use
1364 this information.  Common movement commands, notably beginning-of-line,
1365 respect field boundaries in a fairly natural manner.  To disable this
1366 feature, and use the old behavior, customize the user option
1367 `comint-use-prompt-regexp-instead-of-fields'.
1369 *** Comint now includes new features to send commands to running processes
1370 and redirect the output to a designated buffer or buffers.
1372 *** The command M-x comint-redirect-send-command reads a command and
1373 buffer name from the mini-buffer.  The command is sent to the current
1374 buffer's process, and its output is inserted into the specified buffer.
1376 The command M-x comint-redirect-send-command-to-process acts like
1377 M-x comint-redirect-send-command but additionally reads the name of
1378 the buffer whose process should be used from the mini-buffer.
1380 *** Packages based on comint now highlight user input and program prompts,
1381 and support choosing previous input with mouse-2.  To control these features,
1382 see the user-options `comint-highlight-input' and `comint-highlight-prompt'.
1384 *** The new command `comint-write-output' (usually bound to `C-c C-s')
1385 saves the output from the most recent command to a file.  With a prefix
1386 argument, it appends to the file.
1388 *** The command `comint-kill-output' has been renamed `comint-delete-output'
1389 (usually bound to `C-c C-o'); the old name is aliased to it for
1390 compatibility.
1392 *** The new function `comint-add-to-input-history' adds commands to the input
1393 ring (history).
1395 *** The new variable `comint-input-history-ignore' is a regexp for
1396 identifying history lines that should be ignored, like tcsh time-stamp
1397 strings, starting with a `#'.  The default value of this variable is "^#".
1399 ** Changes to Rmail mode
1401 *** The new user-option rmail-user-mail-address-regexp can be
1402 set to fine tune the identification of the correspondent when
1403 receiving new mail.  If it matches the address of the sender, the
1404 recipient is taken as correspondent of a mail.  If nil, the default,
1405 `user-login-name' and `user-mail-address' are used to exclude yourself
1406 as correspondent.
1408 Usually you don't have to set this variable, except if you collect
1409 mails sent by you under different user names.  Then it should be a
1410 regexp matching your mail addresses.
1412 *** The new user-option rmail-confirm-expunge controls whether and how
1413 to ask for confirmation before expunging deleted messages from an
1414 Rmail file.  You can choose between no confirmation, confirmation
1415 with y-or-n-p, or confirmation with yes-or-no-p.  Default is to ask
1416 for confirmation with yes-or-no-p.
1418 *** RET is now bound in the Rmail summary to rmail-summary-goto-msg,
1419 like `j'.
1421 *** There is a new user option `rmail-digest-end-regexps' that
1422 specifies the regular expressions to detect the line that ends a
1423 digest message.
1425 *** The new user option `rmail-automatic-folder-directives' specifies
1426 in which folder to put messages automatically.
1428 *** The new function `rmail-redecode-body' allows to fix a message
1429 with non-ASCII characters if Emacs happens to decode it incorrectly
1430 due to missing or malformed "charset=" header.
1432 ** The new user-option `mail-envelope-from' can be used to specify
1433 an envelope-from address different from user-mail-address.
1435 ** The variable mail-specify-envelope-from controls whether to
1436 use the -f option when sending mail.
1438 ** The Rmail command `o' (`rmail-output-to-rmail-file') now writes the
1439 current message in the internal `emacs-mule' encoding, rather than in
1440 the encoding taken from the variable `buffer-file-coding-system'.
1441 This allows to save messages whose characters cannot be safely encoded
1442 by the buffer's coding system, and makes sure the message will be
1443 displayed correctly when you later visit the target Rmail file.
1445 If you want your Rmail files be encoded in a specific coding system
1446 other than `emacs-mule', you can customize the variable
1447 `rmail-file-coding-system' to set its value to that coding system.
1449 ** Changes to TeX mode
1451 *** The default mode has been changed from `plain-tex-mode' to
1452 `latex-mode'.
1454 *** latex-mode now has a simple indentation algorithm.
1456 *** M-f and M-p jump around \begin...\end pairs.
1458 *** Added support for outline-minor-mode.
1460 ** Changes to RefTeX mode
1462 *** RefTeX has new support for index generation.  Index entries can be
1463     created with `C-c <', with completion available on index keys.
1464     Pressing `C-c /' indexes the word at the cursor with a default
1465     macro.  `C-c >' compiles all index entries into an alphabetically
1466     sorted *Index* buffer which looks like the final index.  Entries
1467     can be edited from that buffer.
1469 *** Label and citation key selection now allow to select several
1470     items and reference them together (use `m' to mark items, `a' or
1471     `A' to use all marked entries).
1473 *** reftex.el has been split into a number of smaller files to reduce
1474     memory use when only a part of RefTeX is being used.
1476 *** a new command `reftex-view-crossref-from-bibtex' (bound to `C-c &'
1477     in BibTeX-mode) can be called in a BibTeX database buffer in order
1478     to show locations in LaTeX documents where a particular entry has
1479     been cited.
1481 ** Emacs Lisp mode now allows multiple levels of outline headings.
1482 The level of a heading is determined from the number of leading
1483 semicolons in a heading line.  Toplevel forms starting with a `('
1484 in column 1 are always made leaves.
1486 ** The M-x time-stamp command (most commonly used on write-file-hooks)
1487 has the following new features:
1489 *** The patterns for finding the time stamp and for updating a pattern
1490 may match text spanning multiple lines.  For example, some people like
1491 to have the filename and date on separate lines.  The new variable
1492 time-stamp-inserts-lines controls the matching for multi-line patterns.
1494 *** More than one time stamp can be updated in the same file.  This
1495 feature is useful if you need separate time stamps in a program source
1496 file to both include in formatted documentation and insert in the
1497 compiled binary.  The same time-stamp will be written at each matching
1498 pattern.  The variable time-stamp-count enables this new feature; it
1499 defaults to 1.
1501 ** Partial Completion mode now completes environment variables in
1502 file names.
1504 ** Ispell changes
1506 *** The command `ispell' now spell-checks a region if
1507 transient-mark-mode is on, and the mark is active.  Otherwise it
1508 spell-checks the current buffer.
1510 *** Support for synchronous subprocesses - DOS/Windoze - has been
1511 added.
1513 *** An "alignment error" bug was fixed when a manual spelling
1514 correction is made and re-checked.
1516 *** Italian, Portuguese, and Slovak dictionary definitions have been added.
1518 *** Region skipping performance has been vastly improved in some
1519 cases.
1521 *** Spell checking HTML buffers has been improved and isn't so strict
1522 on syntax errors.
1524 *** The buffer-local words are now always placed on a new line at the
1525 end of the buffer.
1527 *** Spell checking now works in the MS-DOS version of Emacs.
1529 *** The variable `ispell-format-word' has been renamed to
1530 `ispell-format-word-function'.  The old name is still available as
1531 alias.
1533 ** Makefile mode changes
1535 *** The mode now uses the abbrev table `makefile-mode-abbrev-table'.
1537 *** Conditionals and include statements are now highlighted when
1538 Fontlock mode is active.
1540 ** Isearch changes
1542 *** Isearch now puts a call to `isearch-resume' in the command history,
1543 so that searches can be resumed.
1545 *** In Isearch mode, C-M-s and C-M-r are now bound like C-s and C-r,
1546 respectively, i.e. you can repeat a regexp isearch with the same keys
1547 that started the search.
1549 *** In Isearch mode, mouse-2 in the echo area now yanks the current
1550 selection into the search string rather than giving an error.
1552 *** There is a new lazy highlighting feature in incremental search.
1554 Lazy highlighting is switched on/off by customizing variable
1555 `isearch-lazy-highlight'.  When active, all matches for the current
1556 search string are highlighted.  The current match is highlighted as
1557 before using face `isearch' or `region'.  All other matches are
1558 highlighted using face `isearch-lazy-highlight-face' which defaults to
1559 `secondary-selection'.
1561 The extra highlighting makes it easier to anticipate where the cursor
1562 will end up each time you press C-s or C-r to repeat a pending search.
1563 Highlighting of these additional matches happens in a deferred fashion
1564 using "idle timers," so the cycles needed do not rob isearch of its
1565 usual snappy response.
1567 If `isearch-lazy-highlight-cleanup' is set to t, highlights for
1568 matches are automatically cleared when you end the search.  If it is
1569 set to nil, you can remove the highlights manually with `M-x
1570 isearch-lazy-highlight-cleanup'.
1572 ** VC Changes
1574 VC has been overhauled internally.  It is now modular, making it
1575 easier to plug-in arbitrary version control backends.  (See Lisp
1576 Changes for details on the new structure.)  As a result, the mechanism
1577 to enable and disable support for particular version systems has
1578 changed: everything is now controlled by the new variable
1579 `vc-handled-backends'.  Its value is a list of symbols that identify
1580 version systems; the default is '(RCS CVS SCCS).  When finding a file,
1581 each of the backends in that list is tried in order to see whether the
1582 file is registered in that backend.
1584 When registering a new file, VC first tries each of the listed
1585 backends to see if any of them considers itself "responsible" for the
1586 directory of the file (e.g. because a corresponding subdirectory for
1587 master files exists).  If none of the backends is responsible, then
1588 the first backend in the list that could register the file is chosen.
1589 As a consequence, the variable `vc-default-back-end' is now obsolete.
1591 The old variable `vc-master-templates' is also obsolete, although VC
1592 still supports it for backward compatibility.  To define templates for
1593 RCS or SCCS, you should rather use the new variables
1594 vc-{rcs,sccs}-master-templates.  (There is no such feature under CVS
1595 where it doesn't make sense.)
1597 The variables `vc-ignore-vc-files' and `vc-handle-cvs' are also
1598 obsolete now, you must set `vc-handled-backends' to nil or exclude
1599 `CVS' from the list, respectively, to achieve their effect now.
1601 *** General Changes
1603 The variable `vc-checkout-carefully' is obsolete: the corresponding
1604 checks are always done now.
1606 VC Dired buffers are now kept up-to-date during all version control
1607 operations.
1609 `vc-diff' output is now displayed in `diff-mode'.
1610 `vc-print-log' uses `log-view-mode'.
1611 `vc-log-mode' (used for *VC-Log*) has been replaced by `log-edit-mode'.
1613 The command C-x v m (vc-merge) now accepts an empty argument as the
1614 first revision number.  This means that any recent changes on the
1615 current branch should be picked up from the repository and merged into
1616 the working file (``merge news'').
1618 The commands C-x v s (vc-create-snapshot) and C-x v r
1619 (vc-retrieve-snapshot) now ask for a directory name from which to work
1620 downwards.
1622 *** Multiple Backends
1624 VC now lets you register files in more than one backend.  This is
1625 useful, for example, if you are working with a slow remote CVS
1626 repository.  You can then use RCS for local editing, and occasionally
1627 commit your changes back to CVS, or pick up changes from CVS into your
1628 local RCS archives.
1630 To make this work, the ``more local'' backend (RCS in our example)
1631 should come first in `vc-handled-backends', and the ``more remote''
1632 backend (CVS) should come later.  (The default value of
1633 `vc-handled-backends' already has it that way.)
1635 You can then commit changes to another backend (say, RCS), by typing
1636 C-u C-x v v RCS RET (i.e. vc-next-action now accepts a backend name as
1637 a revision number).  VC registers the file in the more local backend
1638 if that hasn't already happened, and commits to a branch based on the
1639 current revision number from the more remote backend.
1641 If a file is registered in multiple backends, you can switch to
1642 another one using C-x v b (vc-switch-backend).  This does not change
1643 any files, it only changes VC's perspective on the file.  Use this to
1644 pick up changes from CVS while working under RCS locally.
1646 After you are done with your local RCS editing, you can commit your
1647 changes back to CVS using C-u C-x v v CVS RET.  In this case, the
1648 local RCS archive is removed after the commit, and the log entry
1649 buffer is initialized to contain the entire RCS change log of the file.
1651 *** Changes for CVS
1653 There is a new user option, `vc-cvs-stay-local'.  If it is `t' (the
1654 default), then VC avoids network queries for files registered in
1655 remote repositories.  The state of such files is then only determined
1656 by heuristics and past information.  `vc-cvs-stay-local' can also be a
1657 regexp to match against repository hostnames; only files from hosts
1658 that match it are treated locally.  If the variable is nil, then VC
1659 queries the repository just as often as it does for local files.
1661 If `vc-cvs-stay-local' is on, then VC also makes local backups of
1662 repository versions.  This means that ordinary diffs (C-x v =) and
1663 revert operations (C-x v u) can be done completely locally, without
1664 any repository interactions at all.  The name of a local version
1665 backup of FILE is FILE.~REV.~, where REV is the repository version
1666 number.  This format is similar to that used by C-x v ~
1667 (vc-version-other-window), except for the trailing dot.  As a matter
1668 of fact, the two features can each use the files created by the other,
1669 the only difference being that files with a trailing `.' are deleted
1670 automatically after commit.  (This feature doesn't work on MS-DOS,
1671 since DOS disallows more than a single dot in the trunk of a file
1672 name.)
1674 If `vc-cvs-stay-local' is on, and there have been changes in the
1675 repository, VC notifies you about it when you actually try to commit.
1676 If you want to check for updates from the repository without trying to
1677 commit, you can either use C-x v m RET to perform an update on the
1678 current file, or you can use C-x v r RET to get an update for an
1679 entire directory tree.
1681 The new user option `vc-cvs-use-edit' indicates whether VC should call
1682 "cvs edit" to make files writeable; it defaults to `t'.  (This option
1683 is only meaningful if the CVSREAD variable is set, or if files are
1684 "watched" by other developers.)
1686 The commands C-x v s (vc-create-snapshot) and C-x v r
1687 (vc-retrieve-snapshot) are now also implemented for CVS.  If you give
1688 an empty snapshot name to the latter, that performs a `cvs update',
1689 starting at the given directory.
1691 *** Lisp Changes in VC
1693 VC has been restructured internally to make it modular.  You can now
1694 add support for arbitrary version control backends by writing a
1695 library that provides a certain set of backend-specific functions, and
1696 then telling VC to use that library.  For example, to add support for
1697 a version system named SYS, you write a library named vc-sys.el, which
1698 provides a number of functions vc-sys-... (see commentary at the top
1699 of vc.el for a detailed list of them).  To make VC use that library,
1700 you need to put it somewhere into Emacs' load path and add the symbol
1701 `SYS' to the list `vc-handled-backends'.
1703 ** The customizable EDT emulation package now supports the EDT
1704 SUBS command and EDT scroll margins.  It also works with more
1705 terminal/keyboard configurations and it now works under XEmacs.
1706 See etc/edt-user.doc for more information.
1708 ** New modes and packages
1710 *** The new global minor mode `minibuffer-electric-default-mode'
1711 automatically hides the `(default ...)' part of minibuffer prompts when
1712 the default is not applicable.
1714 *** Artist is an Emacs lisp package that allows you to draw lines,
1715 rectangles and ellipses by using your mouse and/or keyboard.  The
1716 shapes are made up with the ascii characters |, -, / and \.
1718 Features are:
1720 - Intersecting: When a `|' intersects with a `-', a `+' is
1721   drawn, like this:   |         \ /
1722                     --+--        X
1723                       |         / \
1725 - Rubber-banding: When drawing lines you can interactively see the
1726   result while holding the mouse button down and moving the mouse.  If
1727   your machine is not fast enough (a 386 is a bit too slow, but a
1728   pentium is well enough), you can turn this feature off.  You will
1729   then see 1's and 2's which mark the 1st and 2nd endpoint of the line
1730   you are drawing.
1732 - Arrows: After having drawn a (straight) line or a (straight)
1733   poly-line, you can set arrows on the line-ends by typing < or >.
1735 - Flood-filling: You can fill any area with a certain character by
1736   flood-filling.
1738 - Cut copy and paste: You can cut, copy and paste rectangular
1739   regions.  Artist also interfaces with the rect package (this can be
1740   turned off if it causes you any trouble) so anything you cut in
1741   artist can be yanked with C-x r y and vice versa.
1743 - Drawing with keys: Everything you can do with the mouse, you can
1744   also do without the mouse.
1746 - Aspect-ratio: You can set the variable artist-aspect-ratio to
1747   reflect the height-width ratio for the font you are using. Squares
1748   and circles are then drawn square/round.  Note, that once your
1749   ascii-file is shown with font with a different height-width ratio,
1750   the squares won't be square and the circles won't be round.
1752 - Drawing operations: The following drawing operations are implemented:
1754     lines               straight-lines
1755     rectangles          squares
1756     poly-lines          straight poly-lines
1757     ellipses            circles
1758     text (see-thru)     text (overwrite)
1759     spray-can           setting size for spraying
1760     vaporize line       vaporize lines
1761     erase characters    erase rectangles
1763   Straight lines are lines that go horizontally, vertically or
1764   diagonally.  Plain lines go in any direction.  The operations in
1765   the right column are accessed by holding down the shift key while
1766   drawing.
1768   It is possible to vaporize (erase) entire lines and connected lines
1769   (rectangles for example) as long as the lines being vaporized are
1770   straight and connected at their endpoints.  Vaporizing is inspired
1771   by the drawrect package by Jari Aalto <jari.aalto@poboxes.com>.
1773 - Picture mode compatibility: Artist is picture mode compatible (this
1774   can be turned off).
1776 *** The new package Eshell is an operating system command shell
1777 implemented entirely in Emacs Lisp.  Use `M-x eshell' to invoke it.
1778 It functions similarly to bash and zsh, and allows running of Lisp
1779 functions and external commands using the same syntax.  It supports
1780 history lists, aliases, extended globbing, smart scrolling, etc.  It
1781 will work on any platform Emacs has been ported to.  And since most of
1782 the basic commands -- ls, rm, mv, cp, ln, du, cat, etc. -- have been
1783 rewritten in Lisp, it offers an operating-system independent shell,
1784 all within the scope of your Emacs process.
1786 *** The new package timeclock.el is a mode is for keeping track of time
1787 intervals.  You can use it for whatever purpose you like, but the
1788 typical scenario is to keep track of how much time you spend working
1789 on certain projects.
1791 *** The new package hi-lock.el provides commands to highlight matches
1792 of interactively entered regexps.  For example,
1794   M-x highlight-regexp RET clearly RET RET
1796 will highlight all occurrences of `clearly' using a yellow background
1797 face.  New occurrences of `clearly' will be highlighted as they are
1798 typed.  `M-x unhighlight-regexp RET' will remove the highlighting.
1799 Any existing face can be used for highlighting and a set of
1800 appropriate faces is provided.  The regexps can be written into the
1801 current buffer in a form that will be recognized the next time the
1802 corresponding file is read.  There are commands to highlight matches
1803 to phrases and to highlight entire lines containing a match.
1805 *** The new package zone.el plays games with Emacs' display when
1806 Emacs is idle.
1808 *** The new package tildify.el allows to add hard spaces or other text
1809 fragments in accordance with the current major mode.
1811 *** The new package xml.el provides a simple but generic XML
1812 parser. It doesn't parse the DTDs however.
1814 *** The comment operations are now provided by the newcomment.el
1815 package which allows different styles of comment-region and should
1816 be more robust while offering the same functionality.
1817 `comment-region' now doesn't always comment a-line-at-a-time, but only
1818 comments the region, breaking the line at point if necessary.
1820 *** The Ebrowse package implements a C++ class browser and tags
1821 facilities tailored for use with C++.  It is documented in a
1822 separate Texinfo file.
1824 *** The PCL-CVS package available by either running M-x cvs-examine or
1825 by visiting a CVS administrative directory (with a prefix argument)
1826 provides an alternative interface to VC-dired for CVS.  It comes with
1827 `log-view-mode' to view RCS and SCCS logs and `log-edit-mode' used to
1828 enter check-in log messages.
1830 *** The new package called `woman' allows to browse Unix man pages
1831 without invoking external programs.
1833 The command `M-x woman' formats manual pages entirely in Emacs Lisp
1834 and then displays them, like `M-x manual-entry' does.  Unlike
1835 `manual-entry', `woman' does not invoke any external programs, so it
1836 is useful on systems such as MS-DOS/MS-Windows where the `man' and
1837 Groff or `troff' commands are not readily available.
1839 The command `M-x woman-find-file' asks for the file name of a man
1840 page, then formats and displays it like `M-x woman' does.
1842 *** The new command M-x re-builder offers a convenient interface for
1843 authoring regular expressions with immediate visual feedback.
1845 The buffer from which the command was called becomes the target for
1846 the regexp editor popping up in a separate window.  Matching text in
1847 the target buffer is immediately color marked during the editing.
1848 Each sub-expression of the regexp will show up in a different face so
1849 even complex regexps can be edited and verified on target data in a
1850 single step.
1852 On displays not supporting faces the matches instead blink like
1853 matching parens to make them stand out.  On such a setup you will
1854 probably also want to use the sub-expression mode when the regexp
1855 contains such to get feedback about their respective limits.
1857 *** glasses-mode is a minor mode that makes
1858 unreadableIdentifiersLikeThis readable.  It works as glasses, without
1859 actually modifying content of a buffer.
1861 *** The package ebnf2ps translates an EBNF to a syntactic chart in
1862 PostScript.
1864 Currently accepts ad-hoc EBNF, ISO EBNF and Bison/Yacc.
1866 The ad-hoc default EBNF syntax has the following elements:
1868     ;           comment (until end of line)
1869     A           non-terminal
1870     "C"         terminal
1871     ?C?         special
1872     $A          default non-terminal
1873     $"C"        default terminal
1874     $?C?        default special
1875     A = B.      production (A is the header and B the body)
1876     C D         sequence (C occurs before D)
1877     C | D       alternative (C or D occurs)
1878     A - B       exception (A excluding B, B without any non-terminal)
1879     n * A       repetition (A repeats n (integer) times)
1880     (C)         group (expression C is grouped together)
1881     [C]         optional (C may or not occurs)
1882     C+          one or more occurrences of C
1883     {C}+        one or more occurrences of C
1884     {C}*        zero or more occurrences of C
1885     {C}         zero or more occurrences of C
1886     C / D       equivalent to: C {D C}*
1887     {C || D}+   equivalent to: C {D C}*
1888     {C || D}*   equivalent to: [C {D C}*]
1889     {C || D}    equivalent to: [C {D C}*]
1891 Please, see ebnf2ps documentation for EBNF syntax and how to use it.
1893 *** The package align.el will align columns within a region, using M-x
1894 align.  Its mode-specific rules, based on regular expressions,
1895 determine where the columns should be split.  In C and C++, for
1896 example, it will align variable names in declaration lists, or the
1897 equal signs of assignments.
1899 *** `paragraph-indent-minor-mode' is a new minor mode supporting
1900 paragraphs in the same style as `paragraph-indent-text-mode'.
1902 *** bs.el is a new package for buffer selection similar to
1903 list-buffers or electric-buffer-list.  Use M-x bs-show to display a
1904 buffer menu with this package.  See the Custom group `bs'.
1906 *** find-lisp.el is a package emulating the Unix find command in Lisp.
1908 *** calculator.el is a small calculator package that is intended to
1909 replace desktop calculators such as xcalc and calc.exe.  Actually, it
1910 is not too small - it has more features than most desktop calculators,
1911 and can be customized easily to get many more functions.  It should
1912 not be confused with "calc" which is a much bigger mathematical tool
1913 which answers different needs.
1915 *** The minor modes cwarn-mode and global-cwarn-mode highlights
1916 suspicious C and C++ constructions.  Currently, assignments inside
1917 expressions, semicolon following `if', `for' and `while' (except, of
1918 course, after a `do .. while' statement), and C++ functions with
1919 reference parameters are recognized.  The modes require font-lock mode
1920 to be enabled.
1922 *** smerge-mode.el provides `smerge-mode', a simple minor-mode for files
1923 containing diff3-style conflict markers, such as generated by RCS.
1925 *** 5x5.el is a simple puzzle game.
1927 *** hl-line.el provides `hl-line-mode', a minor mode to highlight the
1928 current line in the current buffer.  It also provides
1929 `global-hl-line-mode' to provide the same behavior in all buffers.
1931 *** ansi-color.el translates ANSI terminal escapes into text-properties.
1933 Please note: if `ansi-color-for-comint-mode' and
1934 `global-font-lock-mode' are non-nil, loading ansi-color.el will
1935 disable font-lock and add `ansi-color-apply' to
1936 `comint-preoutput-filter-functions' for all shell-mode buffers.  This
1937 displays the output of "ls --color=yes" using the correct foreground
1938 and background colors.
1940 *** delphi.el provides a major mode for editing the Delphi (Object
1941 Pascal) language.
1943 *** quickurl.el provides a simple method of inserting a URL based on
1944 the text at point.
1946 *** sql.el provides an interface to SQL data bases.
1948 *** fortune.el uses the fortune program to create mail/news signatures.
1950 *** whitespace.el is a package for warning about and cleaning bogus
1951 whitespace in a file.
1953 *** PostScript mode (ps-mode) is a new major mode for editing PostScript
1954 files. It offers: interaction with a PostScript interpreter, including
1955 (very basic) error handling; fontification, easily customizable for
1956 interpreter messages; auto-indentation; insertion of EPSF templates and
1957 often used code snippets; viewing of BoundingBox; commenting out /
1958 uncommenting regions; conversion of 8bit characters to PostScript octal
1959 codes. All functionality is accessible through a menu.
1961 *** delim-col helps to prettify columns in a text region or rectangle.
1963 Here is an example of columns:
1965 horse   apple   bus
1966 dog     pineapple       car     EXTRA
1967 porcupine       strawberry      airplane
1969 Doing the following settings:
1971    (setq delimit-columns-str-before "[ ")
1972    (setq delimit-columns-str-after " ]")
1973    (setq delimit-columns-str-separator ", ")
1974    (setq delimit-columns-separator "\t")
1977 Selecting the lines above and typing:
1979    M-x delimit-columns-region
1981 It results:
1983 [ horse    , apple     , bus     ,       ]
1984 [ dog      , pineapple , car     , EXTRA ]
1985 [ porcupine, strawberry, airplane,       ]
1987 delim-col has the following options:
1989    delimit-columns-str-before           Specify a string to be inserted
1990                                         before all columns.
1992    delimit-columns-str-separator        Specify a string to be inserted
1993                                         between each column.
1995    delimit-columns-str-after            Specify a string to be inserted
1996                                         after all columns.
1998    delimit-columns-separator            Specify a regexp which separates
1999                                         each column.
2001 delim-col has the following commands:
2003    delimit-columns-region       Prettify all columns in a text region.
2004    delimit-columns-rectangle    Prettify all columns in a text rectangle.
2006 *** Recentf mode maintains a menu for visiting files that were
2007 operated on recently.  User option recentf-menu-filter specifies a
2008 menu filter function to change the menu appearance. For example, the
2009 recent file list can be displayed:
2011 - organized by major modes, directories or user defined rules.
2012 - sorted by file paths, file names, ascending or descending.
2013 - showing paths relative to the current default-directory
2015 The `recentf-filter-changer' menu filter function allows to
2016 dynamically change the menu appearance.
2018 *** elide-head.el provides a mechanism for eliding boilerplate header
2019 text.
2021 *** footnote.el provides `footnote-mode', a minor mode supporting use
2022 of footnotes.  It is intended for use with Message mode, but isn't
2023 specific to Message mode.
2025 *** diff-mode.el provides `diff-mode', a major mode for
2026 viewing/editing context diffs (patches).  It is selected for files
2027 with extension `.diff', `.diffs', `.patch' and `.rej'.
2029 *** EUDC, the Emacs Unified Directory Client, provides a common user
2030 interface to access directory servers using different directory
2031 protocols.  It has a separate manual.
2033 *** autoconf.el provides a major mode for editing configure.in files
2034 for Autoconf, selected automatically.
2036 *** windmove.el provides moving between windows.
2038 *** crm.el provides a facility to read multiple strings from the
2039 minibuffer with completion.
2041 *** todo-mode.el provides management of TODO lists and integration
2042 with the diary features.
2044 *** autoarg.el provides a feature reported from Twenex Emacs whereby
2045 numeric keys supply prefix args rather than self inserting.
2047 *** The function `turn-off-auto-fill' unconditionally turns off Auto
2048 Fill mode.
2050 *** pcomplete.el is a library that provides programmable completion
2051 facilities for Emacs, similar to what zsh and tcsh offer.  The main
2052 difference is that completion functions are written in Lisp, meaning
2053 they can be profiled, debugged, etc.
2055 *** antlr-mode is a new major mode for editing ANTLR grammar files.
2056 It is automatically turned on for files whose names have the extension
2057 `.g'.
2059 ** Changes in sort.el
2061 The function sort-numeric-fields interprets numbers starting with `0'
2062 as octal and numbers starting with `0x' or `0X' as hexadecimal.  The
2063 new user-option sort-numeric-base can be used to specify a default
2064 numeric base.
2066 ** Changes to Ange-ftp
2068 *** Ange-ftp allows you to specify of a port number in remote file
2069 names cleanly.  It is appended to the host name, separated by a hash
2070 sign, e.g. `/foo@bar.org#666:mumble'.  (This syntax comes from EFS.)
2072 *** If the new user-option `ange-ftp-try-passive-mode' is set, passive
2073 ftp mode will be used if the ftp client supports that.
2075 *** Ange-ftp handles the output of the w32-style clients which
2076 output ^M at the end of lines.
2078 ** The recommended way of using Iswitchb is via the new global minor
2079 mode `iswitchb-mode'.
2081 ** Just loading the msb package doesn't switch on Msb mode anymore.
2082 If you have `(require 'msb)' in your .emacs, please replace it with
2083 `(msb-mode 1)'.
2085 ** Changes in Flyspell mode
2087 *** Flyspell mode has various new options.  See the `flyspell' Custom
2088 group.
2090 *** The variable `flyspell-generic-check-word-p' has been renamed
2091 to `flyspell-generic-check-word-predicate'.  The old name is still
2092 available as alias.
2094 ** The user option `backward-delete-char-untabify-method' controls the
2095 behavior of `backward-delete-char-untabify'.  The following values
2096 are recognized:
2098 `untabify' -- turn a tab to many spaces, then delete one space;
2099 `hungry'   -- delete all whitespace, both tabs and spaces;
2100 `all'      -- delete all whitespace, including tabs, spaces and newlines;
2101 nil        -- just delete one character.
2103 Default value is `untabify'.
2105 [This change was made in Emacs 20.3 but not mentioned then.]
2107 ** In Cperl mode `cperl-invalid-face' should now be a normal face
2108 symbol, not double-quoted.
2110 ** Some packages are declared obsolete, to be removed in a future
2111 version.  They are:  auto-show, c-mode, hilit19, hscroll, ooutline,
2112 profile, rnews, rnewspost, and sc.  Their implementations have been
2113 moved to lisp/obsolete.
2115 ** auto-compression mode is no longer enabled just by loading jka-compr.el.
2116 To control it, set `auto-compression-mode' via Custom or use the
2117 `auto-compression-mode' command.
2119 ** `browse-url-gnome-moz' is a new option for
2120 `browse-url-browser-function', invoking Mozilla in GNOME, and
2121 `browse-url-kde' can be chosen for invoking the KDE browser.
2123 ** The user-option `browse-url-new-window-p' has been renamed to
2124 `browse-url-new-window-flag'.
2126 ** The functions `keep-lines', `flush-lines' and `how-many' now
2127 operate on the active region in Transient Mark mode.
2129 ** `gnus-user-agent' is a new possibility for `mail-user-agent'.  It
2130 is like `message-user-agent', but with all the Gnus paraphernalia.
2132 ** The Strokes package has been updated.  If your Emacs has XPM
2133 support, you can use it for pictographic editing.  In Strokes mode,
2134 use C-mouse-2 to compose a complex stoke and insert it into the
2135 buffer.  You can encode or decode a strokes buffer with new commands
2136 M-x strokes-encode-buffer and M-x strokes-decode-buffer.  There is a
2137 new command M-x strokes-list-strokes.
2139 ** Hexl contains a new command `hexl-insert-hex-string' which inserts
2140 a string of hexadecimal numbers read from the mini-buffer.
2142 ** Hexl mode allows to insert non-ASCII characters.
2144 The non-ASCII characters are encoded using the same encoding as the
2145 file you are visiting in Hexl mode.
2147 ** Shell script mode changes.
2149 Shell script mode (sh-script) can now indent scripts for shells
2150 derived from sh and rc.  The indentation style is customizable, and
2151 sh-script can attempt to "learn" the current buffer's style.
2153 ** Etags changes.
2155 *** In DOS, etags looks for file.cgz if it cannot find file.c.
2157 *** New option --ignore-case-regex is an alternative to --regex.  It is now
2158 possible to bind a regexp to a language, by prepending the regexp with
2159 {lang}, where lang is one of the languages that `etags --help' prints out.
2160 This feature is useful especially for regex files, where each line contains
2161 a regular expression.  The manual contains details.
2163 *** In C and derived languages, etags creates tags for function
2164 declarations when given the --declarations option.
2166 *** In C++, tags are created for "operator".  The tags have the form
2167 "operator+", without spaces between the keyword and the operator.
2169 *** You shouldn't generally need any more the -C or -c++ option: etags
2170 automatically switches to C++ parsing when it meets the `class' or
2171 `template' keywords.
2173 *** Etags now is able to delve at arbitrary deeps into nested structures in
2174 C-like languages.  Previously, it was limited to one or two brace levels.
2176 *** New language Ada: tags are functions, procedures, packages, tasks, and
2177 types.
2179 *** In Fortran, `procedure' is not tagged.
2181 *** In Java, tags are created for "interface".
2183 *** In Lisp, "(defstruct (foo", "(defun (operator" and similar constructs
2184 are now tagged.
2186 *** In makefiles, tags the targets.
2188 *** In Perl, the --globals option tags global variables.  my and local
2189 variables are tagged.
2191 *** New language Python: def and class at the beginning of a line are tags.
2193 *** .ss files are Scheme files, .pdb is Postscript with C syntax, .psw is
2194 for PSWrap.
2196 ** Changes in etags.el
2198 *** The new user-option tags-case-fold-search can be used to make
2199 tags operations case-sensitive or case-insensitive.  The default
2200 is to use the same setting as case-fold-search.
2202 *** You can display additional output with M-x tags-apropos by setting
2203 the new variable tags-apropos-additional-actions.
2205 If non-nil, the variable's value should be a list of triples (TITLE
2206 FUNCTION TO-SEARCH).  For each triple, M-x tags-apropos processes
2207 TO-SEARCH and lists tags from it.  TO-SEARCH should be an alist,
2208 obarray, or symbol.  If it is a symbol, the symbol's value is used.
2210 TITLE is a string to use to label the list of tags from TO-SEARCH.
2212 FUNCTION is a function to call when an entry is selected in the Tags
2213 List buffer.  It is called with one argument, the selected symbol.
2215 A useful example value for this variable might be something like:
2217   '(("Emacs Lisp" Info-goto-emacs-command-node obarray)
2218     ("Common Lisp" common-lisp-hyperspec common-lisp-hyperspec-obarray)
2219     ("SCWM" scwm-documentation scwm-obarray))
2221 *** The face tags-tag-face can be used to customize the appearance
2222 of tags in the output of M-x tags-apropos.
2224 *** Setting tags-apropos-verbose to a non-nil value displays the
2225 names of tags files in the *Tags List* buffer.
2227 *** You can now search for tags that are part of the filename itself.
2228 If you have tagged the files topfile.c subdir/subfile.c
2229 /tmp/tempfile.c, you can now search for tags "topfile.c", "subfile.c",
2230 "dir/sub", "tempfile", "tempfile.c".  If the tag matches the file name,
2231 point will go to the beginning of the file.
2233 *** Compressed files are now transparently supported if
2234 auto-compression-mode is active.  You can tag (with Etags) and search
2235 (with find-tag) both compressed and uncompressed files.
2237 *** Tags commands like M-x tags-search no longer change point
2238 in buffers where no match is found.  In buffers where a match is
2239 found, the original value of point is pushed on the marker ring.
2241 ** Fortran mode has a new command `fortran-strip-sequence-nos' to
2242 remove text past column 72.  The syntax class of `\' in Fortran is now
2243 appropriate for C-style escape sequences in strings.
2245 ** SGML mode's default `sgml-validate-command' is now `nsgmls'.
2247 ** A new command `view-emacs-problems' (C-h P) displays the PROBLEMS file.
2249 ** The Dabbrev package has a new user-option `dabbrev-ignored-regexps'
2250 containing a list of regular expressions.  Buffers matching a regular
2251 expression from that list, are not checked.
2253 ** Emacs can now figure out modification times of remote files.
2254 When you do C-x C-f /user@host:/path/file RET and edit the file,
2255 and someone else modifies the file, you will be prompted to revert
2256 the buffer, just like for the local files.
2258 ** The buffer menu (C-x C-b) no longer lists the *Buffer List* buffer.
2260 ** When invoked with a prefix argument, the command `list-abbrevs' now
2261 displays local abbrevs, only.
2263 ** Refill minor mode provides preliminary support for keeping
2264 paragraphs filled as you modify them.
2266 ** The variable `double-click-fuzz' specifies how much the mouse
2267 may be moved between clicks that are recognized as a pair.  Its value
2268 is measured in pixels.
2270 ** The new global minor mode `auto-image-file-mode' allows image files
2271 to be visited as images.
2273 ** Two new user-options `grep-command' and `grep-find-command'
2274 were added to compile.el.
2276 ** Withdrawn packages
2278 *** mldrag.el has been removed.  mouse.el provides the same
2279 functionality with aliases for the mldrag functions.
2281 *** eval-reg.el has been obsoleted by changes to edebug.el and removed.
2283 *** ph.el has been obsoleted by EUDC and removed.
2286 * Incompatible Lisp changes in 21.1
2288 There are a few Lisp changes which are not backwards-compatible and
2289 may require changes to existing code. Here is a list for reference.
2290 See the sections below for details.
2292 ** Since `format' preserves text properties, the idiom
2293 `(format "%s" foo)' no longer works to copy and remove properties.
2294 Use `copy-sequence' to copy the string, then use `set-text-properties'
2295 to remove the properties of the copy.
2297 ** Since the `keymap' text property now has significance, some code
2298 which uses both `local-map' and `keymap' properties (for portability)
2299 may, for instance, give rise to duplicate menus when the keymaps from
2300 these properties are active.
2302 ** The change in the treatment of non-ASCII characters in search
2303 ranges may affect some code.
2305 ** A non-nil value for the LOCAL arg of add-hook makes the hook
2306 buffer-local even if `make-local-hook' hasn't been called, which might
2307 make a difference to some code.
2309 ** The new treatment of the minibuffer prompt might affect code which
2310 operates on the minibuffer.
2312 ** The new character sets `eight-bit-control' and `eight-bit-graphic'
2313 cause `no-conversion' and `emacs-mule-unix' coding systems to produce
2314 different results when reading files with non-ASCII characters
2315 (previously, both coding systems would produce the same results).
2316 Specifically, `no-conversion' interprets each 8-bit byte as a separate
2317 character.  This makes `no-conversion' inappropriate for reading
2318 multibyte text, e.g. buffers written to disk in their internal MULE
2319 encoding (auto-saving does that, for example).  If a Lisp program
2320 reads such files with `no-conversion', each byte of the multibyte
2321 sequence, including the MULE leading codes such as \201, is treated as
2322 a separate character, which prevents them from being interpreted in
2323 the buffer as multibyte characters.
2325 Therefore, Lisp programs that read files which contain the internal
2326 MULE encoding should use `emacs-mule-unix'.  `no-conversion' is only
2327 appropriate for reading truly binary files.
2329 ** Code that relies on the obsolete `before-change-function' and
2330 `after-change-function' to detect buffer changes will now fail.  Use
2331 `before-change-functions' and `after-change-functions' instead.
2333 ** Code that uses `concat' with integer args now gets an error, as
2334 long promised.  So does any code that uses derivatives of `concat',
2335 such as `mapconcat'.
2337 ** The function base64-decode-string now always returns a unibyte
2338 string.
2340 ** Not a Lisp incompatibility as such but, with the introduction of
2341 extra private charsets, there is now only one slot free for a new
2342 dimension-2 private charset.  User code which tries to add more than
2343 one extra will fail unless you rebuild Emacs with some standard
2344 charset(s) removed; that is probably inadvisable because it changes
2345 the emacs-mule encoding.  Also, files stored in the emacs-mule
2346 encoding using Emacs 20 with additional private charsets defined will
2347 probably not be read correctly by Emacs 21.
2349 ** The variable `directory-sep-char' is slated for removal.
2350 Not really a change (yet), but a projected one that you should be
2351 aware of: The variable `directory-sep-char' is deprecated, and should
2352 not be used.  It was always ignored on GNU/Linux and Unix systems and
2353 on MS-DOS, but the MS-Windows port tried to support it by adapting the
2354 behavior of certain primitives to the value of this variable.  It
2355 turned out that such support cannot be reliable, so it was decided to
2356 remove this variable in the near future.  Lisp programs are well
2357 advised not to set it to anything but '/', because any different value
2358 will not have any effect when support for this variable is removed.
2361 * Lisp changes made after edition 2.6 of the Emacs Lisp Manual,
2362 (Display-related features are described in a page of their own below.)
2364 ** Function assq-delete-all replaces function assoc-delete-all.
2366 ** The new function animate-string, from lisp/play/animate.el
2367 allows the animated display of strings.
2369 ** The new function `interactive-form' can be used to obtain the
2370 interactive form of a function.
2372 ** The keyword :set-after in defcustom allows to specify dependencies
2373 between custom options.  Example:
2375   (defcustom default-input-method nil
2376     "*Default input method for multilingual text (a string).
2377   This is the input method activated automatically by the command
2378   `toggle-input-method' (\\[toggle-input-method])."
2379     :group 'mule
2380     :type '(choice (const nil) string)
2381     :set-after '(current-language-environment))
2383 This specifies that default-input-method should be set after
2384 current-language-environment even if default-input-method appears
2385 first in a custom-set-variables statement.
2387 ** The new hook `kbd-macro-termination-hook' is run at the end of
2388 function execute-kbd-macro.  Functions on this hook are called with no
2389 args.  The hook is run independent of how the macro was terminated
2390 (signal or normal termination).
2392 ** Functions `butlast' and `nbutlast' for removing trailing elements
2393 from a list are now available without requiring the CL package.
2395 ** The new user-option `even-window-heights' can be set to nil
2396 to prevent `display-buffer' from evening out window heights.
2398 ** The user-option `face-font-registry-alternatives' specifies
2399 alternative font registry names to try when looking for a font.
2401 ** Function `md5' calculates the MD5 "message digest"/"checksum".
2403 ** Function `delete-frame' runs `delete-frame-hook' before actually
2404 deleting the frame.  The hook is called with one arg, the frame
2405 being deleted.
2407 ** `add-hook' now makes the hook local if called with a non-nil LOCAL arg.
2409 ** The treatment of non-ASCII characters in search ranges has changed.
2410 If a range in a regular expression or the arg of
2411 skip-chars-forward/backward starts with a unibyte character C and ends
2412 with a multibyte character C2, the range is divided into two: one is
2413 C..?\377, the other is C1..C2, where C1 is the first character of C2's
2414 charset.
2416 ** The new function `display-message-or-buffer' displays a message in
2417 the echo area or pops up a buffer, depending on the length of the
2418 message.
2420 ** The new macro `with-auto-compression-mode' allows evaluating an
2421 expression with auto-compression-mode enabled.
2423 ** In image specifications, `:heuristic-mask' has been replaced
2424 with the more general `:mask' property.
2426 ** Image specifications accept more `:conversion's.
2428 ** A `?' can be used in a symbol name without escaping it with a
2429 backslash.
2431 ** Reading from the mini-buffer now reads from standard input if Emacs
2432 is running in batch mode.  For example,
2434   (message "%s" (read t))
2436 will read a Lisp expression from standard input and print the result
2437 to standard output.
2439 ** The argument of `down-list', `backward-up-list', `up-list',
2440 `kill-sexp', `backward-kill-sexp' and `mark-sexp' is now optional.
2442 ** If `display-buffer-reuse-frames' is set, function `display-buffer'
2443 will raise frames displaying a buffer, instead of creating a new
2444 frame or window.
2446 ** Two new functions for removing elements from lists/sequences
2447 were added
2449 - Function: remove ELT SEQ
2451 Return a copy of SEQ with all occurrences of ELT removed.  SEQ must be
2452 a list, vector, or string.  The comparison is done with `equal'.
2454 - Function: remq ELT LIST
2456 Return a copy of LIST with all occurrences of ELT removed.  The
2457 comparison is done with `eq'.
2459 ** The function `delete' now also works with vectors and strings.
2461 ** The meaning of the `:weakness WEAK' argument of make-hash-table
2462 has been changed: WEAK can now have new values `key-or-value' and
2463 `key-and-value', in addition to `nil', `key', `value', and `t'.
2465 ** Function `aset' stores any multibyte character in any string
2466 without signaling "Attempt to change char length of a string".  It may
2467 convert a unibyte string to multibyte if necessary.
2469 ** The value of the `help-echo' text property is called as a function
2470 or evaluated, if it is not a string already, to obtain a help string.
2472 ** Function `make-obsolete' now has an optional arg to say when the
2473 function was declared obsolete.
2475 ** Function `plist-member' is renamed from `widget-plist-member' (which is
2476 retained as an alias).
2478 ** Easy-menu's :filter now takes the unconverted form of the menu and
2479 the result is automatically converted to Emacs' form.
2481 ** The new function `window-list' has been defined
2483 - Function: window-list &optional FRAME WINDOW MINIBUF
2485 Return a list of windows on FRAME, starting with WINDOW.  FRAME nil or
2486 omitted means use the selected frame.  WINDOW nil or omitted means use
2487 the selected window.  MINIBUF t means include the minibuffer window,
2488 even if it isn't active.  MINIBUF nil or omitted means include the
2489 minibuffer window only if it's active.  MINIBUF neither nil nor t
2490 means never include the minibuffer window.
2492 ** There's a new function `get-window-with-predicate' defined as follows
2494 - Function: get-window-with-predicate PREDICATE &optional MINIBUF ALL-FRAMES DEFAULT
2496 Return a window satisfying PREDICATE.
2498 This function cycles through all visible windows using `walk-windows',
2499 calling PREDICATE on each one.  PREDICATE is called with a window as
2500 argument.  The first window for which PREDICATE returns a non-nil
2501 value is returned.  If no window satisfies PREDICATE, DEFAULT is
2502 returned.
2504 Optional second arg MINIBUF t means count the minibuffer window even
2505 if not active.  MINIBUF nil or omitted means count the minibuffer iff
2506 it is active.  MINIBUF neither t nor nil means not to count the
2507 minibuffer even if it is active.
2509 Several frames may share a single minibuffer; if the minibuffer
2510 counts, all windows on all frames that share that minibuffer count
2511 too.  Therefore, if you are using a separate minibuffer frame
2512 and the minibuffer is active and MINIBUF says it counts,
2513 `walk-windows' includes the windows in the frame from which you
2514 entered the minibuffer, as well as the minibuffer window.
2516 ALL-FRAMES is the optional third argument.
2517 ALL-FRAMES nil or omitted means cycle within the frames as specified above.
2518 ALL-FRAMES = `visible' means include windows on all visible frames.
2519 ALL-FRAMES = 0 means include windows on all visible and iconified frames.
2520 ALL-FRAMES = t means include windows on all frames including invisible frames.
2521 If ALL-FRAMES is a frame, it means include windows on that frame.
2522 Anything else means restrict to the selected frame.
2524 ** The function `single-key-description' now encloses function key and
2525 event names in angle brackets.  When called with a second optional
2526 argument non-nil, angle brackets won't be printed.
2528 ** If the variable `message-truncate-lines' is bound to t around a
2529 call to `message', the echo area will not be resized to display that
2530 message; it will be truncated instead, as it was done in 20.x.
2531 Default value is nil.
2533 ** The user option `line-number-display-limit' can now be set to nil,
2534 meaning no limit.
2536 ** The new user option `line-number-display-limit-width' controls
2537 the maximum width of lines in a buffer for which Emacs displays line
2538 numbers in the mode line.  The default is 200.
2540 ** `select-safe-coding-system' now also checks the most preferred
2541 coding-system if buffer-file-coding-system is `undecided' and
2542 DEFAULT-CODING-SYSTEM is not specified,
2544 ** The function `subr-arity' provides information about the argument
2545 list of a primitive.
2547 ** `where-is-internal' now also accepts a list of keymaps.
2549 ** The text property `keymap' specifies a key map which overrides the
2550 buffer's local map and the map specified by the `local-map' property.
2551 This is probably what most current uses of `local-map' want, rather
2552 than replacing the local map.
2554 ** The obsolete variables `before-change-function' and
2555 `after-change-function' are no longer acted upon and have been
2556 removed.  Use `before-change-functions' and `after-change-functions'
2557 instead.
2559 ** The function `apropos-mode' runs the hook `apropos-mode-hook'.
2561 ** `concat' no longer accepts individual integer arguments,
2562 as promised long ago.
2564 ** The new function `float-time' returns the current time as a float.
2566 ** The new variable auto-coding-regexp-alist specifies coding systems
2567 for reading specific files, analogous to auto-coding-alist, but
2568 patterns are checked against file contents instead of file names.
2571 * Lisp changes in Emacs 21.1 (see following page for display-related features)
2573 ** The new package rx.el provides an alternative sexp notation for
2574 regular expressions.
2576 - Function: rx-to-string SEXP
2578 Translate SEXP into a regular expression in string notation.
2580 - Macro: rx SEXP
2582 Translate SEXP into a regular expression in string notation.
2584 The following are valid subforms of regular expressions in sexp
2585 notation.
2587 STRING
2588      matches string STRING literally.
2590 CHAR
2591      matches character CHAR literally.
2593 `not-newline'
2594      matches any character except a newline.
2595                         .
2596 `anything'
2597      matches any character
2599 `(any SET)'
2600      matches any character in SET.  SET may be a character or string.
2601      Ranges of characters can be specified as `A-Z' in strings.
2603 '(in SET)'
2604      like `any'.
2606 `(not (any SET))'
2607      matches any character not in SET
2609 `line-start'
2610      matches the empty string, but only at the beginning of a line
2611      in the text being matched
2613 `line-end'
2614      is similar to `line-start' but matches only at the end of a line
2616 `string-start'
2617      matches the empty string, but only at the beginning of the
2618      string being matched against.
2620 `string-end'
2621      matches the empty string, but only at the end of the
2622      string being matched against.
2624 `buffer-start'
2625      matches the empty string, but only at the beginning of the
2626      buffer being matched against.
2628 `buffer-end'
2629      matches the empty string, but only at the end of the
2630      buffer being matched against.
2632 `point'
2633      matches the empty string, but only at point.
2635 `word-start'
2636      matches the empty string, but only at the beginning or end of a
2637      word.
2639 `word-end'
2640      matches the empty string, but only at the end of a word.
2642 `word-boundary'
2643      matches the empty string, but only at the beginning or end of a
2644      word.
2646 `(not word-boundary)'
2647      matches the empty string, but not at the beginning or end of a
2648      word.
2650 `digit'
2651      matches 0 through 9.
2653 `control'
2654      matches ASCII control characters.
2656 `hex-digit'
2657      matches 0 through 9, a through f and A through F.
2659 `blank'
2660      matches space and tab only.
2662 `graphic'
2663      matches graphic characters--everything except ASCII control chars,
2664      space, and DEL.
2666 `printing'
2667      matches printing characters--everything except ASCII control chars
2668      and DEL.
2670 `alphanumeric'
2671      matches letters and digits.  (But at present, for multibyte characters,
2672      it matches anything that has word syntax.)
2674 `letter'
2675      matches letters.  (But at present, for multibyte characters,
2676      it matches anything that has word syntax.)
2678 `ascii'
2679      matches ASCII (unibyte) characters.
2681 `nonascii'
2682      matches non-ASCII (multibyte) characters.
2684 `lower'
2685      matches anything lower-case.
2687 `upper'
2688      matches anything upper-case.
2690 `punctuation'
2691      matches punctuation.  (But at present, for multibyte characters,
2692      it matches anything that has non-word syntax.)
2694 `space'
2695      matches anything that has whitespace syntax.
2697 `word'
2698      matches anything that has word syntax.
2700 `(syntax SYNTAX)'
2701      matches a character with syntax SYNTAX.  SYNTAX must be one
2702      of the following symbols.
2704      `whitespace'               (\\s- in string notation)
2705      `punctuation'              (\\s.)
2706      `word'                     (\\sw)
2707      `symbol'                   (\\s_)
2708      `open-parenthesis'         (\\s()
2709      `close-parenthesis'        (\\s))
2710      `expression-prefix'        (\\s')
2711      `string-quote'             (\\s\")
2712      `paired-delimiter'         (\\s$)
2713      `escape'                   (\\s\\)
2714      `character-quote'          (\\s/)
2715      `comment-start'            (\\s<)
2716      `comment-end'              (\\s>)
2718 `(not (syntax SYNTAX))'
2719      matches a character that has not syntax SYNTAX.
2721 `(category CATEGORY)'
2722      matches a character with category CATEGORY.  CATEGORY must be
2723      either a character to use for C, or one of the following symbols.
2725      `consonant'                        (\\c0 in string notation)
2726      `base-vowel'                       (\\c1)
2727      `upper-diacritical-mark'           (\\c2)
2728      `lower-diacritical-mark'           (\\c3)
2729      `tone-mark'                        (\\c4)
2730      `symbol'                           (\\c5)
2731      `digit'                            (\\c6)
2732      `vowel-modifying-diacritical-mark' (\\c7)
2733      `vowel-sign'                       (\\c8)
2734      `semivowel-lower'                  (\\c9)
2735      `not-at-end-of-line'               (\\c<)
2736      `not-at-beginning-of-line'         (\\c>)
2737      `alpha-numeric-two-byte'           (\\cA)
2738      `chinse-two-byte'                  (\\cC)
2739      `greek-two-byte'                   (\\cG)
2740      `japanese-hiragana-two-byte'       (\\cH)
2741      `indian-two-byte'                  (\\cI)
2742      `japanese-katakana-two-byte'       (\\cK)
2743      `korean-hangul-two-byte'           (\\cN)
2744      `cyrillic-two-byte'                (\\cY)
2745      `ascii'                            (\\ca)
2746      `arabic'                           (\\cb)
2747      `chinese'                          (\\cc)
2748      `ethiopic'                         (\\ce)
2749      `greek'                            (\\cg)
2750      `korean'                           (\\ch)
2751      `indian'                           (\\ci)
2752      `japanese'                         (\\cj)
2753      `japanese-katakana'                (\\ck)
2754      `latin'                            (\\cl)
2755      `lao'                              (\\co)
2756      `tibetan'                          (\\cq)
2757      `japanese-roman'                   (\\cr)
2758      `thai'                             (\\ct)
2759      `vietnamese'                       (\\cv)
2760      `hebrew'                           (\\cw)
2761      `cyrillic'                         (\\cy)
2762      `can-break'                        (\\c|)
2764 `(not (category CATEGORY))'
2765      matches a character that has not category CATEGORY.
2767 `(and SEXP1 SEXP2 ...)'
2768      matches what SEXP1 matches, followed by what SEXP2 matches, etc.
2770 `(submatch SEXP1 SEXP2 ...)'
2771      like `and', but makes the match accessible with `match-end',
2772      `match-beginning', and `match-string'.
2774 `(group SEXP1 SEXP2 ...)'
2775      another name for `submatch'.
2777 `(or SEXP1 SEXP2 ...)'
2778      matches anything that matches SEXP1 or SEXP2, etc.  If all
2779      args are strings, use `regexp-opt' to optimize the resulting
2780      regular expression.
2782 `(minimal-match SEXP)'
2783      produce a non-greedy regexp for SEXP.  Normally, regexps matching
2784      zero or more occurrences of something are \"greedy\" in that they
2785      match as much as they can, as long as the overall regexp can
2786      still match.  A non-greedy regexp matches as little as possible.
2788 `(maximal-match SEXP)'
2789      produce a greedy regexp for SEXP.  This is the default.
2791 `(zero-or-more SEXP)'
2792      matches zero or more occurrences of what SEXP matches.
2794 `(0+ SEXP)'
2795      like `zero-or-more'.
2797 `(* SEXP)'
2798      like `zero-or-more', but always produces a greedy regexp.
2800 `(*? SEXP)'
2801      like `zero-or-more', but always produces a non-greedy regexp.
2803 `(one-or-more SEXP)'
2804      matches one or more occurrences of A.
2806 `(1+ SEXP)'
2807      like `one-or-more'.
2809 `(+ SEXP)'
2810      like `one-or-more', but always produces a greedy regexp.
2812 `(+? SEXP)'
2813      like `one-or-more', but always produces a non-greedy regexp.
2815 `(zero-or-one SEXP)'
2816      matches zero or one occurrences of A.
2818 `(optional SEXP)'
2819      like `zero-or-one'.
2821 `(? SEXP)'
2822      like `zero-or-one', but always produces a greedy regexp.
2824 `(?? SEXP)'
2825      like `zero-or-one', but always produces a non-greedy regexp.
2827 `(repeat N SEXP)'
2828      matches N occurrences of what SEXP matches.
2830 `(repeat N M SEXP)'
2831      matches N to M occurrences of what SEXP matches.
2833 `(eval FORM)'
2834       evaluate FORM and insert result.  If result is a string,
2835       `regexp-quote' it.
2837 `(regexp REGEXP)'
2838       include REGEXP in string notation in the result.
2840 *** The features `md5' and `overlay' are now provided by default.
2842 *** The special form `save-restriction' now works correctly even if the
2843 buffer is widened inside the save-restriction and changes made outside
2844 the original restriction.  Previously, doing this would cause the saved
2845 restriction to be restored incorrectly.
2847 *** The functions `find-charset-region' and `find-charset-string' include
2848 `eight-bit-control' and/or `eight-bit-graphic' in the returned list
2849 when they find 8-bit characters.  Previously, they included `ascii' in a
2850 multibyte buffer and `unknown' in a unibyte buffer.
2852 *** The functions `set-buffer-multibyte', `string-as-multibyte' and
2853 `string-as-unibyte' change the byte sequence of a buffer or a string
2854 if it contains a character from the `eight-bit-control' character set.
2856 *** The handling of multibyte sequences in a multibyte buffer is
2857 changed.  Previously, a byte sequence matching the pattern
2858 [\200-\237][\240-\377]+ was interpreted as a single character
2859 regardless of the length of the trailing bytes [\240-\377]+.  Thus, if
2860 the sequence was longer than what the leading byte indicated, the
2861 extra trailing bytes were ignored by Lisp functions.  Now such extra
2862 bytes are independent 8-bit characters belonging to the charset
2863 eight-bit-graphic.
2865 ** Fontsets are now implemented using char-tables.
2867 A fontset can now be specified for each independent character, for
2868 a group of characters or for a character set rather than just for a
2869 character set as previously.
2871 *** The arguments of the function `set-fontset-font' are changed.
2872 They are NAME, CHARACTER, FONTNAME, and optional FRAME.  The function
2873 modifies fontset NAME to use FONTNAME for CHARACTER.
2875 CHARACTER may be a cons (FROM . TO), where FROM and TO are non-generic
2876 characters.  In that case FONTNAME is used for all characters in the
2877 range FROM and TO (inclusive).  CHARACTER may be a charset.  In that
2878 case FONTNAME is used for all character in the charset.
2880 FONTNAME may be a cons (FAMILY . REGISTRY), where FAMILY is the family
2881 name of a font and REGISTRY is a registry name of a font.
2883 *** Variable x-charset-registry has been deleted.  The default charset
2884 registries of character sets are set in the default fontset
2885 "fontset-default".
2887 *** The function `create-fontset-from-fontset-spec' ignores the second
2888 argument STYLE-VARIANT.  It never creates style-variant fontsets.
2890 ** The method of composing characters is changed.  Now character
2891 composition is done by a special text property `composition' in
2892 buffers and strings.
2894 *** Charset composition is deleted.  Emacs never creates a `composite
2895 character' which is an independent character with a unique character
2896 code.  Thus the following functions handling `composite characters'
2897 have been deleted: composite-char-component,
2898 composite-char-component-count, composite-char-composition-rule,
2899 composite-char-composition-rule and decompose-composite-char delete.
2900 The variables leading-code-composition and min-composite-char have
2901 also been deleted.
2903 *** Three more glyph reference points are added.  They can be used to
2904 specify a composition rule.  See the documentation of the variable
2905 `reference-point-alist' for more detail.
2907 *** The function `compose-region' takes new arguments COMPONENTS and
2908 MODIFICATION-FUNC.  With COMPONENTS, you can specify not only a
2909 composition rule but also characters to be composed.  Such characters
2910 may differ between buffer and string text.
2912 *** The function `compose-string' takes new arguments START, END,
2913 COMPONENTS, and MODIFICATION-FUNC.
2915 *** The function `compose-string' puts text property `composition'
2916 directly on the argument STRING instead of returning a new string.
2917 Likewise, the function `decompose-string' just removes text property
2918 `composition' from STRING.
2920 *** The new function `find-composition' returns information about
2921 a composition at a specified position in a buffer or a string.
2923 *** The function `decompose-composite-char' is now labeled as
2924 obsolete.
2926 ** The new coding system `mac-roman' is primarily intended for use on
2927 the Macintosh but may be used generally for Macintosh-encoded text.
2929 ** The new character sets `mule-unicode-0100-24ff',
2930 `mule-unicode-2500-33ff', and `mule-unicode-e000-ffff' have been
2931 introduced for Unicode characters in the range U+0100..U+24FF,
2932 U+2500..U+33FF, U+E000..U+FFFF respectively.
2934 Note that the character sets are not yet unified in Emacs, so
2935 characters which belong to charsets such as Latin-2, Greek, Hebrew,
2936 etc. and the same characters in the `mule-unicode-*' charsets are
2937 different characters, as far as Emacs is concerned.  For example, text
2938 which includes Unicode characters from the Latin-2 locale cannot be
2939 encoded by Emacs with ISO 8859-2 coding system.
2941 ** The new coding system `mule-utf-8' has been added.
2942 It provides limited support for decoding/encoding UTF-8 text.  For
2943 details, please see the documentation string of this coding system.
2945 ** The new character sets `japanese-jisx0213-1' and
2946 `japanese-jisx0213-2' have been introduced for the new Japanese
2947 standard JIS X 0213 Plane 1 and Plane 2.
2949 ** The new character sets `latin-iso8859-14' and `latin-iso8859-15'
2950 have been introduced.
2952 ** The new character sets `eight-bit-control' and `eight-bit-graphic'
2953 have been introduced for 8-bit characters in the ranges 0x80..0x9F and
2954 0xA0..0xFF respectively.  Note that the multibyte representation of
2955 eight-bit-control is never exposed; this leads to an exception in the
2956 emacs-mule coding system, which encodes everything else to the
2957 buffer/string internal representation.  Note that to search for
2958 eight-bit-graphic characters in a multibyte buffer, the search string
2959 must be multibyte, otherwise such characters will be converted to
2960 their multibyte equivalent.
2962 ** If the APPEND argument of `write-region' is an integer, it seeks to
2963 that offset in the file before writing.
2965 ** The function `add-minor-mode' has been added for convenience and
2966 compatibility with XEmacs (and is used internally by define-minor-mode).
2968 ** The function `shell-command' now sets the default directory of the
2969 `*Shell Command Output*' buffer to the default directory of the buffer
2970 from which the command was issued.
2972 ** The functions `query-replace', `query-replace-regexp',
2973 `query-replace-regexp-eval' `map-query-replace-regexp',
2974 `replace-string', `replace-regexp', and `perform-replace' take two
2975 additional optional arguments START and END that specify the region to
2976 operate on.
2978 ** The new function `count-screen-lines' is a more flexible alternative
2979 to `window-buffer-height'.
2981 - Function: count-screen-lines &optional BEG END COUNT-FINAL-NEWLINE WINDOW
2983 Return the number of screen lines in the region between BEG and END.
2984 The number of screen lines may be different from the number of actual
2985 lines, due to line breaking, display table, etc.
2987 Optional arguments BEG and END default to `point-min' and `point-max'
2988 respectively.
2990 If region ends with a newline, ignore it unless optional third argument
2991 COUNT-FINAL-NEWLINE is non-nil.
2993 The optional fourth argument WINDOW specifies the window used for
2994 obtaining parameters such as width, horizontal scrolling, and so
2995 on. The default is to use the selected window's parameters.
2997 Like `vertical-motion', `count-screen-lines' always uses the current
2998 buffer, regardless of which buffer is displayed in WINDOW. This makes
2999 possible to use `count-screen-lines' in any buffer, whether or not it
3000 is currently displayed in some window.
3002 ** The new function `mapc' is like `mapcar' but doesn't collect the
3003 argument function's results.
3005 ** The functions base64-decode-region and base64-decode-string now
3006 signal an error instead of returning nil if decoding fails.  Also,
3007 `base64-decode-string' now always returns a unibyte string (in Emacs
3008 20, it returned a multibyte string when the result was a valid multibyte
3009 sequence).
3011 ** The function sendmail-user-agent-compose now recognizes a `body'
3012 header in the list of headers passed to it.
3014 ** The new function member-ignore-case works like `member', but
3015 ignores differences in case and text representation.
3017 ** The buffer-local variable cursor-type can be used to specify the
3018 cursor to use in windows displaying a buffer.  Values are interpreted
3019 as follows:
3021   t             use the cursor specified for the frame (default)
3022   nil           don't display a cursor
3023   `bar'         display a bar cursor with default width
3024   (bar . WIDTH) display a bar cursor with width WIDTH
3025   others        display a box cursor.
3027 ** The variable open-paren-in-column-0-is-defun-start controls whether
3028 an open parenthesis in column 0 is considered to be the start of a
3029 defun.  If set, the default, it is considered a defun start.  If not
3030 set, an open parenthesis in column 0 has no special meaning.
3032 ** The new function `string-to-syntax' can be used to translate syntax
3033 specifications in string form as accepted by `modify-syntax-entry' to
3034 the cons-cell form that is used for the values of the `syntax-table'
3035 text property, and in `font-lock-syntactic-keywords'.
3037 Example:
3039   (string-to-syntax "()")
3040     => (4 . 41)
3042 ** Emacs' reader supports CL read syntax for integers in bases
3043 other than 10.
3045 *** `#BINTEGER' or `#bINTEGER' reads INTEGER in binary (radix 2).
3046 INTEGER optionally contains a sign.
3048   #b1111
3049     => 15
3050   #b-1111
3051     => -15
3053 *** `#OINTEGER' or `#oINTEGER' reads INTEGER in octal (radix 8).
3055   #o666
3056     => 438
3058 *** `#XINTEGER' or `#xINTEGER' reads INTEGER in hexadecimal (radix 16).
3060   #xbeef
3061     => 48815
3063 *** `#RADIXrINTEGER' reads INTEGER in radix RADIX, 2 <= RADIX <= 36.
3065   #2R-111
3066     => -7
3067   #25rah
3068     => 267
3070 ** The function `documentation-property' now evaluates the value of
3071 the given property to obtain a string if it doesn't refer to etc/DOC
3072 and isn't a string.
3074 ** If called for a symbol, the function `documentation' now looks for
3075 a `function-documentation' property of that symbol.  If it has a non-nil
3076 value, the documentation is taken from that value.  If the value is
3077 not a string, it is evaluated to obtain a string.
3079 ** The last argument of `define-key-after' defaults to t for convenience.
3081 ** The new function `replace-regexp-in-string' replaces all matches
3082 for a regexp in a string.
3084 ** `mouse-position' now runs the abnormal hook
3085 `mouse-position-function'.
3087 ** The function string-to-number now returns a float for numbers
3088 that don't fit into a Lisp integer.
3090 ** The variable keyword-symbols-constants-flag has been removed.
3091 Keywords are now always considered constants.
3093 ** The new function `delete-and-extract-region' deletes text and
3094 returns it.
3096 ** The function `clear-this-command-keys' now also clears the vector
3097 returned by function `recent-keys'.
3099 ** Variables `beginning-of-defun-function' and `end-of-defun-function'
3100 can be used to define handlers for the functions that find defuns.
3101 Major modes can define these locally instead of rebinding C-M-a
3102 etc. if the normal conventions for defuns are not appropriate for the
3103 mode.
3105 ** easy-mmode-define-minor-mode now takes an additional BODY argument
3106 and is renamed `define-minor-mode'.
3108 ** If an abbrev has a hook function which is a symbol, and that symbol
3109 has a non-nil `no-self-insert' property, the return value of the hook
3110 function specifies whether an expansion has been done or not.  If it
3111 returns nil, abbrev-expand also returns nil, meaning "no expansion has
3112 been performed."
3114 When abbrev expansion is done by typing a self-inserting character,
3115 and the abbrev has a hook with the `no-self-insert' property, and the
3116 hook function returns non-nil meaning expansion has been done,
3117 then the self-inserting character is not inserted.
3119 ** The function `intern-soft' now accepts a symbol as first argument.
3120 In this case, that exact symbol is looked up in the specified obarray,
3121 and the function's value is nil if it is not found.
3123 ** The new macro `with-syntax-table' can be used to evaluate forms
3124 with the syntax table of the current buffer temporarily set to a
3125 specified table.
3127   (with-syntax-table TABLE &rest BODY)
3129 Evaluate BODY with syntax table of current buffer set to a copy of
3130 TABLE.  The current syntax table is saved, BODY is evaluated, and the
3131 saved table is restored, even in case of an abnormal exit.  Value is
3132 what BODY returns.
3134 ** Regular expressions now support intervals \{n,m\} as well as
3135 Perl's shy-groups \(?:...\) and non-greedy *? +? and ?? operators.
3136 Also back-references like \2 are now considered as an error if the
3137 corresponding subgroup does not exist (or is not closed yet).
3138 Previously it would have been silently turned into `2' (ignoring the `\').
3140 ** The optional argument BUFFER of function file-local-copy has been
3141 removed since it wasn't used by anything.
3143 ** The file name argument of function `file-locked-p' is now required
3144 instead of being optional.
3146 ** The new built-in error `text-read-only' is signaled when trying to
3147 modify read-only text.
3149 ** New functions and variables for locales.
3151 The new variable `locale-coding-system' specifies how to encode and
3152 decode strings passed to low-level message functions like strerror and
3153 time functions like strftime.  The new variables
3154 `system-messages-locale' and `system-time-locale' give the system
3155 locales to be used when invoking these two types of functions.
3157 The new function `set-locale-environment' sets the language
3158 environment, preferred coding system, and locale coding system from
3159 the system locale as specified by the LC_ALL, LC_CTYPE, and LANG
3160 environment variables.  Normally, it is invoked during startup and need
3161 not be invoked thereafter.  It uses the new variables
3162 `locale-language-names', `locale-charset-language-names', and
3163 `locale-preferred-coding-systems' to make its decisions.
3165 ** syntax tables now understand nested comments.
3166 To declare a comment syntax as allowing nesting, just add an `n'
3167 modifier to either of the characters of the comment end and the comment
3168 start sequences.
3170 ** The function `pixmap-spec-p' has been renamed `bitmap-spec-p'
3171 because `bitmap' is more in line with the usual X terminology.
3173 ** New function `propertize'
3175 The new function `propertize' can be used to conveniently construct
3176 strings with text properties.
3178 - Function: propertize STRING &rest PROPERTIES
3180 Value is a copy of STRING with text properties assigned as specified
3181 by PROPERTIES.  PROPERTIES is a sequence of pairs PROPERTY VALUE, with
3182 PROPERTY being the name of a text property and VALUE being the
3183 specified value of that property.  Example:
3185   (propertize "foo" 'face 'bold 'read-only t)
3187 ** push and pop macros.
3189 Simple versions of the push and pop macros of Common Lisp
3190 are now defined in Emacs Lisp.  These macros allow only symbols
3191 as the place that holds the list to be changed.
3193 (push NEWELT LISTNAME)  add NEWELT to the front of LISTNAME's value.
3194 (pop LISTNAME)          return first elt of LISTNAME, and remove it
3195                         (thus altering the value of LISTNAME).
3197 ** New dolist and dotimes macros.
3199 Simple versions of the dolist and dotimes macros of Common Lisp
3200 are now defined in Emacs Lisp.
3202 (dolist (VAR LIST [RESULT]) BODY...)
3203       Execute body once for each element of LIST,
3204       using the variable VAR to hold the current element.
3205       Then return the value of RESULT, or nil if RESULT is omitted.
3207 (dotimes (VAR COUNT [RESULT]) BODY...)
3208       Execute BODY with VAR bound to successive integers running from 0,
3209       inclusive, to COUNT, exclusive.
3210       Then return the value of RESULT, or nil if RESULT is omitted.
3212 ** Regular expressions now support Posix character classes such as
3213 [:alpha:], [:space:] and so on.  These must be used within a character
3214 class--for instance, [-[:digit:].+] matches digits or a period
3215 or a sign.
3217 [:digit:]  matches 0 through 9
3218 [:cntrl:]  matches ASCII control characters
3219 [:xdigit:]  matches 0 through 9, a through f and A through F.
3220 [:blank:]  matches space and tab only
3221 [:graph:]  matches graphic characters--everything except ASCII control chars,
3222            space, and DEL.
3223 [:print:]  matches printing characters--everything except ASCII control chars
3224            and DEL.
3225 [:alnum:]  matches letters and digits.
3226            (But at present, for multibyte characters,
3227             it matches anything that has word syntax.)
3228 [:alpha:]  matches letters.
3229            (But at present, for multibyte characters,
3230             it matches anything that has word syntax.)
3231 [:ascii:]  matches ASCII (unibyte) characters.
3232 [:nonascii:]  matches non-ASCII (multibyte) characters.
3233 [:lower:]  matches anything lower-case.
3234 [:punct:]  matches punctuation.
3235            (But at present, for multibyte characters,
3236             it matches anything that has non-word syntax.)
3237 [:space:]  matches anything that has whitespace syntax.
3238 [:upper:]  matches anything upper-case.
3239 [:word:]   matches anything that has word syntax.
3241 ** Emacs now has built-in hash tables.
3243 The following functions are defined for hash tables:
3245 - Function: make-hash-table ARGS
3247 The argument list ARGS consists of keyword/argument pairs.  All arguments
3248 are optional.  The following arguments are defined:
3250 :test TEST
3252 TEST must be a symbol specifying how to compare keys.  Default is `eql'.
3253 Predefined are `eq', `eql' and `equal'.  If TEST is not predefined,
3254 it must have been defined with `define-hash-table-test'.
3256 :size SIZE
3258 SIZE must be an integer > 0 giving a hint to the implementation how
3259 many elements will be put in the hash table.  Default size is 65.
3261 :rehash-size REHASH-SIZE
3263 REHASH-SIZE specifies by how much to grow a hash table once it becomes
3264 full.  If REHASH-SIZE is an integer, add that to the hash table's old
3265 size to get the new size.  Otherwise, REHASH-SIZE must be a float >
3266 1.0, and the new size is computed by multiplying REHASH-SIZE with the
3267 old size.  Default rehash size is 1.5.
3269 :rehash-threshold THRESHOLD
3271 THRESHOLD must be a float > 0 and <= 1.0 specifying when to resize the
3272 hash table.  It is resized when the ratio of (number of entries) /
3273 (size of hash table) is >= THRESHOLD.  Default threshold is 0.8.
3275 :weakness WEAK
3277 WEAK must be either nil, one of the symbols `key, `value',
3278 `key-or-value', `key-and-value', or t, meaning the same as
3279 `key-and-value'.  Entries are removed from weak tables during garbage
3280 collection if their key and/or value are not referenced elsewhere
3281 outside of the hash table.  Default are non-weak hash tables.
3283 - Function: makehash &optional TEST
3285 Similar to make-hash-table, but only TEST can be specified.
3287 - Function: hash-table-p TABLE
3289 Returns non-nil if TABLE is a hash table object.
3291 - Function: copy-hash-table TABLE
3293 Returns a copy of TABLE.  Only the table itself is copied, keys and
3294 values are shared.
3296 - Function: hash-table-count TABLE
3298 Returns the number of entries in TABLE.
3300 - Function: hash-table-rehash-size TABLE
3302 Returns the rehash size of TABLE.
3304 - Function: hash-table-rehash-threshold TABLE
3306 Returns the rehash threshold of TABLE.
3308 - Function: hash-table-rehash-size TABLE
3310 Returns the size of TABLE.
3312 - Function: hash-table-test TABLE
3314 Returns the test TABLE uses to compare keys.
3316 - Function: hash-table-weakness TABLE
3318 Returns the weakness specified for TABLE.
3320 - Function: clrhash TABLE
3322 Clear TABLE.
3324 - Function: gethash KEY TABLE &optional DEFAULT
3326 Look up KEY in TABLE and return its associated VALUE or DEFAULT if
3327 not found.
3329 - Function: puthash KEY VALUE TABLE
3331 Associate KEY with VALUE in TABLE.  If KEY is already associated with
3332 another value, replace the old value with VALUE.
3334 - Function: remhash KEY TABLE
3336 Remove KEY from TABLE if it is there.
3338 - Function: maphash FUNCTION TABLE
3340 Call FUNCTION for all elements in TABLE.  FUNCTION must take two
3341 arguments KEY and VALUE.
3343 - Function: sxhash OBJ
3345 Return a hash code for Lisp object OBJ.
3347 - Function: define-hash-table-test NAME TEST-FN HASH-FN
3349 Define a new hash table test named NAME.  If NAME is specified as
3350 a test in `make-hash-table', the table created will use TEST-FN for
3351 comparing keys, and HASH-FN to compute hash codes for keys.  Test
3352 and hash function are stored as symbol property `hash-table-test'
3353 of NAME with a value of (TEST-FN HASH-FN).
3355 TEST-FN must take two arguments and return non-nil if they are the same.
3357 HASH-FN must take one argument and return an integer that is the hash
3358 code of the argument.  The function should use the whole range of
3359 integer values for hash code computation, including negative integers.
3361 Example: The following creates a hash table whose keys are supposed to
3362 be strings that are compared case-insensitively.
3364   (defun case-fold-string= (a b)
3365     (compare-strings a nil nil b nil nil t))
3367   (defun case-fold-string-hash (a)
3368     (sxhash (upcase a)))
3370   (define-hash-table-test 'case-fold 'case-fold-string=
3371                           'case-fold-string-hash))
3373   (make-hash-table :test 'case-fold)
3375 ** The Lisp reader handles circular structure.
3377 It now works to use the #N= and #N# constructs to represent
3378 circular structures.  For example, #1=(a . #1#) represents
3379 a cons cell which is its own cdr.
3381 ** The Lisp printer handles circular structure.
3383 If you bind print-circle to a non-nil value, the Lisp printer outputs
3384 #N= and #N# constructs to represent circular and shared structure.
3386 ** If the second argument to `move-to-column' is anything but nil or
3387 t, that means replace a tab with spaces if necessary to reach the
3388 specified column, but do not add spaces at the end of the line if it
3389 is too short to reach that column.
3391 ** perform-replace has a new feature:  the REPLACEMENTS argument may
3392 now be a cons cell (FUNCTION . DATA).  This means to call FUNCTION
3393 after each match to get the replacement text.  FUNCTION is called with
3394 two arguments: DATA, and the number of replacements already made.
3396 If the FROM-STRING contains any upper-case letters,
3397 perform-replace also turns off `case-fold-search' temporarily
3398 and inserts the replacement text without altering case in it.
3400 ** The function buffer-size now accepts an optional argument
3401 to specify which buffer to return the size of.
3403 ** The calendar motion commands now run the normal hook
3404 calendar-move-hook after moving point.
3406 ** The new variable small-temporary-file-directory specifies a
3407 directory to use for creating temporary files that are likely to be
3408 small.  (Certain Emacs features use this directory.)  If
3409 small-temporary-file-directory is nil, they use
3410 temporary-file-directory instead.
3412 ** The variable `inhibit-modification-hooks', if non-nil, inhibits all
3413 the hooks that track changes in the buffer.  This affects
3414 `before-change-functions' and `after-change-functions', as well as
3415 hooks attached to text properties and overlay properties.
3417 ** assq-delete-all is a new function that deletes all the
3418 elements of an alist which have a car `eq' to a particular value.
3420 ** make-temp-file provides a more reliable way to create a temporary file.
3422 make-temp-file is used like make-temp-name, except that it actually
3423 creates the file before it returns.  This prevents a timing error,
3424 ensuring that no other job can use the same name for a temporary file.
3426 ** New exclusive-open feature in `write-region'
3428 The optional seventh arg is now called MUSTBENEW.  If non-nil, it insists
3429 on a check for an existing file with the same name.  If MUSTBENEW
3430 is `excl', that means to get an error if the file already exists;
3431 never overwrite. If MUSTBENEW is neither nil nor `excl', that means
3432 ask for confirmation before overwriting, but do go ahead and
3433 overwrite the file if the user gives confirmation.
3435 If the MUSTBENEW argument in `write-region' is `excl',
3436 that means to use a special feature in the `open' system call
3437 to get an error if the file exists at that time.
3438 The error reported is `file-already-exists'.
3440 ** Function `format' now handles text properties.
3442 Text properties of the format string are applied to the result string.
3443 If the result string is longer than the format string, text properties
3444 ending at the end of the format string are extended to the end of the
3445 result string.
3447 Text properties from string arguments are applied to the result
3448 string where arguments appear in the result string.
3450 Example:
3452   (let ((s1 "hello, %s")
3453         (s2 "world"))
3454      (put-text-property 0 (length s1) 'face 'bold s1)
3455      (put-text-property 0 (length s2) 'face 'italic s2)
3456      (format s1 s2))
3458 results in a bold-face string with an italic `world' at the end.
3460 ** Messages can now be displayed with text properties.
3462 Text properties are handled as described above for function `format'.
3463 The following example displays a bold-face message with an italic
3464 argument in it.
3466   (let ((msg "hello, %s!")
3467         (arg "world"))
3468      (put-text-property 0 (length msg) 'face 'bold msg)
3469      (put-text-property 0 (length arg) 'face 'italic arg)
3470      (message msg arg))
3472 ** Sound support
3474 Emacs supports playing sound files on GNU/Linux and the free BSDs
3475 (Voxware driver and native BSD driver, aka as Luigi's driver).
3477 Currently supported file formats are RIFF-WAVE (*.wav) and Sun Audio
3478 (*.au).  You must configure Emacs with the option `--with-sound=yes'
3479 to enable sound support.
3481 Sound files can be played by calling (play-sound SOUND).  SOUND is a
3482 list of the form `(sound PROPERTY...)'.  The function is only defined
3483 when sound support is present for the system on which Emacs runs.  The
3484 functions runs `play-sound-functions' with one argument which is the
3485 sound to play, before playing the sound.
3487 The following sound properties are supported:
3489 - `:file FILE'
3491 FILE is a file name.  If FILE isn't an absolute name, it will be
3492 searched relative to `data-directory'.
3494 - `:data DATA'
3496 DATA is a string containing sound data.  Either :file or :data
3497 may be present, but not both.
3499 - `:volume VOLUME'
3501 VOLUME must be an integer in the range 0..100 or a float in the range
3502 0..1.  This property is optional.
3504 - `:device DEVICE'
3506 DEVICE is a string specifying the system device on which to play the
3507 sound.  The default device is system-dependent.
3509 Other properties are ignored.
3511 An alternative interface is called as
3512 (play-sound-file FILE &optional VOLUME DEVICE).
3514 ** `multimedia' is a new Finder keyword and Custom group.
3516 ** keywordp is a new predicate to test efficiently for an object being
3517 a keyword symbol.
3519 ** Changes to garbage collection
3521 *** The function garbage-collect now additionally returns the number
3522 of live and free strings.
3524 *** There is a new variable `strings-consed' holding the number of
3525 strings that have been consed so far.
3528 * Lisp-level Display features added after release 2.6 of the Emacs
3529 Lisp Manual
3531 ** The user-option `resize-mini-windows' controls how Emacs resizes
3532 mini-windows.
3534 ** The function `pos-visible-in-window-p' now has a third optional
3535 argument, PARTIALLY.  If a character is only partially visible, nil is
3536 returned, unless PARTIALLY is non-nil.
3538 ** On window systems, `glyph-table' is no longer used.
3540 ** Help strings in menu items are now used to provide `help-echo' text.
3542 ** The function `image-size' can be used to determine the size of an
3543 image.
3545 - Function: image-size SPEC &optional PIXELS FRAME
3547 Return the size of an image as a pair (WIDTH . HEIGHT).
3549 SPEC is an image specification.  PIXELS non-nil means return sizes
3550 measured in pixels, otherwise return sizes measured in canonical
3551 character units (fractions of the width/height of the frame's default
3552 font).  FRAME is the frame on which the image will be displayed.
3553 FRAME nil or omitted means use the selected frame.
3555 ** The function `image-mask-p' can be used to determine if an image
3556 has a mask bitmap.
3558 - Function: image-mask-p SPEC &optional FRAME
3560 Return t if image SPEC has a mask bitmap.
3561 FRAME is the frame on which the image will be displayed.  FRAME nil
3562 or omitted means use the selected frame.
3564 ** The function `find-image' can be used to find a usable image
3565 satisfying one of a list of specifications.
3567 ** The STRING argument of `put-image' and `insert-image' is now
3568 optional.
3570 ** Image specifications may contain the property `:ascent center' (see
3571 below).
3574 * New Lisp-level Display features in Emacs 21.1
3576 ** The function tty-suppress-bold-inverse-default-colors can be used
3577 to make Emacs avoid displaying text with bold black foreground on TTYs.
3579 Some terminals, notably PC consoles, emulate bold text by displaying
3580 text in brighter colors.  On such a console, a bold black foreground
3581 is displayed in a gray color.  If this turns out to be hard to read on
3582 your monitor---the problem occurred with the mode line on
3583 laptops---you can instruct Emacs to ignore the text's boldness, and to
3584 just display it black instead.
3586 This situation can't be detected automatically.  You will have to put
3587 a line like
3589   (tty-suppress-bold-inverse-default-colors t)
3591 in your `.emacs'.
3593 ** New face implementation.
3595 Emacs faces have been reimplemented from scratch.  They don't use XLFD
3596 font names anymore and face merging now works as expected.
3598 *** New faces.
3600 Each face can specify the following display attributes:
3602    1. Font family or fontset alias name.
3604    2. Relative proportionate width, aka character set width or set
3605    width (swidth), e.g. `semi-compressed'.
3607    3. Font height in 1/10pt
3609    4. Font weight, e.g. `bold'.
3611    5. Font slant, e.g. `italic'.
3613    6. Foreground color.
3615    7. Background color.
3617    8. Whether or not characters should be underlined, and in what color.
3619    9. Whether or not characters should be displayed in inverse video.
3621    10. A background stipple, a bitmap.
3623    11. Whether or not characters should be overlined, and in what color.
3625    12. Whether or not characters should be strike-through, and in what
3626    color.
3628    13. Whether or not a box should be drawn around characters, its
3629    color, the width of the box lines, and 3D appearance.
3631 Faces are frame-local by nature because Emacs allows to define the
3632 same named face (face names are symbols) differently for different
3633 frames.  Each frame has an alist of face definitions for all named
3634 faces.  The value of a named face in such an alist is a Lisp vector
3635 with the symbol `face' in slot 0, and a slot for each of the face
3636 attributes mentioned above.
3638 There is also a global face alist `face-new-frame-defaults'.  Face
3639 definitions from this list are used to initialize faces of newly
3640 created frames.
3642 A face doesn't have to specify all attributes.  Those not specified
3643 have a nil value.  Faces specifying all attributes are called
3644 `fully-specified'.
3646 *** Face merging.
3648 The display style of a given character in the text is determined by
3649 combining several faces.  This process is called `face merging'.  Any
3650 aspect of the display style that isn't specified by overlays or text
3651 properties is taken from the `default' face.  Since it is made sure
3652 that the default face is always fully-specified, face merging always
3653 results in a fully-specified face.
3655 *** Face realization.
3657 After all face attributes for a character have been determined by
3658 merging faces of that character, that face is `realized'.  The
3659 realization process maps face attributes to what is physically
3660 available on the system where Emacs runs.  The result is a `realized
3661 face' in form of an internal structure which is stored in the face
3662 cache of the frame on which it was realized.
3664 Face realization is done in the context of the charset of the
3665 character to display because different fonts and encodings are used
3666 for different charsets.  In other words, for characters of different
3667 charsets, different realized faces are needed to display them.
3669 Except for composite characters, faces are always realized for a
3670 specific character set and contain a specific font, even if the face
3671 being realized specifies a fontset.  The reason is that the result of
3672 the new font selection stage is better than what can be done with
3673 statically defined font name patterns in fontsets.
3675 In unibyte text, Emacs' charsets aren't applicable; function
3676 `char-charset' reports ASCII for all characters, including those >
3677 0x7f.  The X registry and encoding of fonts to use is determined from
3678 the variable `face-default-registry' in this case.  The variable is
3679 initialized at Emacs startup time from the font the user specified for
3680 Emacs.
3682 Currently all unibyte text, i.e. all buffers with
3683 `enable-multibyte-characters' nil are displayed with fonts of the same
3684 registry and encoding `face-default-registry'.  This is consistent
3685 with the fact that languages can also be set globally, only.
3687 **** Clearing face caches.
3689 The Lisp function `clear-face-cache' can be called to clear face caches
3690 on all frames.  If called with a non-nil argument, it will also unload
3691 unused fonts.
3693 *** Font selection.
3695 Font selection tries to find the best available matching font for a
3696 given (charset, face) combination.  This is done slightly differently
3697 for faces specifying a fontset, or a font family name.
3699 If the face specifies a fontset name, that fontset determines a
3700 pattern for fonts of the given charset.  If the face specifies a font
3701 family, a font pattern is constructed.  Charset symbols have a
3702 property `x-charset-registry' for that purpose that maps a charset to
3703 an XLFD registry and encoding in the font pattern constructed.
3705 Available fonts on the system on which Emacs runs are then matched
3706 against the font pattern.  The result of font selection is the best
3707 match for the given face attributes in this font list.
3709 Font selection can be influenced by the user.
3711 The user can specify the relative importance he gives the face
3712 attributes width, height, weight, and slant by setting
3713 face-font-selection-order (faces.el) to a list of face attribute
3714 names.  The default is (:width :height :weight :slant), and means
3715 that font selection first tries to find a good match for the font
3716 width specified by a face, then---within fonts with that width---tries
3717 to find a best match for the specified font height, etc.
3719 Setting `face-font-family-alternatives' allows the user to specify
3720 alternative font families to try if a family specified by a face
3721 doesn't exist.
3723 Setting `face-font-registry-alternatives' allows the user to specify
3724 all alternative font registry names to try for a face specifying a
3725 registry.
3727 Please note that the interpretations of the above two variables are
3728 slightly different.
3730 Setting face-ignored-fonts allows the user to ignore specific fonts.
3733 **** Scalable fonts
3735 Emacs can make use of scalable fonts but doesn't do so by default,
3736 since the use of too many or too big scalable fonts may crash XFree86
3737 servers.
3739 To enable scalable font use, set the variable
3740 `scalable-fonts-allowed'.  A value of nil, the default, means never use
3741 scalable fonts.  A value of t means any scalable font may be used.
3742 Otherwise, the value must be a list of regular expressions.  A
3743 scalable font may then be used if it matches a regular expression from
3744 that list.  Example:
3746   (setq scalable-fonts-allowed '("muleindian-2$"))
3748 allows the use of scalable fonts with registry `muleindian-2'.
3750 *** Functions and variables related to font selection.
3752 - Function: x-family-fonts &optional FAMILY FRAME
3754 Return a list of available fonts of family FAMILY on FRAME.  If FAMILY
3755 is omitted or nil, list all families.  Otherwise, FAMILY must be a
3756 string, possibly containing wildcards `?' and `*'.
3758 If FRAME is omitted or nil, use the selected frame.  Each element of
3759 the result is a vector [FAMILY WIDTH POINT-SIZE WEIGHT SLANT FIXED-P
3760 FULL REGISTRY-AND-ENCODING].  FAMILY is the font family name.
3761 POINT-SIZE is the size of the font in 1/10 pt.  WIDTH, WEIGHT, and
3762 SLANT are symbols describing the width, weight and slant of the font.
3763 These symbols are the same as for face attributes.  FIXED-P is non-nil
3764 if the font is fixed-pitch.  FULL is the full name of the font, and
3765 REGISTRY-AND-ENCODING is a string giving the registry and encoding of
3766 the font.  The result list is sorted according to the current setting
3767 of the face font sort order.
3769 - Function: x-font-family-list
3771 Return a list of available font families on FRAME.  If FRAME is
3772 omitted or nil, use the selected frame.  Value is a list of conses
3773 (FAMILY . FIXED-P) where FAMILY is a font family, and FIXED-P is
3774 non-nil if fonts of that family are fixed-pitch.
3776 - Variable: font-list-limit
3778 Limit for font matching.  If an integer > 0, font matching functions
3779 won't load more than that number of fonts when searching for a
3780 matching font.  The default is currently 100.
3782 *** Setting face attributes.
3784 For the most part, the new face implementation is interface-compatible
3785 with the old one.  Old face attribute related functions are now
3786 implemented in terms of the new functions `set-face-attribute' and
3787 `face-attribute'.
3789 Face attributes are identified by their names which are keyword
3790 symbols.  All attributes can be set to `unspecified'.
3792 The following attributes are recognized:
3794 `:family'
3796 VALUE must be a string specifying the font family, e.g. ``courier'',
3797 or a fontset alias name.  If a font family is specified, wild-cards `*'
3798 and `?' are allowed.
3800 `:width'
3802 VALUE specifies the relative proportionate width of the font to use.
3803 It must be one of the symbols `ultra-condensed', `extra-condensed',
3804 `condensed', `semi-condensed', `normal', `semi-expanded', `expanded',
3805 `extra-expanded', or `ultra-expanded'.
3807 `:height'
3809 VALUE must be either an integer specifying the height of the font to use
3810 in 1/10 pt, a floating point number specifying the amount by which to
3811 scale any underlying face, or a function, which is called with the old
3812 height (from the underlying face), and should return the new height.
3814 `:weight'
3816 VALUE specifies the weight of the font to use.  It must be one of the
3817 symbols `ultra-bold', `extra-bold', `bold', `semi-bold', `normal',
3818 `semi-light', `light', `extra-light', `ultra-light'.
3820 `:slant'
3822 VALUE specifies the slant of the font to use.  It must be one of the
3823 symbols `italic', `oblique', `normal', `reverse-italic', or
3824 `reverse-oblique'.
3826 `:foreground', `:background'
3828 VALUE must be a color name, a string.
3830 `:underline'
3832 VALUE specifies whether characters in FACE should be underlined.  If
3833 VALUE is t, underline with foreground color of the face.  If VALUE is
3834 a string, underline with that color.  If VALUE is nil, explicitly
3835 don't underline.
3837 `:overline'
3839 VALUE specifies whether characters in FACE should be overlined.  If
3840 VALUE is t, overline with foreground color of the face.  If VALUE is a
3841 string, overline with that color.  If VALUE is nil, explicitly don't
3842 overline.
3844 `:strike-through'
3846 VALUE specifies whether characters in FACE should be drawn with a line
3847 striking through them.  If VALUE is t, use the foreground color of the
3848 face.  If VALUE is a string, strike-through with that color.  If VALUE
3849 is nil, explicitly don't strike through.
3851 `:box'
3853 VALUE specifies whether characters in FACE should have a box drawn
3854 around them.  If VALUE is nil, explicitly don't draw boxes.  If
3855 VALUE is t, draw a box with lines of width 1 in the foreground color
3856 of the face.  If VALUE is a string, the string must be a color name,
3857 and the box is drawn in that color with a line width of 1.  Otherwise,
3858 VALUE must be a property list of the form `(:line-width WIDTH
3859 :color COLOR :style STYLE)'.  If a keyword/value pair is missing from
3860 the property list, a default value will be used for the value, as
3861 specified below.  WIDTH specifies the width of the lines to draw; it
3862 defaults to 1.  COLOR is the name of the color to draw in, default is
3863 the foreground color of the face for simple boxes, and the background
3864 color of the face for 3D boxes.  STYLE specifies whether a 3D box
3865 should be draw.  If STYLE is `released-button', draw a box looking
3866 like a released 3D button.  If STYLE is `pressed-button' draw a box
3867 that appears like a pressed button.  If STYLE is nil, the default if
3868 the property list doesn't contain a style specification, draw a 2D
3869 box.
3871 `:inverse-video'
3873 VALUE specifies whether characters in FACE should be displayed in
3874 inverse video. VALUE must be one of t or nil.
3876 `:stipple'
3878 If VALUE is a string, it must be the name of a file of pixmap data.
3879 The directories listed in the `x-bitmap-file-path' variable are
3880 searched.  Alternatively, VALUE may be a list of the form (WIDTH
3881 HEIGHT DATA) where WIDTH and HEIGHT are the size in pixels, and DATA
3882 is a string containing the raw bits of the bitmap.  VALUE nil means
3883 explicitly don't use a stipple pattern.
3885 For convenience, attributes `:family', `:width', `:height', `:weight',
3886 and `:slant' may also be set in one step from an X font name:
3888 `:font'
3890 Set font-related face attributes from VALUE.  VALUE must be a valid
3891 XLFD font name.  If it is a font name pattern, the first matching font
3892 is used--this is for compatibility with the behavior of previous
3893 versions of Emacs.
3895 For compatibility with Emacs 20, keywords `:bold' and `:italic' can
3896 be used to specify that a bold or italic font should be used.  VALUE
3897 must be t or nil in that case.  A value of `unspecified' is not allowed."
3899 Please see also the documentation of `set-face-attribute' and
3900 `defface'.
3902 `:inherit'
3904 VALUE is the name of a face from which to inherit attributes, or a list
3905 of face names.  Attributes from inherited faces are merged into the face
3906 like an underlying face would be, with higher priority than underlying faces.
3908 *** Face attributes and X resources
3910 The following X resource names can be used to set face attributes
3911 from X resources:
3913   Face attribute        X resource              class
3914 -----------------------------------------------------------------------
3915   :family               attributeFamily .       Face.AttributeFamily
3916   :width                attributeWidth          Face.AttributeWidth
3917   :height               attributeHeight         Face.AttributeHeight
3918   :weight               attributeWeight         Face.AttributeWeight
3919   :slant                attributeSlant          Face.AttributeSlant
3920    foreground           attributeForeground     Face.AttributeForeground
3921   :background           attributeBackground .   Face.AttributeBackground
3922   :overline             attributeOverline       Face.AttributeOverline
3923   :strike-through       attributeStrikeThrough  Face.AttributeStrikeThrough
3924   :box                  attributeBox            Face.AttributeBox
3925   :underline            attributeUnderline      Face.AttributeUnderline
3926   :inverse-video        attributeInverse        Face.AttributeInverse
3927   :stipple              attributeStipple        Face.AttributeStipple
3928         or              attributeBackgroundPixmap
3929                                                 Face.AttributeBackgroundPixmap
3930   :font                 attributeFont           Face.AttributeFont
3931   :bold                 attributeBold           Face.AttributeBold
3932   :italic               attributeItalic .       Face.AttributeItalic
3933   :font                 attributeFont           Face.AttributeFont
3935 *** Text property `face'.
3937 The value of the `face' text property can now be a single face
3938 specification or a list of such specifications.  Each face
3939 specification can be
3941 1. A symbol or string naming a Lisp face.
3943 2. A property list of the form (KEYWORD VALUE ...) where each
3944    KEYWORD is a face attribute name, and VALUE is an appropriate value
3945    for that attribute.  Please see the doc string of `set-face-attribute'
3946    for face attribute names.
3948 3. Conses of the form (FOREGROUND-COLOR . COLOR) or
3949    (BACKGROUND-COLOR . COLOR) where COLOR is a color name.  This is
3950    for compatibility with previous Emacs versions.
3952 ** Support functions for colors on text-only terminals.
3954 The function `tty-color-define' can be used to define colors for use
3955 on TTY and MSDOS frames.  It maps a color name to a color number on
3956 the terminal.  Emacs defines a couple of common color mappings by
3957 default.  You can get defined colors with a call to
3958 `defined-colors'.  The function `tty-color-clear' can be
3959 used to clear the mapping table.
3961 ** Unified support for colors independent of frame type.
3963 The new functions `defined-colors', `color-defined-p', `color-values',
3964 and `display-color-p' work for any type of frame.  On frames whose
3965 type is neither x nor w32, these functions transparently map X-style
3966 color specifications to the closest colors supported by the frame
3967 display.  Lisp programs should use these new functions instead of the
3968 old `x-defined-colors', `x-color-defined-p', `x-color-values', and
3969 `x-display-color-p'.  (The old function names are still available for
3970 compatibility; they are now aliases of the new names.)  Lisp programs
3971 should no more look at the value of the variable window-system to
3972 modify their color-related behavior.
3974 The primitives `color-gray-p' and `color-supported-p' also work for
3975 any frame type.
3977 ** Platform-independent functions to describe display capabilities.
3979 The new functions `display-mouse-p', `display-popup-menus-p',
3980 `display-graphic-p', `display-selections-p', `display-screens',
3981 `display-pixel-width', `display-pixel-height', `display-mm-width',
3982 `display-mm-height', `display-backing-store', `display-save-under',
3983 `display-planes', `display-color-cells', `display-visual-class', and
3984 `display-grayscale-p' describe the basic capabilities of a particular
3985 display.  Lisp programs should call these functions instead of testing
3986 the value of the variables `window-system' or `system-type', or calling
3987 platform-specific functions such as `x-display-pixel-width'.
3989 The new function `display-images-p' returns non-nil if a particular
3990 display can display image files.
3992 ** The minibuffer prompt is now actually inserted in the minibuffer.
3994 This makes it possible to scroll through the prompt, if you want to.
3995 To disallow this completely (like previous versions of emacs), customize
3996 the variable `minibuffer-prompt-properties', and turn on the
3997 `Inviolable' option.
3999 The function `minibuffer-prompt-end' returns the current position of the
4000 end of the minibuffer prompt, if the minibuffer is current.
4001 Otherwise, it returns `(point-min)'.
4003 ** New `field' abstraction in buffers.
4005 There is now code to support an abstraction called `fields' in emacs
4006 buffers.  A field is a contiguous region of text with the same `field'
4007 property (which can be a text property or an overlay).
4009 Many emacs functions, such as forward-word, forward-sentence,
4010 forward-paragraph, beginning-of-line, etc., stop moving when they come
4011 to the boundary between fields; beginning-of-line and end-of-line will
4012 not let the point move past the field boundary, but other movement
4013 commands continue into the next field if repeated.  Stopping at field
4014 boundaries can be suppressed programmatically by binding
4015 `inhibit-field-text-motion' to a non-nil value around calls to these
4016 functions.
4018 Now that the minibuffer prompt is inserted into the minibuffer, it is in
4019 a separate field from the user-input part of the buffer, so that common
4020 editing commands treat the user's text separately from the prompt.
4022 The following functions are defined for operating on fields:
4024 - Function: constrain-to-field NEW-POS OLD-POS &optional ESCAPE-FROM-EDGE ONLY-IN-LINE INHIBIT-CAPTURE-PROPERTY
4026 Return the position closest to NEW-POS that is in the same field as OLD-POS.
4028 A field is a region of text with the same `field' property.
4029 If NEW-POS is nil, then the current point is used instead, and set to the
4030 constrained position if that is different.
4032 If OLD-POS is at the boundary of two fields, then the allowable
4033 positions for NEW-POS depends on the value of the optional argument
4034 ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is
4035 constrained to the field that has the same `field' char-property
4036 as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE
4037 is non-nil, NEW-POS is constrained to the union of the two adjacent
4038 fields.  Additionally, if two fields are separated by another field with
4039 the special value `boundary', then any point within this special field is
4040 also considered to be `on the boundary'.
4042 If the optional argument ONLY-IN-LINE is non-nil and constraining
4043 NEW-POS would move it to a different line, NEW-POS is returned
4044 unconstrained.  This useful for commands that move by line, like
4045 C-n or C-a, which should generally respect field boundaries
4046 only in the case where they can still move to the right line.
4048 If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has
4049 a non-nil property of that name, then any field boundaries are ignored.
4051 Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.
4053 - Function: delete-field &optional POS
4055 Delete the field surrounding POS.
4056 A field is a region of text with the same `field' property.
4057 If POS is nil, the value of point is used for POS.
4059 - Function: field-beginning &optional POS ESCAPE-FROM-EDGE
4061 Return the beginning of the field surrounding POS.
4062 A field is a region of text with the same `field' property.
4063 If POS is nil, the value of point is used for POS.
4064 If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its
4065 field, then the beginning of the *previous* field is returned.
4067 - Function: field-end &optional POS ESCAPE-FROM-EDGE
4069 Return the end of the field surrounding POS.
4070 A field is a region of text with the same `field' property.
4071 If POS is nil, the value of point is used for POS.
4072 If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,
4073 then the end of the *following* field is returned.
4075 - Function: field-string &optional POS
4077 Return the contents of the field surrounding POS as a string.
4078 A field is a region of text with the same `field' property.
4079 If POS is nil, the value of point is used for POS.
4081 - Function: field-string-no-properties &optional POS
4083 Return the contents of the field around POS, without text-properties.
4084 A field is a region of text with the same `field' property.
4085 If POS is nil, the value of point is used for POS.
4087 ** Image support.
4089 Emacs can now display images.  Images are inserted into text by giving
4090 strings or buffer text a `display' text property containing one of
4091 (AREA IMAGE) or IMAGE.  The display of the `display' property value
4092 replaces the display of the characters having that property.
4094 If the property value has the form (AREA IMAGE), AREA must be one of
4095 `(margin left-margin)', `(margin right-margin)' or `(margin nil)'.  If
4096 AREA is `(margin nil)', IMAGE will be displayed in the text area of a
4097 window, otherwise it will be displayed in the left or right marginal
4098 area.
4100 IMAGE is an image specification.
4102 *** Image specifications
4104 Image specifications are lists of the form `(image PROPS)' where PROPS
4105 is a property list whose keys are keyword symbols.  Each
4106 specifications must contain a property `:type TYPE' with TYPE being a
4107 symbol specifying the image type, e.g. `xbm'.  Properties not
4108 described below are ignored.
4110 The following is a list of properties all image types share.
4112 `:ascent ASCENT'
4114 ASCENT must be a number in the range 0..100, or the symbol `center'.
4115 If it is a number, it specifies the percentage of the image's height
4116 to use for its ascent.
4118 If not specified, ASCENT defaults to the value 50 which means that the
4119 image will be centered with the base line of the row it appears in.
4121 If ASCENT is `center' the image is vertically centered around a
4122 centerline which is the vertical center of text drawn at the position
4123 of the image, in the manner specified by the text properties and
4124 overlays that apply to the image.
4126 `:margin MARGIN'
4128 MARGIN must be either a number >= 0 specifying how many pixels to put
4129 as margin around the image, or a pair (X . Y) with X specifying the
4130 horizontal margin and Y specifying the vertical margin.  Default is 0.
4132 `:relief RELIEF'
4134 RELIEF is analogous to the `:relief' attribute of faces.  Puts a relief
4135 around an image.
4137 `:conversion ALGO'
4139 Apply an image algorithm to the image before displaying it.
4141 ALGO `laplace' or `emboss' means apply a Laplace or ``emboss''
4142 edge-detection algorithm to the image.
4144 ALGO `(edge-detection :matrix MATRIX :color-adjust ADJUST)' means
4145 apply a general edge-detection algorithm.  MATRIX must be either a
4146 nine-element list or a nine-element vector of numbers.  A pixel at
4147 position x/y in the transformed image is computed from original pixels
4148 around that position.  MATRIX specifies, for each pixel in the
4149 neighborhood of x/y, a factor with which that pixel will influence the
4150 transformed pixel; element 0 specifies the factor for the pixel at
4151 x-1/y-1, element 1 the factor for the pixel at x/y-1 etc. as shown
4152 below.
4154   (x-1/y-1  x/y-1  x+1/y-1
4155    x-1/y    x/y    x+1/y
4156    x-1/y+1  x/y+1  x+1/y+1)
4158 The resulting pixel is computed from the color intensity of the color
4159 resulting from summing up the RGB values of surrounding pixels,
4160 multiplied by the specified factors, and dividing that sum by the sum
4161 of the factors' absolute values.
4163 Laplace edge-detection currently uses a matrix of
4165   (1  0  0
4166    0  0  0
4167    9  9 -1)
4169 Emboss edge-detection uses a matrix of
4171   ( 2 -1  0
4172    -1  0  1
4173     0  1 -2)
4175 ALGO `disabled' means transform the image so that it looks
4176 ``disabled''.
4178 `:mask MASK'
4180 If MASK is `heuristic' or `(heuristic BG)', build a clipping mask for
4181 the image, so that the background of a frame is visible behind the
4182 image.  If BG is not specified, or if BG is t, determine the
4183 background color of the image by looking at the 4 corners of the
4184 image, assuming the most frequently occurring color from the corners is
4185 the background color of the image.  Otherwise, BG must be a list `(RED
4186 GREEN BLUE)' specifying the color to assume for the background of the
4187 image.
4189 If MASK is nil, remove a mask from the image, if it has one.  Images
4190 in some formats include a mask which can be removed by specifying
4191 `:mask nil'.
4193 `:file FILE'
4195 Load image from FILE.  If FILE is not absolute after expanding it,
4196 search for the image in `data-directory'.  Some image types support
4197 building images from data.  When this is done, no `:file' property
4198 may be present in the image specification.
4200 `:data DATA'
4202 Get image data from DATA.  (As of this writing, this is not yet
4203 supported for image type `postscript').  Either :file or :data may be
4204 present in an image specification, but not both.  All image types
4205 support strings as DATA, some types allow additional types of DATA.
4207 *** Supported image types
4209 **** XBM, image type `xbm'.
4211 XBM images don't require an external library.  Additional image
4212 properties supported are:
4214 `:foreground FG'
4216 FG must be a string specifying the image foreground color, or nil
4217 meaning to use the default.  Default is the frame's foreground color.
4219 `:background BG'
4221 BG must be a string specifying the image background color, or nil
4222 meaning to use the default.  Default is the frame's background color.
4224 XBM images can be constructed from data instead of file.  In this
4225 case, the image specification must contain the following properties
4226 instead of a `:file' property.
4228 `:width WIDTH'
4230 WIDTH specifies the width of the image in pixels.
4232 `:height HEIGHT'
4234 HEIGHT specifies the height of the image in pixels.
4236 `:data DATA'
4238 DATA must be either
4240    1. a string large enough to hold the bitmap data, i.e. it must
4241    have a size >= (WIDTH + 7) / 8 * HEIGHT
4243    2. a bool-vector of size >= WIDTH * HEIGHT
4245    3. a vector of strings or bool-vectors, one for each line of the
4246    bitmap.
4248    4. a string that's an in-memory XBM file.  Neither width nor
4249    height may be specified in this case because these are defined
4250    in the file.
4252 **** XPM, image type `xpm'
4254 XPM images require the external library `libXpm', package
4255 `xpm-3.4k.tar.gz', version 3.4k or later.  Make sure the library is
4256 found when Emacs is configured by supplying appropriate paths via
4257 `--x-includes' and `--x-libraries'.
4259 Additional image properties supported are:
4261 `:color-symbols SYMBOLS'
4263 SYMBOLS must be a list of pairs (NAME . COLOR), with NAME being the
4264 name of color as it appears in an XPM file, and COLOR being an X color
4265 name.
4267 XPM images can be built from memory instead of files.  In that case,
4268 add a `:data' property instead of a `:file' property.
4270 The XPM library uses libz in its implementation so that it is able
4271 to display compressed images.
4273 **** PBM, image type `pbm'
4275 PBM images don't require an external library.  Color, gray-scale and
4276 mono images are supported.  Additional image properties supported for
4277 mono images are:
4279 `:foreground FG'
4281 FG must be a string specifying the image foreground color, or nil
4282 meaning to use the default.  Default is the frame's foreground color.
4284 `:background FG'
4286 BG must be a string specifying the image background color, or nil
4287 meaning to use the default.  Default is the frame's background color.
4289 **** JPEG, image type `jpeg'
4291 Support for JPEG images requires the external library `libjpeg',
4292 package `jpegsrc.v6a.tar.gz', or later.  There are no additional image
4293 properties defined.
4295 **** TIFF, image type `tiff'
4297 Support for TIFF images requires the external library `libtiff',
4298 package `tiff-v3.4-tar.gz', or later.  There are no additional image
4299 properties defined.
4301 **** GIF, image type `gif'
4303 Support for GIF images requires the external library `libungif', package
4304 `libungif-4.1.0', or later.
4306 Additional image properties supported are:
4308 `:index INDEX'
4310 INDEX must be an integer >= 0.  Load image number INDEX from a
4311 multi-image GIF file.  If INDEX is too large, the image displays
4312 as a hollow box.
4314 This could be used to implement limited support for animated GIFs.
4315 For example, the following function displays a multi-image GIF file
4316 at point-min in the current buffer, switching between sub-images
4317 every 0.1 seconds.
4319 (defun show-anim (file max)
4320   "Display multi-image GIF file FILE which contains MAX subimages."
4321   (display-anim (current-buffer) file 0 max t))
4323 (defun display-anim (buffer file idx max first-time)
4324   (when (= idx max)
4325     (setq idx 0))
4326   (let ((img (create-image file nil nil :index idx)))
4327     (save-excursion
4328       (set-buffer buffer)
4329       (goto-char (point-min))
4330       (unless first-time (delete-char 1))
4331       (insert-image img "x"))
4332     (run-with-timer 0.1 nil 'display-anim buffer file (1+ idx) max nil)))
4334 **** PNG, image type `png'
4336 Support for PNG images requires the external library `libpng',
4337 package `libpng-1.0.2.tar.gz', or later.  There are no additional image
4338 properties defined.
4340 **** Ghostscript, image type `postscript'.
4342 Additional image properties supported are:
4344 `:pt-width WIDTH'
4346 WIDTH is width of the image in pt (1/72 inch).  WIDTH must be an
4347 integer.  This is a required property.
4349 `:pt-height HEIGHT'
4351 HEIGHT specifies the height of the image in pt (1/72 inch).  HEIGHT
4352 must be a integer.  This is an required property.
4354 `:bounding-box BOX'
4356 BOX must be a list or vector of 4 integers giving the bounding box of
4357 the PS image, analogous to the `BoundingBox' comment found in PS
4358 files.  This is an required property.
4360 Part of the Ghostscript interface is implemented in Lisp.  See
4361 lisp/gs.el.
4363 *** Lisp interface.
4365 The variable `image-types' contains a list of those image types
4366 which are supported in the current configuration.
4368 Images are stored in an image cache and removed from the cache when
4369 they haven't been displayed for `image-cache-eviction-delay seconds.
4370 The function `clear-image-cache' can be used to clear the image cache
4371 manually.  Images in the cache are compared with `equal', i.e. all
4372 images with `equal' specifications share the same image.
4374 *** Simplified image API, image.el
4376 The new Lisp package image.el contains functions that simplify image
4377 creation and putting images into text.  The function `create-image'
4378 can be used to create images.  The macro `defimage' can be used to
4379 define an image based on available image types.  The functions
4380 `put-image' and `insert-image' can be used to insert an image into a
4381 buffer.
4383 ** Display margins.
4385 Windows can now have margins which are used for special text
4386 and images.
4388 To give a window margins, either set the buffer-local variables
4389 `left-margin-width' and `right-margin-width', or call
4390 `set-window-margins'.  The function `window-margins' can be used to
4391 obtain the current settings.  To make `left-margin-width' and
4392 `right-margin-width' take effect, you must set them before displaying
4393 the buffer in a window, or use `set-window-buffer' to force an update
4394 of the display margins.
4396 You can put text in margins by giving it a `display' text property
4397 containing a pair of the form `(LOCATION . VALUE)', where LOCATION is
4398 one of `left-margin' or `right-margin' or nil.  VALUE can be either a
4399 string, an image specification or a stretch specification (see later
4400 in this file).
4402 ** Help display
4404 Emacs displays short help messages in the echo area, when the mouse
4405 moves over a tool-bar item or a piece of text that has a text property
4406 `help-echo'.  This feature also applies to strings in the mode line
4407 that have a `help-echo' property.
4409 If the value of the `help-echo' property is a function, that function
4410 is called with three arguments WINDOW, OBJECT and POSITION.  WINDOW is
4411 the window in which the help was found.
4413 If OBJECT is a buffer, POS is the position in the buffer where the
4414 `help-echo' text property was found.
4416 If OBJECT is an overlay, that overlay has a `help-echo' property, and
4417 POS is the position in the overlay's buffer under the mouse.
4419 If OBJECT is a string (an overlay string or a string displayed with
4420 the `display' property), POS is the position in that string under the
4421 mouse.
4423 If the value of the `help-echo' property is neither a function nor a
4424 string, it is evaluated to obtain a help string.
4426 For tool-bar and menu-bar items, their key definition is used to
4427 determine the help to display.  If their definition contains a
4428 property `:help FORM', FORM is evaluated to determine the help string.
4429 For tool-bar items without a help form, the caption of the item is
4430 used as help string.
4432 The hook `show-help-function' can be set to a function that displays
4433 the help string differently.  For example, enabling a tooltip window
4434 causes the help display to appear there instead of in the echo area.
4436 ** Vertical fractional scrolling.
4438 The display of text in windows can be scrolled smoothly in pixels.
4439 This is useful, for example, for making parts of large images visible.
4441 The function `window-vscroll' returns the current value of vertical
4442 scrolling, a non-negative fraction of the canonical character height.
4443 The function `set-window-vscroll' can be used to set the vertical
4444 scrolling value.  Here is an example of how these function might be
4445 used.
4447   (global-set-key [A-down]
4448     #'(lambda ()
4449         (interactive)
4450         (set-window-vscroll (selected-window)
4451                             (+ 0.5 (window-vscroll)))))
4452   (global-set-key [A-up]
4453     #'(lambda ()
4454         (interactive)
4455         (set-window-vscroll (selected-window)
4456                             (- (window-vscroll) 0.5)))))
4458 ** New hook `fontification-functions'.
4460 Functions from `fontification-functions' are called from redisplay
4461 when it encounters a region of text that is not yet fontified.  This
4462 variable automatically becomes buffer-local when set.  Each function
4463 is called with one argument, POS.
4465 At least one of the hook functions should fontify one or more
4466 characters starting at POS in the current buffer.  It should mark them
4467 as fontified by giving them a non-nil value of the `fontified' text
4468 property.  It may be reasonable for these functions to check for the
4469 `fontified' property and not put it back on, but they do not have to.
4471 ** Tool bar support.
4473 Emacs supports a tool bar at the top of a frame under X.  The frame
4474 parameter `tool-bar-lines' (X resource "toolBar", class "ToolBar")
4475 controls how may lines to reserve for the tool bar.  A zero value
4476 suppresses the tool bar.  If the value is non-zero and
4477 `auto-resize-tool-bars' is non-nil the tool bar's size will be changed
4478 automatically so that all tool bar items are visible.
4480 *** Tool bar item definitions
4482 Tool bar items are defined using `define-key' with a prefix-key
4483 `tool-bar'.  For example `(define-key global-map [tool-bar item1] ITEM)'
4484 where ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
4486 CAPTION is the caption of the item, If it's not a string, it is
4487 evaluated to get a string.  The caption is currently not displayed in
4488 the tool bar, but it is displayed if the item doesn't have a `:help'
4489 property (see below).
4491 BINDING is the tool bar item's binding.  Tool bar items with keymaps as
4492 binding are currently ignored.
4494 The following properties are recognized:
4496 `:enable FORM'.
4498 FORM is evaluated and specifies whether the tool bar item is enabled
4499 or disabled.
4501 `:visible FORM'
4503 FORM is evaluated and specifies whether the tool bar item is displayed.
4505 `:filter FUNCTION'
4507 FUNCTION is called with one parameter, the same list BINDING in which
4508 FUNCTION is specified as the filter.  The value FUNCTION returns is
4509 used instead of BINDING to display this item.
4511 `:button (TYPE SELECTED)'
4513 TYPE must be one of `:radio' or `:toggle'.  SELECTED is evaluated
4514 and specifies whether the button is selected (pressed) or not.
4516 `:image IMAGES'
4518 IMAGES is either a single image specification or a vector of four
4519 image specifications.  If it is a vector, this table lists the
4520 meaning of each of the four elements:
4522    Index        Use when item is
4523    ----------------------------------------
4524      0          enabled and selected
4525      1          enabled and deselected
4526      2          disabled and selected
4527      3          disabled and deselected
4529 If IMAGE is a single image specification, a Laplace edge-detection
4530 algorithm is used on that image to draw the image in disabled state.
4532 `:help HELP-STRING'.
4534 Gives a help string to display for the tool bar item.  This help
4535 is displayed when the mouse is moved over the item.
4537 The function `toolbar-add-item' is a convenience function for adding
4538 toolbar items generally, and `tool-bar-add-item-from-menu' can be used
4539 to define a toolbar item with a binding copied from an item on the
4540 menu bar.
4542 The default bindings use a menu-item :filter to derive the tool-bar
4543 dynamically from variable `tool-bar-map' which may be set
4544 buffer-locally to override the global map.
4546 *** Tool-bar-related variables.
4548 If `auto-resize-tool-bar' is non-nil, the tool bar will automatically
4549 resize to show all defined tool bar items.  It will never grow larger
4550 than 1/4 of the frame's size.
4552 If `auto-raise-tool-bar-buttons' is non-nil, tool bar buttons will be
4553 raised when the mouse moves over them.
4555 You can add extra space between tool bar items by setting
4556 `tool-bar-button-margin' to a positive integer specifying a number of
4557 pixels, or a pair of integers (X . Y) specifying horizontal and
4558 vertical margins .  Default is 1.
4560 You can change the shadow thickness of tool bar buttons by setting
4561 `tool-bar-button-relief' to an integer.  Default is 3.
4563 *** Tool-bar clicks with modifiers.
4565 You can bind commands to clicks with control, shift, meta etc. on
4566 a tool bar item.  If
4568   (define-key global-map [tool-bar shell]
4569     '(menu-item "Shell" shell
4570                 :image (image :type xpm :file "shell.xpm")))
4572 is the original tool bar item definition, then
4574   (define-key global-map [tool-bar S-shell] 'some-command)
4576 makes a binding to run `some-command' for a shifted click on the same
4577 item.
4579 ** Mode line changes.
4581 *** Mouse-sensitive mode line.
4583 The mode line can be made mouse-sensitive by displaying strings there
4584 that have a `local-map' text property.  There are three ways to display
4585 a string with a `local-map' property in the mode line.
4587 1. The mode line spec contains a variable whose string value has
4588 a `local-map' text property.
4590 2. The mode line spec contains a format specifier (e.g. `%12b'), and
4591 that format specifier has a `local-map' property.
4593 3. The mode line spec contains a list containing `:eval FORM'.  FORM
4594 is evaluated.  If the result is a string, and that string has a
4595 `local-map' property.
4597 The same mechanism is used to determine the `face' and `help-echo'
4598 properties of strings in the mode line.  See `bindings.el' for an
4599 example.
4601 *** If a mode line element has the form `(:eval FORM)', FORM is
4602 evaluated and the result is used as mode line element.
4604 *** You can suppress mode-line display by setting the buffer-local
4605 variable mode-line-format to nil.
4607 *** A headerline can now be displayed at the top of a window.
4609 This mode line's contents are controlled by the new variable
4610 `header-line-format' and `default-header-line-format' which are
4611 completely analogous to `mode-line-format' and
4612 `default-mode-line-format'.  A value of nil means don't display a top
4613 line.
4615 The appearance of top mode lines is controlled by the face
4616 `header-line'.
4618 The function `coordinates-in-window-p' returns `header-line' for a
4619 position in the header-line.
4621 ** Text property `display'
4623 The `display' text property is used to insert images into text,
4624 replace text with other text, display text in marginal area, and it is
4625 also used to control other aspects of how text displays.  The value of
4626 the `display' property should be a display specification, as described
4627 below, or a list or vector containing display specifications.
4629 *** Replacing text, displaying text in marginal areas
4631 To replace the text having the `display' property with some other
4632 text, use a display specification of the form `(LOCATION STRING)'.
4634 If LOCATION is `(margin left-margin)', STRING is displayed in the left
4635 marginal area, if it is `(margin right-margin)', it is displayed in
4636 the right marginal area, and if LOCATION is `(margin nil)' STRING
4637 is displayed in the text.  In the latter case you can also use the
4638 simpler form STRING as property value.
4640 *** Variable width and height spaces
4642 To display a space of fractional width or height, use a display
4643 specification of the form `(LOCATION STRECH)'.  If LOCATION is
4644 `(margin left-margin)', the space is displayed in the left marginal
4645 area, if it is `(margin right-margin)', it is displayed in the right
4646 marginal area, and if LOCATION is `(margin nil)' the space is
4647 displayed in the text.  In the latter case you can also use the
4648 simpler form STRETCH as property value.
4650 The stretch specification STRETCH itself is a list of the form `(space
4651 PROPS)', where PROPS is a property list which can contain the
4652 properties described below.
4654 The display of the fractional space replaces the display of the
4655 characters having the `display' property.
4657 - :width WIDTH
4659 Specifies that the space width should be WIDTH times the normal
4660 character width.  WIDTH can be an integer or floating point number.
4662 - :relative-width FACTOR
4664 Specifies that the width of the stretch should be computed from the
4665 first character in a group of consecutive characters that have the
4666 same `display' property.  The computation is done by multiplying the
4667 width of that character by FACTOR.
4669 - :align-to HPOS
4671 Specifies that the space should be wide enough to reach HPOS.  The
4672 value HPOS is measured in units of the normal character width.
4674 Exactly one of the above properties should be used.
4676 - :height HEIGHT
4678 Specifies the height of the space, as HEIGHT, measured in terms of the
4679 normal line height.
4681 - :relative-height FACTOR
4683 The height of the space is computed as the product of the height
4684 of the text having the `display' property and FACTOR.
4686 - :ascent ASCENT
4688 Specifies that ASCENT percent of the height of the stretch should be
4689 used for the ascent of the stretch, i.e. for the part above the
4690 baseline.  The value of ASCENT must be a non-negative number less or
4691 equal to 100.
4693 You should not use both `:height' and `:relative-height' together.
4695 *** Images
4697 A display specification for an image has the form `(LOCATION
4698 . IMAGE)', where IMAGE is an image specification.  The image replaces,
4699 in the display, the characters having this display specification in
4700 their `display' text property.  If LOCATION is `(margin left-margin)',
4701 the image will be displayed in the left marginal area, if it is
4702 `(margin right-margin)' it will be displayed in the right marginal
4703 area, and if LOCATION is `(margin nil)' the image will be displayed in
4704 the text.  In the latter case you can also use the simpler form IMAGE
4705 as display specification.
4707 *** Other display properties
4709 - (space-width FACTOR)
4711 Specifies that space characters in the text having that property
4712 should be displayed FACTOR times as wide as normal; FACTOR must be an
4713 integer or float.
4715 - (height HEIGHT)
4717 Display text having this property in a font that is smaller or larger.
4719 If HEIGHT is a list of the form `(+ N)', where N is an integer, that
4720 means to use a font that is N steps larger.  If HEIGHT is a list of
4721 the form `(- N)', that means to use a font that is N steps smaller.  A
4722 ``step'' is defined by the set of available fonts; each size for which
4723 a font is available counts as a step.
4725 If HEIGHT is a number, that means to use a font that is HEIGHT times
4726 as tall as the frame's default font.
4728 If HEIGHT is a symbol, it is called as a function with the current
4729 height as argument.  The function should return the new height to use.
4731 Otherwise, HEIGHT is evaluated to get the new height, with the symbol
4732 `height' bound to the current specified font height.
4734 - (raise FACTOR)
4736 FACTOR must be a number, specifying a multiple of the current
4737 font's height.  If it is positive, that means to display the characters
4738 raised.  If it is negative, that means to display them lower down.  The
4739 amount of raising or lowering is computed without taking account of the
4740 `height' subproperty.
4742 *** Conditional display properties
4744 All display specifications can be conditionalized.  If a specification
4745 has the form `(when CONDITION . SPEC)', the specification SPEC applies
4746 only when CONDITION yields a non-nil value when evaluated.  During the
4747 evaluation, `object' is bound to the string or buffer having the
4748 conditional display property; `position' and `buffer-position' are
4749 bound to the position within `object' and the buffer position where
4750 the display property was found, respectively.  Both positions can be
4751 different when object is a string.
4753 The normal specification consisting of SPEC only is equivalent to
4754 `(when t . SPEC)'.
4756 ** New menu separator types.
4758 Emacs now supports more than one menu separator type.  Menu items with
4759 item names consisting of dashes only (including zero dashes) are
4760 treated like before.  In addition, the following item names are used
4761 to specify other menu separator types.
4763 - `--no-line' or `--space', or `--:space', or `--:noLine'
4765 No separator lines are drawn, but a small space is inserted where the
4766 separator occurs.
4768 - `--single-line' or `--:singleLine'
4770 A single line in the menu's foreground color.
4772 - `--double-line' or `--:doubleLine'
4774 A double line in the menu's foreground color.
4776 - `--single-dashed-line' or `--:singleDashedLine'
4778 A single dashed line in the menu's foreground color.
4780 - `--double-dashed-line' or `--:doubleDashedLine'
4782 A double dashed line in the menu's foreground color.
4784 - `--shadow-etched-in' or `--:shadowEtchedIn'
4786 A single line with 3D sunken appearance.  This is the form
4787 displayed for item names consisting of dashes only.
4789 - `--shadow-etched-out' or `--:shadowEtchedOut'
4791 A single line with 3D raised appearance.
4793 - `--shadow-etched-in-dash' or `--:shadowEtchedInDash'
4795 A single dashed line with 3D sunken appearance.
4797 - `--shadow-etched-out-dash' or `--:shadowEtchedOutDash'
4799 A single dashed line with 3D raise appearance.
4801 - `--shadow-double-etched-in' or `--:shadowDoubleEtchedIn'
4803 Two lines with 3D sunken appearance.
4805 - `--shadow-double-etched-out' or `--:shadowDoubleEtchedOut'
4807 Two lines with 3D raised appearance.
4809 - `--shadow-double-etched-in-dash' or `--:shadowDoubleEtchedInDash'
4811 Two dashed lines with 3D sunken appearance.
4813 - `--shadow-double-etched-out-dash' or `--:shadowDoubleEtchedOutDash'
4815 Two dashed lines with 3D raised appearance.
4817 Under LessTif/Motif, the last four separator types are displayed like
4818 the corresponding single-line separators.
4820 ** New frame parameters for scroll bar colors.
4822 The new frame parameters `scroll-bar-foreground' and
4823 `scroll-bar-background' can be used to change scroll bar colors.
4824 Their value must be either a color name, a string, or nil to specify
4825 that scroll bars should use a default color.  For toolkit scroll bars,
4826 default colors are toolkit specific.  For non-toolkit scroll bars, the
4827 default background is the background color of the frame, and the
4828 default foreground is black.
4830 The X resource name of these parameters are `scrollBarForeground'
4831 (class ScrollBarForeground) and `scrollBarBackground' (class
4832 `ScrollBarBackground').
4834 Setting these parameters overrides toolkit specific X resource
4835 settings for scroll bar colors.
4837 ** You can set `redisplay-dont-pause' to a non-nil value to prevent
4838 display updates from being interrupted when input is pending.
4840 ** Changing a window's width may now change its window start if it
4841 starts on a continuation line.  The new window start is computed based
4842 on the window's new width, starting from the start of the continued
4843 line as the start of the screen line with the minimum distance from
4844 the original window start.
4846 ** The variable `hscroll-step' and the functions
4847 `hscroll-point-visible' and `hscroll-window-column' have been removed
4848 now that proper horizontal scrolling is implemented.
4850 ** Windows can now be made fixed-width and/or fixed-height.
4852 A window is fixed-size if its buffer has a buffer-local variable
4853 `window-size-fixed' whose value is not nil.  A value of `height' makes
4854 windows fixed-height, a value of `width' makes them fixed-width, any
4855 other non-nil value makes them both fixed-width and fixed-height.
4857 The following code makes all windows displaying the current buffer
4858 fixed-width and fixed-height.
4860   (set (make-local-variable 'window-size-fixed) t)
4862 A call to enlarge-window on a window gives an error if that window is
4863 fixed-width and it is tried to change the window's width, or if the
4864 window is fixed-height, and it is tried to change its height.  To
4865 change the size of a fixed-size window, bind `window-size-fixed'
4866 temporarily to nil, for example
4868   (let ((window-size-fixed nil))
4869      (enlarge-window 10))
4871 Likewise, an attempt to split a fixed-height window vertically,
4872 or a fixed-width window horizontally results in a error.
4874 ** The cursor-type frame parameter is now supported on MS-DOS
4875 terminals.  When Emacs starts, it by default changes the cursor shape
4876 to a solid box, as it does on Unix.  The `cursor-type' frame parameter
4877 overrides this as it does on Unix, except that the bar cursor is
4878 horizontal rather than vertical (since the MS-DOS display doesn't
4879 support a vertical-bar cursor).
4883 ----------------------------------------------------------------------
4884 This file is part of GNU Emacs.
4886 GNU Emacs is free software; you can redistribute it and/or modify
4887 it under the terms of the GNU General Public License as published by
4888 the Free Software Foundation; either version 2, or (at your option)
4889 any later version.
4891 GNU Emacs is distributed in the hope that it will be useful,
4892 but WITHOUT ANY WARRANTY; without even the implied warranty of
4893 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
4894 GNU General Public License for more details.
4896 You should have received a copy of the GNU General Public License
4897 along with GNU Emacs; see the file COPYING.  If not, write to the
4898 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
4899 Boston, MA 02110-1301, USA.
4902 Local variables:
4903 mode: outline
4904 paragraph-separate: "[  \f]*$"
4905 end: