2 @c This is part of the GNU Emacs Lisp Reference Manual.
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1998, 2001, 2002, 2003, 2004,
4 @c 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
5 @c See the file elisp.texi for copying conditions.
6 @setfilename ../../info/hooks
7 @node Standard Hooks, Index, Standard Keymaps, Top
8 @appendix Standard Hooks
10 @cindex hook variables, list of
12 The following is a list of hook variables that let you provide
13 functions to be called from within Emacs on suitable occasions.
15 Most of these variables have names ending with @samp{-hook}. They are
16 @dfn{normal hooks}, run by means of @code{run-hooks}. The value of such
17 a hook is a list of functions; the functions are called with no
18 arguments and their values are completely ignored. The recommended way
19 to put a new function on such a hook is to call @code{add-hook}.
20 @xref{Hooks}, for more information about using hooks.
22 Every major mode defines a mode hook named
23 @samp{@var{modename}-mode-hook}. The major mode command runs this
24 normal hook with @code{run-mode-hooks} as the very last thing it does.
25 @xref{Mode Hooks}. Most minor modes have mode hooks too. Mode hooks
26 are omitted in the list below.
28 The variables whose names end in @samp{-hooks} or @samp{-functions} are
29 usually @dfn{abnormal hooks}; their values are lists of functions, but
30 these functions are called in a special way (they are passed arguments,
31 or their values are used). The variables whose names end in
32 @samp{-function} have single functions as their values.
34 A special feature allows you to specify expressions to evaluate if and
35 when a file is loaded (@pxref{Hooks for Loading}). That feature is
36 not exactly a hook, but does a similar job.
38 @c We need to xref to where each hook is documented or else document
42 @item activate-mark-hook
45 @item after-change-functions
48 @item after-change-major-mode-hook
54 @item after-insert-file-functions
55 @xref{Format Conversion}.
57 @item after-make-frame-functions
58 @xref{Creating Frames}.
60 @item after-revert-hook
64 @xref{Saving Buffers}.
66 @item auto-fill-function
72 @item before-change-functions
75 @item before-hack-local-variables-hook
76 @xref{File Local Variables}.
78 @item before-init-hook
81 @item before-make-frame-hook
82 @xref{Creating Frames}.
84 @item before-revert-hook
87 @item before-save-hook
88 @xref{Saving Buffers}.
90 @item blink-paren-function
93 @item buffer-access-fontify-functions
94 @xref{Lazy Properties}.
96 @item calendar-load-hook
98 @inforef{Calendar Customizing,, emacs-xtra}.
101 @xref{Calendar Customizing,,, emacs}.
105 @item change-major-mode-hook
106 @xref{Creating Buffer-Local}.
108 @item command-line-functions
109 @xref{Command-Line Arguments}.
111 @item comment-indent-function
112 @xref{Options for Comments,, Options Controlling Comments, emacs, the
115 @item compilation-finish-functions
116 Functions to call when a compilation process finishes.
118 @item custom-define-hook
119 Hook called after defining each customize option.
121 @item deactivate-mark-hook
124 @item delete-frame-functions
125 Functions to call when Emacs deletes a frame. @xref{Deleting Frames}.
127 @item delete-terminal-functions
128 Functions to call when Emacs deletes a terminal. @xref{Multiple
131 @item desktop-after-read-hook
132 Normal hook run after a successful @code{desktop-read}. May be used
133 to show a buffer list. @xref{Saving Emacs Sessions,, Saving Emacs
134 Sessions, emacs, the GNU Emacs Manual}.
136 @item desktop-no-desktop-file-hook
137 Normal hook run when @code{desktop-read} can't find a desktop file.
138 May be used to show a dired buffer. @xref{Saving Emacs Sessions,,
139 Saving Emacs Sessions, emacs, the GNU Emacs Manual}.
141 @item desktop-save-hook
142 Normal hook run before the desktop is saved in a desktop file. This
143 is useful for truncating history lists, for example. @xref{Saving
144 Emacs Sessions,, Saving Emacs Sessions, emacs, the GNU Emacs Manual}.
146 @item diary-display-hook
148 @inforef{Fancy Diary Display,, emacs-xtra}.
151 @xref{Fancy Diary Display,,, emacs}.
155 List of functions called after the display of the diary. Can be used
156 for appointment notification.
158 @item disabled-command-function
159 @xref{Disabling Commands}.
161 @item echo-area-clear-hook
162 @xref{Echo Area Customization}.
164 @item emacs-startup-hook
168 @xref{Visiting Functions}.
170 @item find-file-not-found-functions
171 @xref{Visiting Functions}.
173 @item first-change-hook
176 @item font-lock-beginning-of-syntax-function
177 @xref{Syntactic Font Lock}.
179 @item font-lock-fontify-buffer-function
180 @xref{Other Font Lock Variables}.
182 @item font-lock-fontify-region-function
183 @xref{Other Font Lock Variables}.
185 @item font-lock-mark-block-function
186 @xref{Other Font Lock Variables}.
188 @item font-lock-syntactic-face-function
189 @xref{Syntactic Font Lock}.
191 @item font-lock-unfontify-buffer-function
192 @xref{Other Font Lock Variables}.
194 @item hack-local-variables-hook
195 @xref{File Local Variables}.
197 @item font-lock-unfontify-region-function
198 @xref{Other Font Lock Variables}.
200 @item initial-calendar-window-hook
202 @inforef{Calendar Customizing,, emacs-xtra}.
205 @xref{Calendar Customizing,,, emacs}.
208 @item kbd-macro-termination-hook
209 @xref{Keyboard Macros}.
211 @item kill-buffer-hook
212 @xref{Killing Buffers}.
214 @item kill-buffer-query-functions
215 @xref{Killing Buffers}.
217 @item kill-emacs-hook
218 @xref{Killing Emacs}.
220 @item kill-emacs-query-functions
221 @xref{Killing Emacs}.
223 @item lisp-indent-function
225 @item list-diary-entries-hook
227 @inforef{Fancy Diary Display,, emacs-xtra}.
230 @xref{Fancy Diary Display,,, emacs}.
233 @item mail-setup-hook
234 @xref{Mail Mode Misc,, Mail Mode Miscellany, emacs, the GNU Emacs
237 @item mark-diary-entries-hook
239 @inforef{Fancy Diary Display,, emacs-xtra}.
242 @xref{Fancy Diary Display,,, emacs}.
245 @item menu-bar-update-hook
248 @item minibuffer-setup-hook
249 @xref{Minibuffer Misc}.
251 @item minibuffer-exit-hook
252 @xref{Minibuffer Misc}.
254 @item mouse-position-function
255 @xref{Mouse Position}.
257 @item nongregorian-diary-listing-hook
259 @inforef{Hebrew/Islamic Entries,, emacs-xtra}.
262 @xref{Hebrew/Islamic Entries,,, emacs}.
265 @item nongregorian-diary-marking-hook
267 @inforef{Hebrew/Islamic Entries,, emacs-xtra}.
270 @xref{Hebrew/Islamic Entries,,, emacs}.
275 @item post-command-hook
276 @xref{Command Overview}.
278 @item pre-abbrev-expand-hook
279 @xref{Abbrev Expansion}.
281 @item pre-command-hook
282 @xref{Command Overview}.
284 @item print-diary-entries-hook
286 @inforef{Diary Customizing,, emacs-xtra}.
289 @xref{Diary Customizing,,, emacs}.
292 @item redisplay-end-trigger-functions
295 @item resume-tty-functions
296 @xref{Suspending Emacs}.
298 @item scheme-indent-function
301 @xref{Suspending Emacs}.
303 @item suspend-resume-hook
304 @xref{Suspending Emacs}.
306 @item suspend-tty-functions
307 @xref{Suspending Emacs}.
309 @item temp-buffer-setup-hook
310 @xref{Temporary Displays}.
312 @item temp-buffer-show-function
313 @xref{Temporary Displays}.
315 @item temp-buffer-show-hook
316 @xref{Temporary Displays}.
318 @item term-setup-hook
319 @xref{Terminal-Specific}.
321 @item today-visible-calendar-hook
323 @inforef{Calendar Customizing,, emacs-xtra}.
326 @xref{Calendar Customizing,,, emacs}.
329 @item today-invisible-calendar-hook
331 @inforef{Calendar Customizing,, emacs-xtra}.
334 @xref{Calendar Customizing,,, emacs}.
337 @item window-configuration-change-hook
340 @item window-scroll-functions
343 @item window-setup-hook
344 @xref{Window Systems}.
346 @item window-size-change-functions
349 @item write-contents-functions
350 @xref{Saving Buffers}.
352 @item write-file-functions
353 @xref{Saving Buffers}.
355 @item write-region-annotate-functions
356 @xref{Format Conversion}.
360 arch-tag: 55fd0296-d906-4551-b300-979d3846aa88