* src/eval.c (Fcalled_interactively_p): Doc fix. (Bug#11747)
[emacs.git] / doc / lispref / hooks.texi
blob0d29c25c8b10f19622cb04f40c2af0344453ba3b
1 @c -*-texinfo-*-
2 @c This is part of the GNU Emacs Lisp Reference Manual.
3 @c Copyright (C) 1990-1993, 1998, 2001-2012 Free Software Foundation, Inc.
4 @c See the file elisp.texi for copying conditions.
5 @setfilename ../../info/hooks
6 @node Standard Hooks, Index, Standard Keymaps, Top
7 @appendix Standard Hooks
8 @cindex standard hooks
9 @cindex hook variables, list of
11 The following is a list of some hook variables that let you provide
12 functions to be called from within Emacs on suitable occasions.
14 Most of these variables have names ending with @samp{-hook}.  They are
15 @dfn{normal hooks}, run by means of @code{run-hooks}.  The value of such
16 a hook is a list of functions; the functions are called with no
17 arguments and their values are completely ignored.  The recommended way
18 to put a new function on such a hook is to call @code{add-hook}.
19 @xref{Hooks}, for more information about using hooks.
21 The variables whose names end in @samp{-hooks} or @samp{-functions} are
22 usually @dfn{abnormal hooks}; their values are lists of functions, but
23 these functions are called in a special way (they are passed arguments,
24 or their values are used). The variables whose names end in
25 @samp{-function} have single functions as their values.
27 This is not an exhaustive list, it only covers the more general hooks.
28 For example, every major mode defines a hook named
29 @samp{@var{modename}-mode-hook}.  The major mode command runs this
30 normal hook with @code{run-mode-hooks} as the very last thing it does.
31 @xref{Mode Hooks}.  Most minor modes have mode hooks too.
33 A special feature allows you to specify expressions to evaluate if and
34 when a file is loaded (@pxref{Hooks for Loading}).  That feature is
35 not exactly a hook, but does a similar job.
37 @c We need to xref to where each hook is documented or else document it here.
38 @c Add vindex for anything not indexed elsewhere.
39 @c This list is in alphabetical order, grouped by topic.
40 @c TODO It should probably be more thoroughly ordered by topic.
42 @table @code
43 @item activate-mark-hook
44 @itemx deactivate-mark-hook
45 @xref{The Mark}.
47 @item after-change-functions
48 @itemx before-change-functions
49 @itemx first-change-hook
50 @xref{Change Hooks}.
52 @item after-change-major-mode-hook
53 @itemx change-major-mode-after-body-hook
54 @xref{Mode Hooks}.
56 @item after-init-hook
57 @itemx before-init-hook
58 @itemx emacs-startup-hook
59 @xref{Init File}.
61 @item after-insert-file-functions
62 @itemx write-region-annotate-functions
63 @itemx write-region-post-annotation-function
64 @xref{Format Conversion}.
66 @item after-make-frame-functions
67 @itemx before-make-frame-hook
68 @xref{Creating Frames}.
70 @c Not general enough?
71 @ignore
72 @item after-revert-hook
73 @itemx before-revert-hook
74 @itemx buffer-stale-function
75 @itemx revert-buffer-function
76 @itemx revert-buffer-insert-file-contents-function
77 @xref{Reverting}.
78 @end ignore
80 @item after-save-hook
81 @itemx before-save-hook
82 @itemx write-contents-functions
83 @itemx write-file-functions
84 @xref{Saving Buffers}.
86 @item after-setting-font-hook
87 @vindex after-setting-font-hook
88 Hook run after a frame's font changes.
90 @item auto-save-hook
91 @xref{Auto-Saving}.
93 @item before-hack-local-variables-hook
94 @itemx hack-local-variables-hook
95 @xref{File Local Variables}.
97 @item buffer-access-fontify-functions
98 @xref{Lazy Properties}.
100 @item buffer-list-update-hook
101 @vindex buffer-list-update-hook
102 Hook run when the buffer list changes.
104 @item buffer-quit-function
105 @vindex buffer-quit-function
106 Function to call to ``quit'' the current buffer.
108 @item change-major-mode-hook
109 @xref{Creating Buffer-Local}.
111 @item command-line-functions
112 @xref{Command-Line Arguments}.
114 @item delayed-warnings-hook
115 @vindex delayed-warnings-hook
116 The command loop runs this soon after @code{post-command-hook} (q.v.).
118 @item delete-frame-functions
119 @xref{Deleting Frames}.
121 @item delete-terminal-functions
122 @xref{Multiple Terminals}.
124 @ignore
125 @item disabled-command-function
126 @xref{Disabling Commands}.
127 @end ignore
129 @item display-buffer-function
130 @itemx pop-up-frame-function
131 @itemx special-display-function
132 @itemx split-window-preferred-function
133 @xref{Choosing Window Options}.
135 @item echo-area-clear-hook
136 @xref{Echo Area Customization}.
138 @item find-file-hook
139 @itemx find-file-not-found-functions
140 @xref{Visiting Functions}.
142 @item font-lock-extend-after-change-region-function
143 @xref{Region to Refontify}.
145 @item font-lock-extend-region-functions
146 @xref{Multiline Font Lock}.
148 @item font-lock-fontify-buffer-function
149 @itemx font-lock-fontify-region-function
150 @itemx font-lock-mark-block-function
151 @itemx font-lock-unfontify-buffer-function
152 @itemx font-lock-unfontify-region-function
153 @xref{Other Font Lock Variables}.
155 @item fontification-functions
156 @xref{Auto Faces,, Automatic Face Assignment}.
158 @item frame-auto-hide-function
159 @xref{Quitting Windows}.
161 @item kill-buffer-hook
162 @itemx kill-buffer-query-functions
163 @xref{Killing Buffers}.
165 @item kill-emacs-hook
166 @itemx kill-emacs-query-functions
167 @xref{Killing Emacs}.
169 @item menu-bar-update-hook
170 @xref{Menu Bar}.
172 @item minibuffer-setup-hook
173 @itemx minibuffer-exit-hook
174 @xref{Minibuffer Misc}.
176 @item mouse-leave-buffer-hook
177 @vindex mouse-leave-buffer-hook
178 Hook run when about to switch windows with a mouse command.
180 @item mouse-position-function
181 @xref{Mouse Position}.
183 @item post-command-hook
184 @itemx pre-command-hook
185 @xref{Command Overview}.
187 @item post-gc-hook
188 @xref{Garbage Collection}.
190 @item post-self-insert-hook
191 @xref{Keymaps and Minor Modes}.
193 @ignore
194 @item prog-mode-hook
195 @itemx special-mode-hook
196 @vindex special-mode-hook
197 @xref{Basic Major Modes}.
198 @end ignore
200 @item suspend-hook
201 @itemx suspend-resume-hook
202 @itemx suspend-tty-functions
203 @itemx resume-tty-functions
204 @xref{Suspending Emacs}.
206 @item syntax-begin-function
207 @itemx syntax-propertize-extend-region-functions
208 @itemx syntax-propertize-function
209 @itemx font-lock-syntactic-face-function
210 @xref{Syntactic Font Lock}.  @xref{Syntax Properties}.
212 @item temp-buffer-setup-hook
213 @itemx temp-buffer-show-function
214 @itemx temp-buffer-show-hook
215 @xref{Temporary Displays}.
217 @item term-setup-hook
218 @xref{Terminal-Specific}.
220 @item window-configuration-change-hook
221 @itemx window-scroll-functions
222 @itemx window-size-change-functions
223 @xref{Window Hooks}.
225 @item window-setup-hook
226 @xref{Window Systems}.
228 @item window-text-change-functions
229 @vindex window-text-change-functions
230 Functions to call in redisplay when text in the window might change.
232 @end table
234 @ignore
235 Some -hook, -function, -functions from preloaded Lisp or C files that
236 I thought did not need to be mentioned here:
238 Lisp:
239 after-load-functions
240 auto-coding-functions
241 choose-completion-string-functions
242 completing-read-function
243 completion-annotate-function
244 completion-at-point-functions
245 completion-in-region-functions
246 completion-list-insert-choice-function
247 describe-current-input-method-function
248 filter-buffer-substring-functions
249 font-lock-function
250 inactivate-current-input-method-function
251 menu-bar-select-buffer-function
252 read-file-name-function
253 replace-re-search-function
254 replace-search-function
255 yank-undo-function
257 C hooks:
258 kbd-macro-termination-hook
259 signal-hook-function
261 C functions:
262 redisplay-end-trigger-functions
263 x-lost-selection-functions
264 x-sent-selection-functions
266 C function:
267 auto-composition-function
268 auto-fill-function
269 command-error-function
270 compose-chars-after-function
271 composition-function-table
272 deferred-action-function
273 input-method-function
274 load-read-function
275 load-source-file-function
276 macro-declaration-function
277 read-buffer-function
278 ring-bell-function
279 select-safe-coding-system-function
280 set-auto-coding-function
281 show-help-function
282 signal-hook-function
283 undo-outer-limit-function
285 @end ignore