annotate lispref/hooks.texi @ 26436:8d7a976d7700

Use new backquote syntax. (forms--make-format-elt-using-text-properties): Treat `intangible' differently.
author Gerd Moellmann <gerd@gnu.org>
date Sat, 13 Nov 1999 22:05:56 +0000
parents d4ac295a98b3
children df31899ab320
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16056
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1998 Free Software Foundation, Inc.
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4 @c See the file elisp.texi for copying conditions.
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5 @setfilename ../info/hooks
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7600
diff changeset
6 @node Standard Hooks, Index, Standard Keymaps, Top
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
7 @appendix Standard Hooks
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8
7600
8bf07ff6a929 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6782
diff changeset
9 The following is a list of hook variables that let you provide
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 functions to be called from within Emacs on suitable occasions.
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11
7600
8bf07ff6a929 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6782
diff changeset
12 Most of these variables have names ending with @samp{-hook}. They are
8bf07ff6a929 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6782
diff changeset
13 @dfn{normal hooks}, run by means of @code{run-hooks}. The value of such
16056
bfe1d6597f08 Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents: 12098
diff changeset
14 a hook is a list of functions; the functions are called with no
bfe1d6597f08 Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents: 12098
diff changeset
15 arguments and their values are completely ignored. The recommended way
bfe1d6597f08 Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents: 12098
diff changeset
16 to put a new function on such a hook is to call @code{add-hook}.
bfe1d6597f08 Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents: 12098
diff changeset
17 @xref{Hooks}, for more information about using hooks.
bfe1d6597f08 Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents: 12098
diff changeset
18
bfe1d6597f08 Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents: 12098
diff changeset
19 The variables whose names end in @samp{-hooks} or @samp{-functions} are
bfe1d6597f08 Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents: 12098
diff changeset
20 usually @dfn{abnormal hooks}; their values are lists of functions, but
bfe1d6597f08 Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents: 12098
diff changeset
21 these functions are called in a special way (they are passed arguments,
bfe1d6597f08 Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents: 12098
diff changeset
22 or their values are used). A few of these variables are actually normal
bfe1d6597f08 Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents: 12098
diff changeset
23 hooks which were named before we established the convention that normal
bfe1d6597f08 Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents: 12098
diff changeset
24 hooks' names should end in @samp{-hook}.
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26 The variables whose names end in @samp{-function} have single functions
16056
bfe1d6597f08 Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents: 12098
diff changeset
27 as their values. (In older Emacs versions, some of these variables had
bfe1d6597f08 Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents: 12098
diff changeset
28 names ending in @samp{-hook} even though they were not normal hooks;
bfe1d6597f08 Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents: 12098
diff changeset
29 however, we have renamed all of those.)
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 @c !!! need xref to where each hook is documented or else document it
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32 @c by specifying what is expected, and when it is called relative to
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
33 @c mode initialization.
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35 @table @code
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 @item activate-mark-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 @item after-change-function
6782
5b07647ec8f7 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6440
diff changeset
38 @item after-change-functions
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 @item after-init-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40 @item after-insert-file-functions
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41 @item after-make-frame-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16056
diff changeset
42 @item after-revert-hook
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16056
diff changeset
43 @item after-save-hook
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 @item auto-fill-function
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 @item auto-save-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 @item before-change-function
6782
5b07647ec8f7 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6440
diff changeset
47 @item before-change-functions
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
48 @item before-init-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 @item before-make-frame-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16056
diff changeset
50 @item before-revert-hook
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 @item blink-paren-function
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16056
diff changeset
52 @item buffer-access-fontify-functions
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 @item c-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54 @item calendar-load-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16056
diff changeset
55 @item change-major-mode-hook
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 @item command-history-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16056
diff changeset
57 @item command-line-functions
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58 @item comment-indent-function
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 @item deactivate-mark-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60 @item diary-display-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 @item diary-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 @item dired-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63 @item disabled-command-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16056
diff changeset
64 @item echo-area-clear-hook
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 @item edit-picture-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66 @item electric-buffer-menu-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 @item electric-command-history-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68 @item electric-help-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69 @item emacs-lisp-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 @item find-file-hooks
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 @item find-file-not-found-hooks
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72 @item first-change-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73 @item fortran-comment-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74 @item fortran-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75 @item ftp-setup-write-file-hooks
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76 @item ftp-write-file-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77 @item indent-mim-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
78 @item initial-calendar-window-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16056
diff changeset
79 @item kill-buffer-hook
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
80 @item kill-buffer-query-functions
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16056
diff changeset
81 @item kill-emacs-hook
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
82 @item kill-emacs-query-functions
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
83 @item LaTeX-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
84 @item ledit-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
85 @item lisp-indent-function
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
86 @item lisp-interaction-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
87 @item lisp-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
88 @item list-diary-entries-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16056
diff changeset
89 @item local-write-file-hooks
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
90 @item m2-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
91 @item mail-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
92 @item mail-setup-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
93 @item mark-diary-entries-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
94 @item medit-mode-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16056
diff changeset
95 @item menu-bar-update-hook
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
96 @item minibuffer-setup-hook
6782
5b07647ec8f7 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6440
diff changeset
97 @item minibuffer-exit-hook
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
98 @item news-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
99 @item news-reply-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
100 @item news-setup-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
101 @item nongregorian-diary-listing-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
102 @item nongregorian-diary-marking-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103 @item nroff-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104 @item outline-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
105 @item plain-TeX-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106 @item post-command-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
107 @item pre-abbrev-expand-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
108 @item pre-command-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
109 @item print-diary-entries-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
110 @item prolog-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
111 @item protect-innocence-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16056
diff changeset
112 @item redisplay-end-trigger-functions
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
113 @item rmail-edit-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
114 @item rmail-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
115 @item rmail-summary-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
116 @item scheme-indent-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
117 @item scheme-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
118 @item scribe-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
119 @item shell-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
120 @item shell-set-directory-error-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
121 @item suspend-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
122 @item suspend-resume-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
123 @item temp-buffer-show-function
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
124 @item term-setup-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125 @item terminal-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
126 @item terminal-mode-break-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
127 @item TeX-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
128 @item text-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
129 @item today-visible-calendar-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
130 @item today-invisible-calendar-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
131 @item vi-mode-hook
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
132 @item view-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16056
diff changeset
133 @item window-configuration-change-hook
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16056
diff changeset
134 @item window-scroll-functions
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
135 @item window-setup-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16056
diff changeset
136 @item window-size-change-functions
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
137 @item write-contents-hooks
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
138 @item write-file-hooks
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7600
diff changeset
139 @item write-region-annotate-functions
6440
fe511f97c2de Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
140 @end table