1 This is ../info/lispref.info, produced by makeinfo version 4.0b from
4 INFO-DIR-SECTION XEmacs Editor
6 * Lispref: (lispref). XEmacs Lisp Reference Manual.
11 GNU Emacs Lisp Reference Manual Second Edition (v2.01), May 1993 GNU
12 Emacs Lisp Reference Manual Further Revised (v2.02), August 1993 Lucid
13 Emacs Lisp Reference Manual (for 19.10) First Edition, March 1994
14 XEmacs Lisp Programmer's Manual (for 19.12) Second Edition, April 1995
15 GNU Emacs Lisp Reference Manual v2.4, June 1995 XEmacs Lisp
16 Programmer's Manual (for 19.13) Third Edition, July 1995 XEmacs Lisp
17 Reference Manual (for 19.14 and 20.0) v3.1, March 1996 XEmacs Lisp
18 Reference Manual (for 19.15 and 20.1, 20.2, 20.3) v3.2, April, May,
19 November 1997 XEmacs Lisp Reference Manual (for 21.0) v3.3, April 1998
21 Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995 Free Software
22 Foundation, Inc. Copyright (C) 1994, 1995 Sun Microsystems, Inc.
23 Copyright (C) 1995, 1996 Ben Wing.
25 Permission is granted to make and distribute verbatim copies of this
26 manual provided the copyright notice and this permission notice are
27 preserved on all copies.
29 Permission is granted to copy and distribute modified versions of
30 this manual under the conditions for verbatim copying, provided that the
31 entire resulting derived work is distributed under the terms of a
32 permission notice identical to this one.
34 Permission is granted to copy and distribute translations of this
35 manual into another language, under the above conditions for modified
36 versions, except that this permission notice may be stated in a
37 translation approved by the Foundation.
39 Permission is granted to copy and distribute modified versions of
40 this manual under the conditions for verbatim copying, provided also
41 that the section entitled "GNU General Public License" is included
42 exactly as in the original, and provided that the entire resulting
43 derived work is distributed under the terms of a permission notice
44 identical to this one.
46 Permission is granted to copy and distribute translations of this
47 manual into another language, under the above conditions for modified
48 versions, except that the section entitled "GNU General Public License"
49 may be included in a translation approved by the Free Software
50 Foundation instead of in the original English.
53 File: lispref.info, Node: Standard Buffer-Local Variables, Next: Standard Keymaps, Prev: Standard Errors, Up: Top
55 Buffer-Local Variables
56 **********************
58 The table below lists the general-purpose Emacs variables that are
59 automatically local (when set) in each buffer. Many Lisp packages
60 define such variables for their internal use; we don't list them here.
68 `buffer-auto-save-file-name'
74 `buffer-display-table'
75 *note Display Tables::
78 *note Format Conversion::
81 *note Buffer File Name::
84 *note Buffer File Name::
86 `buffer-file-truename'
87 *note Buffer File Name::
90 *note Files and MS-DOS::
92 `buffer-invisibility-spec'
93 *note Invisible Text::
96 *note Saving Buffers::
99 *note Read Only Buffers::
107 `cache-long-line-scans'
111 *note Searching and Case::
114 *note Usual Display::
117 *note Comments: (xemacs)Comments.
120 *note System Environment::
122 `defun-prompt-regexp'
129 *note Moving Point: (xemacs)Moving Point.
137 `local-write-file-hooks'
138 *note Saving Buffers::
153 *note Modeline Data::
155 `modeline-buffer-identification'
156 *note Modeline Variables::
159 *note Modeline Data::
162 *note Modeline Variables::
165 *note Modeline Variables::
168 *note Modeline Variables::
174 *note Standard Regexps::
177 *note Standard Regexps::
179 `point-before-scroll'
180 Used for communication between mouse commands and scroll-bar
183 `require-final-newline'
187 *note Selective Display::
189 `selective-display-ellipses'
190 *note Selective Display::
193 *note Usual Display::
199 *note Modeline Variables::
202 File: lispref.info, Node: Standard Keymaps, Next: Standard Hooks, Prev: Standard Buffer-Local Variables, Up: Top
207 The following symbols are used as the names for various keymaps.
208 Some of these exist when XEmacs is first started, others are loaded
209 only when their respective mode is used. This is not an exhaustive
212 Almost all of these maps are used as local maps. Indeed, of the
213 modes that presently exist, only Vip mode and Terminal mode ever change
217 A keymap containing bindings to bookmark functions.
219 `Buffer-menu-mode-map'
220 A keymap used by Buffer Menu mode.
223 A keymap used by C++ mode.
226 A keymap used by C mode. A sparse keymap used by C mode.
228 `command-history-map'
229 A keymap used by Command History mode.
232 A keymap for subcommands of the prefix `C-x 4'.
235 A keymap for subcommands of the prefix `C-x 5'.
238 A keymap for `C-x' commands.
241 A keymap used by Debugger mode.
244 A keymap for `dired-mode' buffers.
247 A keymap used in `edit-abbrevs'.
250 A keymap used in `edit-tab-stops'.
252 `electric-buffer-menu-mode-map'
253 A keymap used by Electric Buffer Menu mode.
255 `electric-history-map'
256 A keymap used by Electric Command History mode.
258 `emacs-lisp-mode-map'
259 A keymap used by Emacs Lisp mode.
262 A keymap for characters following the Help key.
265 A keymap used by the help utility package.
266 It has the same keymap in its value cell and in its function cell.
269 A keymap used by the `e' command of Info.
272 A keymap containing Info commands.
275 A keymap that defines the characters you can type within
279 A keymap used when in Itimer Edit mode.
281 `lisp-interaction-mode-map'
282 A keymap used by Lisp mode.
285 A keymap used by Lisp mode.
287 A keymap for minibuffer input with completion.
289 `minibuffer-local-isearch-map'
290 A keymap for editing isearch strings in the minibuffer.
292 `minibuffer-local-map'
293 Default keymap to use when reading from the minibuffer.
295 `minibuffer-local-must-match-map'
296 A keymap for minibuffer input with completion, for exact match.
299 The keymap for characters following `C-c'. Note, this is in the
300 global map. This map is not actually mode specific: its name was
301 chosen to be informative for the user in `C-h b'
302 (`display-bindings'), where it describes the main use of the `C-c'
306 The keymap consulted for mouse-clicks on the modeline of a window.
309 A keymap used in Objective C mode as a local map.
312 A local keymap used by Occur mode.
314 `overriding-local-map'
315 A keymap that overrides all other local keymaps.
318 A local keymap used for responses in `query-replace' and related
319 commands; also for `y-or-n-p' and `map-y-or-n-p'. The functions
320 that use this map do not support prefix keys; they look up one
323 `read-expression-map'
324 The minibuffer keymap used for reading Lisp expressions.
326 `read-shell-command-map'
327 The minibuffer keymap used by `shell-command' and related commands.
329 `shared-lisp-mode-map'
330 A keymap for commands shared by all sorts of Lisp modes.
333 A keymap used by Text mode.
336 The keymap consulted for mouse-clicks over a toolbar.
339 A keymap used by View mode.
342 File: lispref.info, Node: Standard Hooks, Next: Index, Prev: Standard Keymaps, Up: Top
347 The following is a list of hook variables that let you provide
348 functions to be called from within Emacs on suitable occasions.
350 Most of these variables have names ending with `-hook'. They are
351 "normal hooks", run by means of `run-hooks'. The value of such a hook
352 is a list of functions. The recommended way to put a new function on
353 such a hook is to call `add-hook'. *Note Hooks::, for more information
356 The variables whose names end in `-function' have single functions
357 as their values. Usually there is a specific reason why the variable is
358 not a normal hook, such as the need to pass arguments to the function.
359 (In older Emacs versions, some of these variables had names ending in
360 `-hook' even though they were not normal hooks.)
362 The variables whose names end in `-hooks' or `-functions' have lists
363 of functions as their values, but these functions are called in a
364 special way (they are passed arguments, or else their values are used).
366 `activate-menubar-hook'
368 `activate-popup-menu-hook'
370 `ad-definition-hooks'
372 `adaptive-fill-function'
374 `add-log-current-defun-function'
376 `after-change-functions'
378 `after-delete-annotation-hook'
382 `after-insert-file-functions'
388 `after-set-visited-file-name-hooks'
390 `after-write-file-hooks'
396 `before-change-functions'
398 `before-delete-annotation-hook'
404 `blink-paren-function'
406 `buffers-menu-switch-to-buffer-function'
416 `c-special-indent-hook'
420 `change-major-mode-hook'
422 `command-history-hook'
424 `comment-indent-function'
426 `compilation-buffer-name-function'
428 `compilation-exit-message-function'
430 `compilation-finish-function'
432 `compilation-parse-errors-function'
434 `compilation-mode-hook'
436 `create-console-hook'
442 `dabbrev-friend-buffer-function'
444 `dabbrev-select-buffers-function'
446 `delete-console-hook'
452 `deselect-frame-hook'
458 `dired-after-readin-hook'
460 `dired-before-readin-hook'
466 `disabled-command-hook'
468 `display-buffer-function'
470 `ediff-after-setup-control-frame-hook'
472 `ediff-after-setup-windows-hook'
474 `ediff-before-setup-control-frame-hook'
476 `ediff-before-setup-windows-hook'
478 `ediff-brief-help-message-function'
482 `ediff-control-frame-position-function'
484 `ediff-display-help-hook'
486 `ediff-focus-on-regexp-matches-function'
488 `ediff-forward-word-function'
490 `ediff-hide-regexp-matches-function'
492 `ediff-keymap-setup-hook'
496 `ediff-long-help-message-function'
498 `ediff-make-wide-display-function'
500 `ediff-merge-split-window-function'
502 `ediff-meta-action-function'
504 `ediff-meta-redraw-function'
508 `ediff-prepare-buffer-hook'
512 `ediff-registry-setup-hook'
516 `ediff-session-action-function'
518 `ediff-session-group-setup-hook'
520 `ediff-setup-diff-regions-function'
522 `ediff-show-registry-hook'
524 `ediff-show-session-group-hook'
526 `ediff-skip-diff-region-function'
528 `ediff-split-window-function'
534 `ediff-toggle-read-only-function'
536 `ediff-unselect-hook'
538 `ediff-window-setup-function'
542 `electric-buffer-menu-mode-hook'
544 `electric-command-history-hook'
546 `electric-help-mode-hook'
548 `emacs-lisp-mode-hook'
550 `fill-paragraph-function'
554 `find-file-not-found-hooks'
558 `font-lock-after-fontify-buffer-hook'
560 `font-lock-beginning-of-syntax-function'
562 `font-lock-mode-hook'
564 `fume-found-function-hook'
566 `fume-list-mode-hook'
568 `fume-rescan-buffer-hook'
574 `hack-local-variables-hook'
576 `highlight-headers-follow-url-function'
578 `hyper-apropos-mode-hook'
580 `indent-line-function'
584 `indent-region-function'
586 `initial-calendar-window-hook'
588 `isearch-mode-end-hook'
596 `kill-buffer-query-functions'
600 `kill-emacs-query-functions'
610 `lisp-indent-function'
612 `lisp-interaction-mode-hook'
616 `list-diary-entries-hook'
620 `log-message-filter-function'
630 `make-annotation-hook'
636 `mark-diary-entries-hook'
640 `menu-no-selection-hook'
642 `mh-compose-letter-hook'
644 `mh-folder-mode-hook'
646 `mh-letter-mode-hook'
650 `minibuffer-exit-hook'
652 `minibuffer-setup-hook'
656 `mouse-enter-frame-hook'
658 `mouse-leave-frame-hook'
660 `mouse-track-cleanup-hook'
662 `mouse-track-click-hook'
664 `mouse-track-down-hook'
666 `mouse-track-drag-hook'
668 `mouse-track-drag-up-hook'
670 `mouse-track-up-hook'
672 `mouse-yank-function'
676 `news-reply-mode-hook'
680 `nongregorian-diary-listing-hook'
682 `nongregorian-diary-marking-hook'
692 `plain-TeX-mode-hook'
698 `pre-abbrev-expand-hook'
702 `pre-display-buffer-function'
708 `print-diary-entries-hook'
712 `protect-innocence-hook'
714 `remove-message-hook'
716 `revert-buffer-function'
718 `revert-buffer-insert-contents-function'
720 `rmail-edit-mode-hook'
724 `rmail-retry-setup-hook'
726 `rmail-summary-mode-hook'
740 `shell-set-directory-error-hook'
742 `special-display-function'
746 `suspend-resume-hook'
748 `temp-buffer-show-function'
754 `terminal-mode-break-hook'
762 `today-visible-calendar-hook'
764 `today-invisible-calendar-hook'
766 `tooltalk-message-handler-hook'
768 `tooltalk-pattern-handler-hook'
770 `tooltalk-unprocessed-message-hook'
776 `vc-checkout-writable-buffer-hook'
778 `vc-log-after-operation-hook'
780 `vc-make-buffer-writable-hook'
784 `vm-arrived-message-hook'
786 `vm-arrived-messages-hook'
788 `vm-chop-full-name-function'
790 `vm-display-buffer-hook'
792 `vm-edit-message-hook'
794 `vm-forward-message-hook'
796 `vm-iconify-frame-hook'
798 `vm-inhibit-write-file-hook'
812 `vm-rename-current-buffer-function'
816 `vm-resend-bounced-message-hook'
818 `vm-resend-message-hook'
820 `vm-retrieved-spooled-mail-hook'
822 `vm-select-message-hook'
824 `vm-select-new-message-hook'
826 `vm-select-unread-message-hook'
828 `vm-send-digest-hook'
830 `vm-summary-mode-hook'
832 `vm-summary-pointer-update-hook'
834 `vm-summary-redo-hook'
836 `vm-summary-update-hook'
838 `vm-undisplay-buffer-hook'
840 `vm-visit-folder-hook'
844 `write-contents-hooks'
846 `write-file-data-hooks'
850 `write-region-annotate-functions'
852 `x-lost-selection-hooks'
854 `x-sent-selection-hooks'
856 `zmacs-activate-region-hook'
858 `zmacs-deactivate-region-hook'
860 `zmacs-update-region-hook'