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