man/lispref/hooks.texi

   1 @c -*-texinfo-*-
   2 @c This is part of the XEmacs Lisp Reference Manual.
   3 @c Copyright (C) 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
   4 @c See the file lispref.texi for copying conditions.
   5 @setfilename ../../info/hooks.info
   6 @node Standard Hooks, Index, Standard Keymaps, Top
   7 @appendix Standard Hooks
   8
   9 The following is a list of hook variables that let you provide
  10 functions to be called from within Emacs on suitable occasions.
  11
  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
  14 a hook is a list of functions.  The recommended way to put a new
  15 function on such a hook is to call @code{add-hook}.  @xref{Hooks}, for
  16 more information about using hooks.
  17
  18 The variables whose names end in @samp{-function} have single functions
  19 as their values.  Usually there is a specific reason why the variable is
  20 not a normal hook, such as the need to pass arguments to the function.
  21 (In older Emacs versions, some of these variables had names ending in
  22 @samp{-hook} even though they were not normal hooks.)
  23
  24 The variables whose names end in @samp{-hooks} or @samp{-functions} have
  25 lists of functions as their values, but these functions are called in a
  26 special way (they are passed arguments, or else their values are used).
  27
  28 @c !!! need  xref  to where each hook is documented or else document it
  29 @c by specifying what is expected, and when it is called relative to
  30 @c mode initialization.)
  31
  32 @table @code
  33 @item activate-menubar-hook
  34 @item activate-popup-menu-hook
  35 @item ad-definition-hooks
  36 @item adaptive-fill-function
  37 @item add-log-current-defun-function
  38 @item after-change-functions
  39 @item after-delete-annotation-hook
  40 @item after-init-hook
  41 @item after-insert-file-functions
  42 @item after-revert-hook
  43 @item after-save-hook
  44 @item after-set-visited-file-name-hooks
  45 @item after-write-file-hooks
  46 @item auto-fill-function
  47 @item auto-save-hook
  48 @item before-change-functions
  49 @item before-delete-annotation-hook
  50 @item before-init-hook
  51 @item before-revert-hook
  52 @item blink-paren-function
  53 @item buffers-menu-switch-to-buffer-function
  54 @item c++-mode-hook
  55 @item c-delete-function
  56 @item c-mode-common-hook
  57 @item c-mode-hook
  58 @item c-special-indent-hook
  59 @item calendar-load-hook
  60 @item change-major-mode-hook
  61 @item command-history-hook
  62 @item comment-indent-function
  63 @item compilation-buffer-name-function
  64 @item compilation-exit-message-function
  65 @item compilation-finish-function
  66 @item compilation-parse-errors-function
  67 @item compilation-mode-hook
  68 @item create-console-hook
  69 @item create-device-hook
  70 @item create-frame-hook
  71 @item dabbrev-friend-buffer-function
  72 @item dabbrev-select-buffers-function
  73 @item delete-console-hook
  74 @item delete-device-hook
  75 @item delete-frame-hook
  76 @item deselect-frame-hook
  77 @item diary-display-hook
  78 @item diary-hook
  79 @item dired-after-readin-hook
  80 @item dired-before-readin-hook
  81 @item dired-load-hook
  82 @item dired-mode-hook
  83 @item disabled-command-hook
  84 @item display-buffer-function
  85 @item ediff-after-setup-control-frame-hook
  86 @item ediff-after-setup-windows-hook
  87 @item ediff-before-setup-control-frame-hook
  88 @item ediff-before-setup-windows-hook
  89 @item ediff-brief-help-message-function
  90 @item ediff-cleanup-hook
  91 @item ediff-control-frame-position-function
  92 @item ediff-display-help-hook
  93 @item ediff-focus-on-regexp-matches-function
  94 @item ediff-forward-word-function
  95 @item ediff-hide-regexp-matches-function
  96 @item ediff-keymap-setup-hook
  97 @item ediff-load-hook
  98 @item ediff-long-help-message-function
  99 @item ediff-make-wide-display-function
 100 @item ediff-merge-split-window-function
 101 @item ediff-meta-action-function
 102 @item ediff-meta-redraw-function
 103 @item ediff-mode-hook
 104 @item ediff-prepare-buffer-hook
 105 @item ediff-quit-hook
 106 @item ediff-registry-setup-hook
 107 @item ediff-select-hook
 108 @item ediff-session-action-function
 109 @item ediff-session-group-setup-hook
 110 @item ediff-setup-diff-regions-function
 111 @item ediff-show-registry-hook
 112 @item ediff-show-session-group-hook
 113 @item ediff-skip-diff-region-function
 114 @item ediff-split-window-function
 115 @item ediff-startup-hook
 116 @item ediff-suspend-hook
 117 @item ediff-toggle-read-only-function
 118 @item ediff-unselect-hook
 119 @item ediff-window-setup-function
 120 @item edit-picture-hook
 121 @item electric-buffer-menu-mode-hook
 122 @item electric-command-history-hook
 123 @item electric-help-mode-hook
 124 @item emacs-lisp-mode-hook
 125 @item fill-paragraph-function
 126 @item find-file-hooks
 127 @item find-file-not-found-hooks
 128 @item first-change-hook
 129 @item font-lock-after-fontify-buffer-hook
 130 @item font-lock-beginning-of-syntax-function
 131 @item font-lock-mode-hook
 132 @item fume-found-function-hook
 133 @item fume-list-mode-hook
 134 @item fume-rescan-buffer-hook
 135 @item fume-sort-function
 136 @item gnus-startup-hook
 137 @item hack-local-variables-hook
 138 @item highlight-headers-follow-url-function
 139 @item hyper-apropos-mode-hook
 140 @item indent-line-function
 141 @item indent-mim-hook
 142 @item indent-region-function
 143 @item initial-calendar-window-hook
 144 @item isearch-mode-end-hook
 145 @item isearch-mode-hook
 146 @item java-mode-hook
 147 @item kill-buffer-hook
 148 @item kill-buffer-query-functions
 149 @item kill-emacs-hook
 150 @item kill-emacs-query-functions
 151 @item kill-hooks
 152 @item LaTeX-mode-hook
 153 @item latex-mode-hook
 154 @item ledit-mode-hook
 155 @item lisp-indent-function
 156 @item lisp-interaction-mode-hook
 157 @item lisp-mode-hook
 158 @item list-diary-entries-hook
 159 @item load-read-function
 160 @item log-message-filter-function
 161 @item m2-mode-hook
 162 @item mail-citation-hook
 163 @item mail-mode-hook
 164 @item mail-setup-hook
 165 @item make-annotation-hook
 166 @item makefile-mode-hook
 167 @item map-frame-hook
 168 @item mark-diary-entries-hook
 169 @item medit-mode-hook
 170 @item menu-no-selection-hook
 171 @item mh-compose-letter-hook
 172 @item mh-folder-mode-hook
 173 @item mh-letter-mode-hook
 174 @item mim-mode-hook
 175 @item minibuffer-exit-hook
 176 @item minibuffer-setup-hook
 177 @item mode-motion-hook
 178 @item mouse-enter-frame-hook
 179 @item mouse-leave-frame-hook
 180 @item mouse-track-cleanup-hook
 181 @item mouse-track-click-hook
 182 @item mouse-track-down-hook
 183 @item mouse-track-drag-hook
 184 @item mouse-track-drag-up-hook
 185 @item mouse-track-up-hook
 186 @item mouse-yank-function
 187 @item news-mode-hook
 188 @item news-reply-mode-hook
 189 @item news-setup-hook
 190 @item nongregorian-diary-listing-hook
 191 @item nongregorian-diary-marking-hook
 192 @item nroff-mode-hook
 193 @item objc-mode-hook
 194 @item outline-mode-hook
 195 @item perl-mode-hook
 196 @item plain-TeX-mode-hook
 197 @item post-command-hook
 198 @item post-gc-hook
 199 @item pre-abbrev-expand-hook
 200 @item pre-command-hook
 201 @item pre-display-buffer-function
 202 @item pre-gc-hook
 203 @item pre-idle-hook
 204 @item print-diary-entries-hook
 205 @item prolog-mode-hook
 206 @item protect-innocence-hook
 207 @item remove-message-hook
 208 @item revert-buffer-function
 209 @item revert-buffer-insert-contents-function
 210 @item rmail-edit-mode-hook
 211 @item rmail-mode-hook
 212 @item rmail-retry-setup-hook
 213 @item rmail-summary-mode-hook
 214 @item scheme-indent-hook
 215 @item scheme-mode-hook
 216 @item scribe-mode-hook
 217 @item select-frame-hook
 218 @item send-mail-function
 219 @item shell-mode-hook
 220 @item shell-set-directory-error-hook
 221 @item special-display-function
 222 @item suspend-hook
 223 @item suspend-resume-hook
 224 @item temp-buffer-show-function
 225 @item term-setup-hook
 226 @item terminal-mode-hook
 227 @item terminal-mode-break-hook
 228 @item TeX-mode-hook
 229 @item tex-mode-hook
 230 @item text-mode-hook
 231 @item today-visible-calendar-hook
 232 @item today-invisible-calendar-hook
 233 @item tooltalk-message-handler-hook
 234 @item tooltalk-pattern-handler-hook
 235 @item tooltalk-unprocessed-message-hook
 236 @item unmap-frame-hook
 237 @item vc-checkin-hook
 238 @item vc-checkout-writable-buffer-hook
 239 @item vc-log-after-operation-hook
 240 @item vc-make-buffer-writable-hook
 241 @item view-hook
 242 @item vm-arrived-message-hook
 243 @item vm-arrived-messages-hook
 244 @item vm-chop-full-name-function
 245 @item vm-display-buffer-hook
 246 @item vm-edit-message-hook
 247 @item vm-forward-message-hook
 248 @item vm-iconify-frame-hook
 249 @item vm-inhibit-write-file-hook
 250 @item vm-key-functions
 251 @item vm-mail-hook
 252 @item vm-mail-mode-hook
 253 @item vm-menu-setup-hook
 254 @item vm-mode-hook
 255 @item vm-quit-hook
 256 @item vm-rename-current-buffer-function
 257 @item vm-reply-hook
 258 @item vm-resend-bounced-message-hook
 259 @item vm-resend-message-hook
 260 @item vm-retrieved-spooled-mail-hook
 261 @item vm-select-message-hook
 262 @item vm-select-new-message-hook
 263 @item vm-select-unread-message-hook
 264 @item vm-send-digest-hook
 265 @item vm-summary-mode-hook
 266 @item vm-summary-pointer-update-hook
 267 @item vm-summary-redo-hook
 268 @item vm-summary-update-hook
 269 @item vm-undisplay-buffer-hook
 270 @item vm-visit-folder-hook
 271 @item window-setup-hook
 272 @item write-contents-hooks
 273 @item write-file-data-hooks
 274 @item write-file-hooks
 275 @item write-region-annotate-functions
 276 @item x-lost-selection-hooks
 277 @item x-sent-selection-hooks
 278 @item zmacs-activate-region-hook
 279 @item zmacs-deactivate-region-hook
 280 @item zmacs-update-region-hook
 281 @end table