Mercurial > emacs
annotate lispref/hooks.texi @ 52172:d70a2ab90906
*** empty log message ***
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Mon, 11 Aug 2003 17:30:47 +0000 |
parents | 23a1cea22d13 |
children | 695cf19ef79e d7ddb3e565de |
rev | line source |
---|---|
6440 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
45979
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1998 Free Software Foundation, Inc. |
6440 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/hooks | |
12098 | 6 @node Standard Hooks, Index, Standard Keymaps, Top |
6440 | 7 @appendix Standard Hooks |
8 | |
7600 | 9 The following is a list of hook variables that let you provide |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
45979
diff
changeset
|
10 functions to be called from within Emacs on suitable occasions. |
6440 | 11 |
7600 | 12 Most of these variables have names ending with @samp{-hook}. They are |
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 | 25 |
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 | 30 |
31 @c !!! need xref to where each hook is documented or else document it | |
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 | 34 |
35 @table @code | |
36 @item activate-mark-hook | |
6782
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6440
diff
changeset
|
37 @item after-change-functions |
6440 | 38 @item after-init-hook |
39 @item after-insert-file-functions | |
32597
df31899ab320
Missed this file in previous commit.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
22138
diff
changeset
|
40 @item after-make-frame-functions |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
41 @item after-revert-hook |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
42 @item after-save-hook |
39209
a0a6a6a2092f
(Standard Hooks): Add kbd-macro-termination-hook and apropos-mode-hook.
Eli Zaretskii <eliz@gnu.org>
parents:
34306
diff
changeset
|
43 @item apropos-mode-hook |
6440 | 44 @item auto-fill-function |
45 @item auto-save-hook | |
6782
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6440
diff
changeset
|
46 @item before-change-functions |
6440 | 47 @item before-init-hook |
48 @item before-make-frame-hook | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
49 @item before-revert-hook |
6440 | 50 @item blink-paren-function |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
51 @item buffer-access-fontify-functions |
6440 | 52 @item c-mode-hook |
53 @item calendar-load-hook | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
54 @item change-major-mode-hook |
6440 | 55 @item command-history-hook |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
56 @item command-line-functions |
6440 | 57 @item comment-indent-function |
42016
3900be0515b0
Add custom-define-hook.
Richard M. Stallman <rms@gnu.org>
parents:
39209
diff
changeset
|
58 @item custom-define-hook |
6440 | 59 @item deactivate-mark-hook |
60 @item diary-display-hook | |
61 @item diary-hook | |
62 @item dired-mode-hook | |
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 | 65 @item edit-picture-hook |
66 @item electric-buffer-menu-mode-hook | |
67 @item electric-command-history-hook | |
68 @item electric-help-mode-hook | |
69 @item emacs-lisp-mode-hook | |
45979
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42016
diff
changeset
|
70 @item find-file-hook |
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42016
diff
changeset
|
71 @item find-file-not-found-functions |
6440 | 72 @item first-change-hook |
73 @item fortran-comment-hook | |
74 @item fortran-mode-hook | |
75 @item indent-mim-hook | |
76 @item initial-calendar-window-hook | |
39209
a0a6a6a2092f
(Standard Hooks): Add kbd-macro-termination-hook and apropos-mode-hook.
Eli Zaretskii <eliz@gnu.org>
parents:
34306
diff
changeset
|
77 @item kbd-macro-termination-hook |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
78 @item kill-buffer-hook |
6440 | 79 @item kill-buffer-query-functions |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
80 @item kill-emacs-hook |
6440 | 81 @item kill-emacs-query-functions |
82 @item LaTeX-mode-hook | |
83 @item ledit-mode-hook | |
84 @item lisp-indent-function | |
85 @item lisp-interaction-mode-hook | |
86 @item lisp-mode-hook | |
87 @item list-diary-entries-hook | |
88 @item mail-mode-hook | |
89 @item mail-setup-hook | |
90 @item mark-diary-entries-hook | |
91 @item medit-mode-hook | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
92 @item menu-bar-update-hook |
6440 | 93 @item minibuffer-setup-hook |
6782
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6440
diff
changeset
|
94 @item minibuffer-exit-hook |
34306
de5c0dfaf459
Zap before-change-function, ftp-setup-write-file-hooks,
Dave Love <fx@gnu.org>
parents:
32597
diff
changeset
|
95 @item mouse-position-function |
6440 | 96 @item news-mode-hook |
97 @item news-reply-mode-hook | |
98 @item news-setup-hook | |
99 @item nongregorian-diary-listing-hook | |
100 @item nongregorian-diary-marking-hook | |
101 @item nroff-mode-hook | |
102 @item outline-mode-hook | |
103 @item plain-TeX-mode-hook | |
104 @item post-command-hook | |
105 @item pre-abbrev-expand-hook | |
106 @item pre-command-hook | |
107 @item print-diary-entries-hook | |
108 @item prolog-mode-hook | |
109 @item protect-innocence-hook | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
110 @item redisplay-end-trigger-functions |
6440 | 111 @item rmail-edit-mode-hook |
112 @item rmail-mode-hook | |
113 @item rmail-summary-mode-hook | |
114 @item scheme-indent-hook | |
115 @item scheme-mode-hook | |
116 @item scribe-mode-hook | |
117 @item shell-mode-hook | |
118 @item shell-set-directory-error-hook | |
119 @item suspend-hook | |
120 @item suspend-resume-hook | |
121 @item temp-buffer-show-function | |
122 @item term-setup-hook | |
123 @item terminal-mode-hook | |
124 @item terminal-mode-break-hook | |
125 @item TeX-mode-hook | |
126 @item text-mode-hook | |
127 @item today-visible-calendar-hook | |
128 @item today-invisible-calendar-hook | |
129 @item vi-mode-hook | |
130 @item view-hook | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
131 @item window-configuration-change-hook |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
132 @item window-scroll-functions |
6440 | 133 @item window-setup-hook |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
134 @item window-size-change-functions |
45979
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42016
diff
changeset
|
135 @item write-contents-functions |
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42016
diff
changeset
|
136 @item write-file-functions |
12098 | 137 @item write-region-annotate-functions |
6440 | 138 @end table |