1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1985-1987, 1993-1995, 1997, 2000-2012
3 @c Free Software Foundation, Inc.
4 @c See file emacs.texi for copying conditions.
9 This chapter describes some simple methods to customize the behavior
12 Apart from the methods described here, see @ref{X Resources} for
13 information about using X resources to customize Emacs, and see
14 @ref{Keyboard Macros} for information about recording and replaying
15 keyboard macros. Making more far-reaching and open-ended changes
16 involves writing Emacs Lisp code; see
18 @cite{The Emacs Lisp Reference Manual}.
21 @ref{Top, Emacs Lisp, Emacs Lisp, elisp, The Emacs Lisp
26 * Easy Customization:: Convenient way to browse and change settings.
27 * Variables:: Many Emacs commands examine Emacs variables
28 to decide what to do; by setting variables,
29 you can control their functioning.
30 * Key Bindings:: The keymaps say what command each key runs.
31 By changing them, you can "redefine keys".
32 * Init File:: How to write common customizations in the
36 @node Easy Customization
37 @section Easy Customization Interface
41 @cindex customizable variable
42 Emacs has many @dfn{settings} which you can change. Most settings
43 are @dfn{customizable variables} (@pxref{Variables}), which are also
44 called @dfn{user options}. There is a huge number of customizable
45 variables, controlling numerous aspects of Emacs behavior; the
46 variables documented in this manual are listed in @ref{Variable
47 Index}. A separate class of settings are the @dfn{faces}, which
48 determine the fonts, colors, and other attributes of text
52 @cindex customization buffer
53 To browse and alter settings (both variables and faces), type
54 @kbd{M-x customize}. This creates a @dfn{customization buffer}, which
55 lets you navigate through a logically organized list of settings, edit
56 and set their values, and save them permanently.
59 * Customization Groups:: How settings are classified.
60 * Browsing Custom:: Browsing and searching for settings.
61 * Changing a Variable:: How to edit an option's value and set the option.
62 * Saving Customizations:: Saving customizations for future Emacs sessions.
63 * Face Customization:: How to edit the attributes of a face.
64 * Specific Customization:: Customizing specific settings or groups.
65 * Custom Themes:: Collections of customization settings.
66 * Creating Custom Themes:: How to create a new custom theme.
69 @node Customization Groups
70 @subsection Customization Groups
71 @cindex customization groups
73 Customization settings are organized into @dfn{customization
74 groups}. These groups are collected into bigger groups, all the way
75 up to a master group called @code{Emacs}.
77 @kbd{M-x customize} creates a customization buffer that shows the
78 top-level @code{Emacs} group. It looks like this, in part:
80 @c we want the buffer example to all be on one page, but unfortunately
81 @c that's quite a bit of text, so force all space to the bottom.
85 To apply changes, use the Save or Set buttons.
86 For details, see [Saving Customizations] in the [Emacs manual].
88 ________________________________________ [ Search ]
90 Operate on all settings in this buffer:
91 [ Set for current session ] [ Save for future sessions ]
92 [ Undo edits ] [ Reset to saved ] [ Erase customizations ] [ Exit ]
95 Emacs group: Customization of the One True Editor.
96 [State]: visible group members are all at standard values.
99 [Editing] : Basic text editing facilities.
101 [Convenience] : Convenience features for faster editing.
103 @var{more second-level groups}
108 The main part of this buffer shows the @samp{Emacs} customization
109 group, which contains several other groups (@samp{Editing},
110 @samp{Convenience}, etc.). The contents of those groups are not
111 listed here, only one line of documentation each.
113 The @dfn{state} of the group indicates whether setting in that group
114 has been edited, set or saved. @xref{Changing a Variable}.
116 @cindex editable fields (customization buffer)
117 @cindex buttons (customization buffer)
118 @cindex links (customization buffer)
119 Most of the customization buffer is read-only, but it includes some
120 @dfn{editable fields} that you can edit. For example, at the top of
121 the customization buffer is an editable field for searching for
122 settings (@pxref{Browsing Custom}). There are also @dfn{buttons} and
123 @dfn{links}, which you can activate by either clicking with the mouse,
124 or moving point there and typing @key{RET}. For example, the group
125 names like @samp{[Editing]} are links; activating one of these links
126 brings up the customization buffer for that group.
128 @kindex TAB @r{(customization buffer)}
129 @kindex S-TAB @r{(customization buffer)}
130 @findex widget-forward
131 @findex widget-backward
132 In the customizable buffer, you can type @key{TAB}
133 (@code{widget-forward}) to move forward to the next button or editable
134 field. @kbd{S-@key{TAB}} (@code{widget-backward}) moves back to the
135 previous button or editable field.
137 @node Browsing Custom
138 @subsection Browsing and Searching for Settings
139 @findex customize-browse
141 From the top-level customization buffer created by @kbd{M-x
142 customize}, you can follow the links to the subgroups of the
143 @samp{Emacs} customization group. These subgroups may contain
144 settings for you to customize; they may also contain further subgroups,
145 dealing with yet more specialized subsystems of Emacs. As you
146 navigate the hierarchy of customization groups, you should find some
147 settings that you want to customize.
149 If you are interested in customizing a particular setting or
150 customization group, you can go straight there with the commands
151 @kbd{M-x customize-option}, @kbd{M-x customize-face}, or @kbd{M-x
152 customize-group}. @xref{Specific Customization}.
154 @vindex custom-search-field
155 If you don't know exactly what groups or settings you want to
156 customize, you can search for them using the editable search field at
157 the top of each customization buffer. Here, you can type in a search
158 term---either one or more words separated by spaces, or a regular
159 expression (@pxref{Regexps}). Then type @key{RET} in the field, or
160 activate the @samp{Search} button next to it, to switch to a
161 customization buffer containing groups and settings that match those
162 terms. Note, however, that this feature only finds groups and
163 settings that are loaded in the current Emacs session.
165 If you don't want customization buffers to show the search field,
166 change the variable @code{custom-search-field} to @code{nil}.
168 The command @kbd{M-x customize-apropos} is similar to using the
169 search field, except that it reads the search term(s) using the
170 minibuffer. @xref{Specific Customization}.
172 @kbd{M-x customize-browse} is another way to browse the available
173 settings. This command creates a special customization buffer which
174 shows only the names of groups and settings, in a structured layout.
175 You can show the contents of a group, in the same buffer, by invoking
176 the @samp{[+]} button next to the group name. When the group contents
177 are shown, the button changes to @samp{[-]}; invoking that hides the
178 group contents again. Each group or setting in this buffer has a link
179 which says @samp{[Group]}, @samp{[Option]} or @samp{[Face]}. Invoking
180 this link creates an ordinary customization buffer showing just that
181 group, option, or face; this is the way to change settings that you
182 find with @kbd{M-x customize-browse}.
184 @node Changing a Variable
185 @subsection Changing a Variable
187 Here is an example of what a variable, or user option, looks like in
188 the customization buffer:
191 [Hide] Kill Ring Max: 60
193 Maximum length of kill ring before oldest elements are thrown away.
196 The first line shows that the variable is named
197 @code{kill-ring-max}, formatted as @samp{Kill Ring Max} for easier
198 viewing. Its value is @samp{60}. The button labeled @samp{[Hide]},
199 if activated, hides the variable's value and state; this is useful to
200 avoid cluttering up the customization buffer with very long values
201 (for this reason, variables that have very long values may start out
202 hidden). If you use the @samp{[Hide]} button, it changes to
203 @samp{[Show Value]}, which you can activate to reveal the value and
204 state. On a graphical display, the @samp{[Hide]} and @samp{[Show
205 Value]} buttons are replaced with graphical triangles pointing
206 downwards and rightwards respectively.
208 The line after the variable name indicates the @dfn{customization
209 state} of the variable: in this example, @samp{STANDARD} means you
210 have not changed the variable, so its value is the default one. The
211 @samp{[State]} button gives a menu of operations for customizing the
214 Below the customization state is the documentation for the variable.
215 This is the same documentation that would be shown by the @kbd{C-h v}
216 command (@pxref{Examining}). If the documentation is more than one
217 line long, only one line may be shown. If so, that line ends with a
218 @samp{[More]} button; activate this to see the full documentation.
220 @cindex user options, changing
221 @cindex customizing variables
222 @cindex variables, changing
223 To enter a new value for @samp{Kill Ring Max}, just move point to
224 the value and edit it. For example, type @kbd{M-d} to delete the
225 @samp{60} and type in another number. As you begin to alter the text,
226 the @samp{[State]} line will change:
229 [State]: EDITED, shown value does not take effect until you
234 Editing the value does not make it take effect right away. To do
235 that, you must @dfn{set} the variable by activating the @samp{[State]}
236 button and choosing @samp{Set for Current Session}. Then the
237 variable's state becomes:
240 [State]: SET for current session only.
244 You don't have to worry about specifying a value that is not valid;
245 the @samp{Set for Current Session} operation checks for validity and
246 will not install an unacceptable value.
248 @kindex M-TAB @r{(customization buffer)}
249 @kindex C-M-i @r{(customization buffer)}
250 @findex widget-complete
251 While editing certain kinds of values, such as file names, directory
252 names, and Emacs command names, you can perform completion with
253 @kbd{C-M-i} (@code{widget-complete}), or the equivalent keys
254 @kbd{M-@key{TAB}} or @kbd{@key{ESC} @key{TAB}}. This behaves much
255 like minibuffer completion (@pxref{Completion}).
257 Typing @key{RET} on an editable value field moves point forward to
258 the next field or button, like @key{TAB}. You can thus type @key{RET}
259 when you are finished editing a field, to move on to the next button
260 or field. To insert a newline within an editable field, use @kbd{C-o}
263 For some variables, there is only a fixed set of legitimate values,
264 and you are not allowed to edit the value directly. Instead, a
265 @samp{[Value Menu]} button appears before the value; activating this
266 button presents a choice of values. For a boolean ``on or off''
267 value, the button says @samp{[Toggle]}, and flips the value. After
268 using the @samp{[Value Menu]} or @samp{[Toggle]} button, you must
269 again set the variable to make the chosen value take effect.
271 Some variables have values with complex structure. For example, the
272 value of @code{minibuffer-frame-alist} is an association list. Here
273 is how it appears in the customization buffer:
276 [Hide] Minibuffer Frame Alist:
277 [INS] [DEL] Parameter: width
279 [INS] [DEL] Parameter: height
283 Alist of parameters for the initial minibuffer frame. [Hide]
284 @r{[@dots{}more lines of documentation@dots{}]}
288 In this case, each association in the list consists of two items, one
289 labeled @samp{Parameter} and one labeled @samp{Value}; both are
290 editable fields. You can delete an association from the list with the
291 @samp{[DEL]} button next to it. To add an association, use the
292 @samp{[INS]} button at the position where you want to insert it; the
293 very last @samp{[INS]} button inserts at the end of the list.
295 @cindex saving a setting
296 @cindex settings, how to save
297 When you set a variable, the new value takes effect only in the
298 current Emacs session. To @dfn{save} the value for future sessions,
299 use the @samp{[State]} button and select the @samp{Save for Future
300 Sessions} operation. @xref{Saving Customizations}.
302 You can also restore the variable to its standard value by using the
303 @samp{[State]} button and selecting the @samp{Erase Customization}
304 operation. There are actually four reset operations:
308 If you have modified but not yet set the variable, this restores the
309 text in the customization buffer to match the actual value.
312 This restores the value of the variable to the last saved value,
313 and updates the text accordingly.
315 @item Erase Customization
316 This sets the variable to its standard value. Any saved value that
317 you have is also eliminated.
319 @item Set to Backup Value
320 This sets the variable to a previous value that was set in the
321 customization buffer in this session. If you customize a variable
322 and then reset it, which discards the customized value,
323 you can get the discarded value back again with this operation.
326 @cindex comments on customized settings
327 Sometimes it is useful to record a comment about a specific
328 customization. Use the @samp{Add Comment} item from the
329 @samp{[State]} menu to create a field for entering the comment.
331 Near the top of the customization buffer are two lines of buttons:
334 [Set for Current Session] [Save for Future Sessions]
335 [Undo Edits] [Reset to Saved] [Erase Customization] [Finish]
339 Each of the first five buttons performs the stated operation---set,
340 save, reset, etc.---on all the settings in the buffer that could
341 meaningfully be affected. They do not operate on settings that are
342 hidden, nor on subgroups that are hidden or not visible in the buffer.
344 @kindex C-c C-c @r{(customization buffer)}
345 @kindex C-x C-c @r{(customization buffer)}
348 The command @kbd{C-c C-c} (@code{Custom-set}) is equivalent using to
349 the @samp{[Set for Current Session]} button. The command @kbd{C-x
350 C-s} (@code{Custom-save}) is like using the @samp{[Save for Future
353 @vindex custom-buffer-done-kill
354 The @samp{[Finish]} button switches out of the customization buffer,
355 and buries the buffer at the bottom of the buffer list. To make it
356 kill the customization buffer instead, change the variable
357 @code{custom-buffer-done-kill} to @code{t}.
359 @node Saving Customizations
360 @subsection Saving Customizations
362 In the customization buffer, you can @dfn{save} a customization
363 setting by choosing the @samp{Save for Future Sessions} choice from
364 its @samp{[State]} button. The @kbd{C-x C-s} (@code{Custom-save})
365 command, or the @samp{[Save for Future Sessions]} button at the top of
366 the customization buffer, saves all applicable settings in the buffer.
368 Saving works by writing code to a file, usually your initialization
369 file (@pxref{Init File}). Future Emacs sessions automatically read
370 this file at startup, which sets up the customizations again.
373 You can choose to save customizations somewhere other than your
374 initialization file. To make this work, you must add a couple of
375 lines of code to your initialization file, to set the variable
376 @code{custom-file} to the name of the desired file, and to load that
380 (setq custom-file "~/.emacs-custom.el")
384 You can even specify different customization files for different
385 Emacs versions, like this:
388 (cond ((< emacs-major-version 22)
389 ;; @r{Emacs 21 customization.}
390 (setq custom-file "~/.custom-21.el"))
391 ((and (= emacs-major-version 22)
392 (< emacs-minor-version 3))
393 ;; @r{Emacs 22 customization, before version 22.3.}
394 (setq custom-file "~/.custom-22.el"))
396 ;; @r{Emacs version 22.3 or later.}
397 (setq custom-file "~/.emacs-custom.el")))
402 If Emacs was invoked with the @option{-q} or @option{--no-init-file}
403 options (@pxref{Initial Options}), it will not let you save your
404 customizations in your initialization file. This is because saving
405 customizations from such a session would wipe out all the other
406 customizations you might have on your initialization file.
408 @node Face Customization
409 @subsection Customizing Faces
410 @cindex customizing faces
411 @cindex faces, customizing
412 @cindex fonts and faces
414 You can customize faces (@pxref{Faces}), which determine how Emacs
415 displays different types of text. Customization groups can contain
416 both variables and faces.
418 For example, in programming language modes, source code comments are
419 shown with @code{font-lock-comment-face} (@pxref{Font Lock}). In a
420 customization buffer, that face appears like this:
423 [Hide] Font Lock Comment Face:[sample]
425 Font Lock mode face used to highlight comments.
434 [ ] Strike-through: --
435 [ ] Box around text: --
436 [ ] Inverse-video: --
437 [X] Foreground: Firebrick [Choose] (sample)
441 [Hide Unused Attributes]
445 The first three lines show the name, @samp{[State]} button, and
446 documentation for the face. Below that is a list of @dfn{face
447 attributes}. In front of each attribute is a checkbox. A filled
448 checkbox, @samp{[X]}, means that the face specifies a value for this
449 attribute; an empty checkbox, @samp{[ ]}, means that the face does not
450 specify any special value for the attribute. You can activate a
451 checkbox to specify or unspecify its attribute.
453 Most faces only specify a few attributes (in the above example,
454 @code{font-lock-comment-face} only specifies the foreground color).
455 Emacs has a special face, @code{default}, whose attributes are all
456 specified; it determines the attributes left unspecified by other
459 The @samp{Hide Unused Attributes} button, at the end of the
460 attribute list, hides the unspecified attributes of the face. When
461 attributes are being hidden, the button changes to @samp{[Show All
462 Attributes]}, which reveals the entire attribute list. The
463 customization buffer may start out with unspecified attributes hidden,
464 to avoid cluttering the interface.
466 When an attribute is specified, you can change its value in the
469 Foreground and background colors can be specified using either color
470 names or RGB triplets (@pxref{Colors}). You can also use the
471 @samp{[Choose]} button to switch to a list of color names; select a
472 color with @key{RET} in that buffer to put the color name in the value
475 Setting, saving and resetting a face work like the same operations for
476 variables (@pxref{Changing a Variable}).
478 A face can specify different appearances for different types of
479 displays. For example, a face can make text red on a color display,
480 but use a bold font on a monochrome display. To specify multiple
481 appearances for a face, select @samp{For All Kinds of Displays} in the
482 menu you get from invoking @samp{[State]}.
484 @node Specific Customization
485 @subsection Customizing Specific Items
488 @item M-x customize-option @key{RET} @var{option} @key{RET}
489 @itemx M-x customize-variable @key{RET} @var{option} @key{RET}
490 Set up a customization buffer for just one user option, @var{option}.
491 @item M-x customize-face @key{RET} @var{face} @key{RET}
492 Set up a customization buffer for just one face, @var{face}.
493 @item M-x customize-group @key{RET} @var{group} @key{RET}
494 Set up a customization buffer for just one group, @var{group}.
495 @item M-x customize-apropos @key{RET} @var{regexp} @key{RET}
496 Set up a customization buffer for all the settings and groups that
498 @item M-x customize-changed @key{RET} @var{version} @key{RET}
499 Set up a customization buffer with all the settings and groups
500 whose meaning has changed since Emacs version @var{version}.
501 @item M-x customize-saved
502 Set up a customization buffer containing all settings that you
503 have saved with customization buffers.
504 @item M-x customize-unsaved
505 Set up a customization buffer containing all settings that you have
509 @findex customize-option
510 If you want to customize a particular user option, type @kbd{M-x
511 customize-option}. This reads the variable name, and sets up the
512 customization buffer with just that one user option. When entering
513 the variable name into the minibuffer, completion is available, but
514 only for the names of variables that have been loaded into Emacs.
516 @findex customize-face
517 @findex customize-group
518 Likewise, you can customize a specific face using @kbd{M-x
519 customize-face}. You can set up a customization buffer for a specific
520 customization group using @kbd{M-x customize-group}.
522 @findex customize-apropos
523 @kbd{M-x customize-apropos} prompts for a search term---either one
524 or more words separated by spaces, or a regular expression---and sets
525 up a customization buffer for all @emph{loaded} settings and groups
526 with matching names. This is like using the search field at the top
527 of the customization buffer (@pxref{Customization Groups}).
529 @findex customize-changed
530 When you upgrade to a new Emacs version, you might want to consider
531 customizing new settings, and settings whose meanings or default
532 values have changed. To do this, use @kbd{M-x customize-changed} and
533 specify a previous Emacs version number using the minibuffer. It
534 creates a customization buffer which shows all the settings and groups
535 whose definitions have been changed since the specified version,
536 loading them if necessary.
538 @findex customize-saved
539 @findex customize-unsaved
540 If you change settings and then decide the change was a mistake, you
541 can use two commands to revisit your changes. Use @kbd{M-x
542 customize-saved} to customize settings that you have saved. Use
543 @kbd{M-x customize-unsaved} to customize settings that you have set
547 @subsection Custom Themes
548 @cindex custom themes
550 @dfn{Custom themes} are collections of settings that can be enabled
551 or disabled as a unit. You can use Custom themes to switch easily
552 between various collections of settings, and to transfer such
553 collections from one computer to another.
555 A Custom theme is stored an Emacs Lisp source file. If the name of
556 the Custom theme is @var{name}, the theme file is named
557 @file{@var{name}-theme.el}. @xref{Creating Custom Themes}, for the
558 format of a theme file and how to make one.
560 @findex customize-themes
561 @vindex custom-theme-directory
563 Type @kbd{M-x customize-themes} to switch to a buffer named
564 @samp{*Custom Themes*}, which lists the Custom themes that Emacs knows
565 about. By default, Emacs looks for theme files in two locations: the
566 directory specified by the variable @code{custom-theme-directory}
567 (which defaults to @file{~/.emacs.d/}), and a directory named
568 @file{etc/themes} in your Emacs installation (see the variable
569 @code{data-directory}). The latter contains several Custom themes
570 which are distributed with Emacs, which customize Emacs's faces to fit
571 various color schemes. (Note, however, that Custom themes need not be
572 restricted to this purpose; they can be used to customize variables
575 @vindex custom-theme-load-path
576 If you want Emacs to look for Custom themes in some other directory,
577 add the directory name to the list variable
578 @code{custom-theme-load-path}. Its default value is
579 @code{(custom-theme-directory t)}; here, the symbol
580 @code{custom-theme-directory} has the special meaning of the value of
581 the variable @code{custom-theme-directory}, while @code{t} stands for
582 the built-in theme directory @file{etc/themes}. The themes listed in
583 the @samp{*Custom Themes*} buffer are those found in the directories
584 specified by @code{custom-theme-load-path}.
586 @kindex C-x C-s @r{(Custom Themes buffer)}
587 In the @samp{*Custom Themes*} buffer, you can activate the checkbox
588 next to a Custom theme to enable or disable the theme for the current
589 Emacs session. When a Custom theme is enabled, all of its settings
590 (variables and faces) take effect in the Emacs session. To apply the
591 choice of theme(s) to future Emacs sessions, type @kbd{C-x C-s}
592 (@code{custom-theme-save}) or use the @samp{[Save Theme Settings]}
595 @vindex custom-safe-themes
596 When you first enable a Custom theme, Emacs displays the contents of
597 the theme file and asks if you really want to load it. Because
598 loading a Custom theme can execute arbitrary Lisp code, you should
599 only say yes if you know that the theme is safe; in that case, Emacs
600 offers to remember in the future that the theme is safe (this is done
601 by saving the theme file's SHA-256 hash to the variable
602 @code{custom-safe-themes}; if you want to treat all themes as safe,
603 change its value to @code{t}). Themes that come with Emacs (in the
604 @file{etc/themes} directory) are exempt from this check, and are
605 always considered safe.
607 @vindex custom-enabled-themes
608 Setting or saving Custom themes actually works by customizing the
609 variable @code{custom-enabled-themes}. The value of this variable is
610 a list of Custom theme names (as Lisp symbols, e.g.@: @code{tango}).
611 Instead of using the @samp{*Custom Themes*} buffer to set
612 @code{custom-enabled-themes}, you can customize the variable using the
613 usual customization interface, e.g.@: with @kbd{M-x customize-option}.
614 Note that Custom themes are not allowed to set
615 @code{custom-enabled-themes} themselves.
617 Any customizations that you make through the customization buffer
618 take precedence over theme settings. This lets you easily override
619 individual theme settings that you disagree with. If settings from
620 two different themes overlap, the theme occurring earlier in
621 @code{custom-enabled-themes} takes precedence. In the customization
622 buffer, if a setting has been changed from its default by a Custom
623 theme, its @samp{State} display shows @samp{THEMED} instead of
628 @findex disable-theme
629 You can enable a specific Custom theme in the current Emacs session
630 by typing @kbd{M-x load-theme}. This prompts for a theme name, loads
631 the theme from the theme file, and enables the theme. If a theme file
632 has been loaded before, you can enable the theme without loading its
633 file by typing @kbd{M-x enable-theme}. To disable a Custom theme,
634 type @kbd{M-x disable-theme}.
636 @findex describe-theme
637 To see a description of a Custom theme, type @kbd{?} on its line in
638 the @samp{*Custom Themes*} buffer; or type @kbd{M-x describe-theme}
639 anywhere in Emacs and enter the theme name in the minibuffer.
641 @node Creating Custom Themes
642 @subsection Creating Custom Themes
643 @cindex custom themes, creating
645 @findex customize-create-theme
646 You can define a Custom theme using an interface similar to the
647 customization buffer, by typing @kbd{M-x customize-create-theme}.
648 This switches to a buffer named @samp{*Custom Theme*}. It also offers
649 to insert some common Emacs faces into the theme (a convenience, since
650 Custom themes are often used to customize faces). If you answer no,
651 the theme will initially contain no settings.
653 Near the top of the @samp{*Custom Theme*} buffer are editable fields
654 where you can enter the theme's name and description. The name can be
655 anything except @samp{user}. The description is the one that will be
656 shown when you invoke @kbd{M-x describe-theme} for the theme. Its
657 first line should be a brief one-sentence summary; in the buffer made
658 by @kbd{M-x customize-themes}, this sentence is displayed next to the
661 To add a new setting to the theme, use the @samp{[Insert Additional
662 Face]} or @samp{[Insert Additional Variable]} buttons. Each button
663 reads a face or variable name using the minibuffer, with completion,
664 and inserts a customization entry for the face or variable. You can
665 edit the variable values or face attributes in the same way as in a
666 normal customization buffer. To remove a face or variable from the
667 theme, uncheck the checkbox next to its name.
669 @vindex custom-theme-directory
670 After specifying the Custom theme's faces and variables, type
671 @kbd{C-x C-s} (@code{custom-theme-write}) or use the buffer's
672 @samp{[Save Theme]} button. This saves the theme file, named
673 @file{@var{name}-theme.el} where @var{name} is the theme name, in the
674 directory named by @code{custom-theme-directory}.
676 From the @samp{*Custom Theme*} buffer, you can view and edit an
677 existing Custom theme by activating the @samp{[Visit Theme]} button
678 and specifying the theme name. You can also add the settings of
679 another theme into the buffer, using the @samp{[Merge Theme]} button.
680 You can import your non-theme settings into a Custom theme by using
681 the @samp{[Merge Theme]} button and specifying the special theme named
684 A theme file is simply an Emacs Lisp source file, and loading the
685 Custom theme works by loading the Lisp file. Therefore, you can edit
686 a theme file directly instead of using the @samp{*Custom Theme*}
688 @c Add link to the relevant Emacs Lisp Reference manual node, once
695 A @dfn{variable} is a Lisp symbol which has a value. The symbol's
696 name is also called the @dfn{variable name}. A variable name can
697 contain any characters that can appear in a file, but most variable
698 names consist of ordinary words separated by hyphens.
700 The name of the variable serves as a compact description of its
701 role. Most variables also have a @dfn{documentation string}, which
702 describes what the variable's purpose is, what kind of value it should
703 have, and how the value will be used. You can view this documentation
704 using the help command @kbd{C-h v} (@code{describe-variable}).
707 Emacs uses many Lisp variables for internal record keeping, but the
708 most interesting variables for a non-programmer user are those meant
709 for users to change---these are called @dfn{customizable variables} or
710 @dfn{user options} (@pxref{Easy Customization}). In the following
711 sections, we will describe other aspects of Emacs variables, such as
712 how to set them outside Customize.
714 Emacs Lisp allows any variable (with a few exceptions) to have any
715 kind of value. However, many variables are meaningful only if
716 assigned values of a certain type. For example, only numbers are
717 meaningful values for @code{kill-ring-max}, which specifies the
718 maximum length of the kill ring (@pxref{Earlier Kills}); if you give
719 @code{kill-ring-max} a string value, commands such as @kbd{C-y}
720 (@code{yank}) will signal an error. On the other hand, some variables
721 don't care about type; for instance, if a variable has one effect for
722 @code{nil} values and another effect for ``non-@code{nil}'' values,
723 then any value that is not the symbol @code{nil} induces the second
724 effect, regardless of its type (by convention, we usually use the
725 value @code{t}---a symbol which stands for ``true''---to specify a
726 non-@code{nil} value). If you set a variable using the customization
727 buffer, you need not worry about giving it an invalid type: the
728 customization buffer usually only allows you to enter meaningful
729 values. When in doubt, use @kbd{C-h v} (@code{describe-variable}) to
730 check the variable's documentation string to see kind of value it
731 expects (@pxref{Examining}).
734 * Examining:: Examining or setting one variable's value.
735 * Hooks:: Hook variables let you specify programs for parts
736 of Emacs to run on particular occasions.
737 * Locals:: Per-buffer values of variables.
738 * File Variables:: How files can specify variable values.
739 * Directory Variables:: How variable values can be specified by directory.
743 @subsection Examining and Setting Variables
744 @cindex setting variables
747 @item C-h v @var{var} @key{RET}
748 Display the value and documentation of variable @var{var}
749 (@code{describe-variable}).
750 @item M-x set-variable @key{RET} @var{var} @key{RET} @var{value} @key{RET}
751 Change the value of variable @var{var} to @var{value}.
754 To examine the value of a variable, use @kbd{C-h v}
755 (@code{describe-variable}). This reads a variable name using the
756 minibuffer, with completion, and displays both the value and the
757 documentation of the variable. For example,
760 C-h v fill-column @key{RET}
764 displays something like this:
767 fill-column is a variable defined in `C source code'.
768 fill-column's value is 70
769 Local in buffer custom.texi; global value is 70
770 Automatically becomes buffer-local when set in any fashion.
772 Automatically becomes buffer-local when set in any fashion.
773 This variable is safe as a file local variable if its value
774 satisfies the predicate `integerp'.
777 *Column beyond which automatic line-wrapping should happen.
778 Interactively, you can set the buffer local value using C-x f.
780 You can customize this variable.
784 The line that says ``You can customize the variable'' indicates that
785 this variable is a user option. @kbd{C-h v} is not restricted to user
786 options; it allows non-customizable variables too.
789 The most convenient way to set a specific customizable variable is
790 with @kbd{M-x set-variable}. This reads the variable name with the
791 minibuffer (with completion), and then reads a Lisp expression for the
792 new value using the minibuffer a second time (you can insert the old
793 value into the minibuffer for editing via @kbd{M-n}). For example,
796 M-x set-variable @key{RET} fill-column @key{RET} 75 @key{RET}
800 sets @code{fill-column} to 75.
802 @kbd{M-x set-variable} is limited to customizable variables, but you
803 can set any variable with a Lisp expression like this:
806 (setq fill-column 75)
810 To execute such an expression, type @kbd{M-:} (@code{eval-expression})
811 and enter the expression in the minibuffer (@pxref{Lisp Eval}).
812 Alternatively, go to the @samp{*scratch*} buffer, type in the
813 expression, and then type @kbd{C-j} (@pxref{Lisp Interaction}).
815 Setting variables, like all means of customizing Emacs except where
816 otherwise stated, affects only the current Emacs session. The only
817 way to alter the variable in future sessions is to put something in
818 your initialization file (@pxref{Init File}).
823 @cindex running a hook
825 @dfn{Hooks} are an important mechanism for customizing Emacs. A
826 hook is a Lisp variable which holds a list of functions, to be called
827 on some well-defined occasion. (This is called @dfn{running the
828 hook}.) The individual functions in the list are called the @dfn{hook
829 functions} of the hook. For example, the hook @code{kill-emacs-hook}
830 runs just before exiting Emacs (@pxref{Exiting}).
833 Most hooks are @dfn{normal hooks}. This means that when Emacs runs
834 the hook, it calls each hook function in turn, with no arguments. We
835 have made an effort to keep most hooks normal, so that you can use
836 them in a uniform way. Every variable whose name ends in @samp{-hook}
839 @cindex abnormal hook
840 A few hooks are @dfn{abnormal hooks}. Their names end in
841 @samp{-hooks} or @samp{-functions}, instead of @samp{-hook}. What
842 makes these hooks abnormal is the way its functions are
843 called---perhaps they are given arguments, or perhaps the values they
844 return are used in some way. For example,
845 @code{find-file-not-found-functions} is abnormal because as soon as
846 one hook function returns a non-@code{nil} value, the rest are not
847 called at all (@pxref{Visiting}). The documentation of each abnormal
848 hook variable explains how its functions are used.
851 You can set a hook variable with @code{setq} like any other Lisp
852 variable, but the recommended way to add a function to a hook (either
853 normal or abnormal) is to use @code{add-hook}, as shown by the
854 following examples. @xref{Hooks,,, elisp, The Emacs Lisp Reference
855 Manual}, for details.
857 Most major modes run one or more @dfn{mode hooks} as the last step
858 of initialization. Mode hooks are a convenient way to customize the
859 behavior of individual modes; they are always normal. For example,
860 here's how to set up a hook to turn on Auto Fill mode in Text mode and
861 other modes based on Text mode:
864 (add-hook 'text-mode-hook 'auto-fill-mode)
868 This works by calling @code{auto-fill-mode}, which enables the minor
869 mode when no argument is supplied (@pxref{Minor Modes}). Next,
870 suppose you don't want Auto Fill mode turned on in La@TeX{} mode,
871 which is one of the modes based on Text mode. You can do this with
872 the following additional line:
875 (add-hook 'latex-mode-hook (lambda () (auto-fill-mode -1)))
879 Here we have used the special macro @code{lambda} to construct an
880 anonymous function (@pxref{Lambda Expressions,,, elisp, The Emacs Lisp
881 Reference Manual}), which calls @code{auto-fill-mode} with an argument
882 of @code{-1} to disable the minor mode. Because La@TeX{} mode runs
883 @code{latex-mode-hook} after running @code{text-mode-hook}, the result
884 leaves Auto Fill mode disabled.
886 Here is a more complex example, showing how to use a hook to
887 customize the indentation of C code:
892 '((c-comment-only-line-offset . 4)
895 (c-cleanup-list . (scope-operator
901 (add-hook 'c-mode-common-hook
902 (lambda () (c-add-style "my-style" my-c-style t)))
907 @cindex program editing
908 Major mode hooks also apply to other major modes @dfn{derived} from
909 the original mode (@pxref{Derived Modes,,, elisp, The Emacs Lisp
910 Reference Manual}). For instance, HTML mode is derived from Text mode
911 (@pxref{HTML Mode}); when HTML mode is enabled, it runs
912 @code{text-mode-hook} before running @code{html-mode-hook}. This
913 provides a convenient way to use a single hook to affect several
914 related modes. In particular, if you want to apply a hook function to
915 any programming language mode, add it to @code{prog-mode-hook}; Prog
916 mode is a major mode that does little else than to let other major
917 modes inherit from it, exactly for this purpose.
919 It is best to design your hook functions so that the order in which
920 they are executed does not matter. Any dependence on the order is
921 asking for trouble. However, the order is predictable: the hook
922 functions are executed in the order they appear in the hook.
925 If you play with adding various different versions of a hook
926 function by calling @code{add-hook} over and over, remember that all
927 the versions you added will remain in the hook variable together. You
928 can clear out individual functions by calling @code{remove-hook}, or
929 do @code{(setq @var{hook-variable} nil)} to remove everything.
931 @cindex buffer-local hooks
932 If the hook variable is buffer-local, the buffer-local variable will
933 be used instead of the global variable. However, if the buffer-local
934 variable contains the element @code{t}, the global hook variable will
938 @subsection Local Variables
941 @item M-x make-local-variable @key{RET} @var{var} @key{RET}
942 Make variable @var{var} have a local value in the current buffer.
943 @item M-x kill-local-variable @key{RET} @var{var} @key{RET}
944 Make variable @var{var} use its global value in the current buffer.
945 @item M-x make-variable-buffer-local @key{RET} @var{var} @key{RET}
946 Mark variable @var{var} so that setting it will make it local to the
947 buffer that is current at that time.
950 @cindex local variables
951 Almost any variable can be made @dfn{local} to a specific Emacs
952 buffer. This means that its value in that buffer is independent of its
953 value in other buffers. A few variables are always local in every
954 buffer. Every other Emacs variable has a @dfn{global} value which is in
955 effect in all buffers that have not made the variable local.
957 @findex make-local-variable
958 @kbd{M-x make-local-variable} reads the name of a variable and makes
959 it local to the current buffer. Changing its value subsequently in
960 this buffer will not affect others, and changes in its global value
961 will not affect this buffer.
963 @findex make-variable-buffer-local
964 @cindex per-buffer variables
965 @kbd{M-x make-variable-buffer-local} marks a variable so it will
966 become local automatically whenever it is set. More precisely, once a
967 variable has been marked in this way, the usual ways of setting the
968 variable automatically do @code{make-local-variable} first. We call
969 such variables @dfn{per-buffer} variables. Many variables in Emacs
970 are normally per-buffer; the variable's document string tells you when
971 this is so. A per-buffer variable's global value is normally never
972 effective in any buffer, but it still has a meaning: it is the initial
973 value of the variable for each new buffer.
975 Major modes (@pxref{Major Modes}) always make variables local to the
976 buffer before setting the variables. This is why changing major modes
977 in one buffer has no effect on other buffers. Minor modes also work
978 by setting variables---normally, each minor mode has one controlling
979 variable which is non-@code{nil} when the mode is enabled
980 (@pxref{Minor Modes}). For many minor modes, the controlling variable
981 is per buffer, and thus always buffer-local. Otherwise, you can make
982 it local in a specific buffer like any other variable.
984 A few variables cannot be local to a buffer because they are always
985 local to each display instead (@pxref{Multiple Displays}). If you try to
986 make one of these variables buffer-local, you'll get an error message.
988 @findex kill-local-variable
989 @kbd{M-x kill-local-variable} makes a specified variable cease to be
990 local to the current buffer. The global value of the variable
991 henceforth is in effect in this buffer. Setting the major mode kills
992 all the local variables of the buffer except for a few variables
993 specially marked as @dfn{permanent locals}.
996 To set the global value of a variable, regardless of whether the
997 variable has a local value in the current buffer, you can use the Lisp
998 construct @code{setq-default}. This construct is used just like
999 @code{setq}, but it sets variables' global values instead of their local
1000 values (if any). When the current buffer does have a local value, the
1001 new global value may not be visible until you switch to another buffer.
1005 (setq-default fill-column 75)
1009 @code{setq-default} is the only way to set the global value of a variable
1010 that has been marked with @code{make-variable-buffer-local}.
1012 @findex default-value
1013 Lisp programs can use @code{default-value} to look at a variable's
1014 default value. This function takes a symbol as argument and returns its
1015 default value. The argument is evaluated; usually you must quote it
1016 explicitly. For example, here's how to obtain the default value of
1020 (default-value 'fill-column)
1023 @node File Variables
1024 @subsection Local Variables in Files
1025 @cindex local variables in files
1026 @cindex file local variables
1028 A file can specify local variable values to use when editing the
1029 file with Emacs. Visiting the file checks for local variable
1030 specifications; it automatically makes these variables local to the
1031 buffer, and sets them to the values specified in the file.
1034 * Specifying File Variables:: Specifying file local variables.
1035 * Safe File Variables:: Making sure file local variables are safe.
1038 @node Specifying File Variables
1039 @subsubsection Specifying File Variables
1041 There are two ways to specify file local variable values: in the first
1042 line, or with a local variables list. Here's how to specify them in the
1046 -*- mode: @var{modename}; @var{var}: @var{value}; @dots{} -*-
1050 You can specify any number of variable/value pairs in this way, each
1051 pair with a colon and semicolon. The special variable/value pair
1052 @code{mode: @var{modename};}, if present, specifies a major mode. The
1053 @var{value}s are used literally, and not evaluated.
1055 @findex add-file-local-variable-prop-line
1056 @findex delete-file-local-variable-prop-line
1057 @findex copy-dir-locals-to-file-locals-prop-line
1058 Instead of adding variable/value pairs by hand, you can use the
1059 command @kbd{M-x add-file-local-variable-prop-line}. This prompts for
1060 a variable and value, and adds them to the first line in the
1061 appropriate way. @kbd{M-x delete-file-local-variable-prop-line}
1062 prompts for a variable, and deletes its entry from the line. @kbd{M-x
1063 copy-dir-locals-to-file-locals-prop-line} copies directory-local
1064 variables to the first line (@pxref{Directory Variables}).
1066 Here is an example first line that specifies Lisp mode and sets two
1067 variables with numeric values:
1070 ;; -*- mode: Lisp; fill-column: 75; comment-column: 50; -*-
1074 Aside from @code{mode}, other keywords that have special meanings as
1075 file variables are @code{coding}, @code{unibyte}, and @code{eval}.
1076 These are described below.
1078 @cindex shell scripts, and local file variables
1079 @cindex man pages, and local file variables
1080 In shell scripts, the first line is used to identify the script
1081 interpreter, so you cannot put any local variables there. To
1082 accommodate this, Emacs looks for local variable specifications in the
1083 @emph{second} line if the first line specifies an interpreter. The
1084 same is true for man pages which start with the magic string
1085 @samp{'\"} to specify a list of troff preprocessors (not all do,
1088 Apart from using a @samp{-*-} line, you can define file local
1089 variables using a @dfn{local variables list} near the end of the file.
1090 The start of the local variables list should be no more than 3000
1091 characters from the end of the file, and must be on the last page if
1092 the file is divided into pages.
1094 If a file has both a local variables list and a @samp{-*-} line,
1095 Emacs processes @emph{everything} in the @samp{-*-} line first, and
1096 @emph{everything} in the local variables list afterward. The exception
1097 to this is a major mode specification. Emacs applies this first,
1098 wherever it appears, since most major modes kill all local variables as
1099 part of their initialization.
1101 A local variables list starts with a line containing the string
1102 @samp{Local Variables:}, and ends with a line containing the string
1103 @samp{End:}. In between come the variable names and values, one set
1104 per line, like this:
1107 /* Local Variables: */
1109 /* comment-column: 0 */
1114 In this example, each line starts with the prefix @samp{/*} and ends
1115 with the suffix @samp{*/}. Emacs recognizes the prefix and suffix by
1116 finding them surrounding the magic string @samp{Local Variables:}, on
1117 the first line of the list; it then automatically discards them from
1118 the other lines of the list. The usual reason for using a prefix
1119 and/or suffix is to embed the local variables list in a comment, so it
1120 won't confuse other programs that the file is intended for. The
1121 example above is for the C programming language, where comments start
1122 with @samp{/*} and end with @samp{*/}.
1124 @findex add-file-local-variable
1125 @findex delete-file-local-variable
1126 @findex copy-dir-locals-to-file-locals
1127 Instead of typing in the local variables list directly, you can use
1128 the command @kbd{M-x add-file-local-variable}. This prompts for a
1129 variable and value, and adds them to the list, adding the @samp{Local
1130 Variables:} string and start and end markers as necessary. The
1131 command @kbd{M-x delete-file-local-variable} deletes a variable from
1132 the list. @kbd{M-x copy-dir-locals-to-file-locals} copies
1133 directory-local variables to the list (@pxref{Directory Variables}).
1135 As with the @samp{-*-} line, the variables in a local variables list
1136 are used literally, and are not evaluated first. If you want to split
1137 a long string value across multiple lines of the file, you can use
1138 backslash-newline, which is ignored in Lisp string constants; you
1139 should put the prefix and suffix on each line, even lines that start
1140 or end within the string, as they will be stripped off when processing
1141 the list. Here is an example:
1145 # compile-command: "cc foo.c -Dfoo=bar -Dhack=whatever \
1150 Some ``variable names'' have special meanings in a local variables
1155 @code{mode} enables the specified major mode.
1158 @code{eval} evaluates the specified Lisp expression (the value
1159 returned by that expression is ignored).
1162 @code{coding} specifies the coding system for character code
1163 conversion of this file. @xref{Coding Systems}.
1166 @code{unibyte} says to visit the file in a unibyte buffer, if the
1167 value is @code{t}. @xref{Enabling Multibyte}.
1171 These four keywords are not really variables; setting them in any
1172 other context has no special meaning.
1174 Do not use the @code{mode} keyword for minor modes. To enable or
1175 disable a minor mode in a local variables list, use the @code{eval}
1176 keyword with a Lisp expression that runs the mode command
1177 (@pxref{Minor Modes}). For example, the following local variables
1178 list enables Eldoc mode (@pxref{Lisp Doc}) by calling
1179 @code{eldoc-mode} with no argument (calling it with an argument of 1
1180 would do the same), and disables Font Lock mode (@pxref{Font Lock}) by
1181 calling @code{font-lock-mode} with an argument of -1.
1185 ;; eval: (eldoc-mode)
1186 ;; eval: (font-lock-mode -1)
1191 Note, however, that it is often a mistake to specify minor modes this
1192 way. Minor modes represent individual user preferences, and it may be
1193 inappropriate to impose your preferences on another user who might
1194 edit the file. If you wish to automatically enable or disable a minor
1195 mode in a situation-dependent way, it is often better to do it in a
1196 major mode hook (@pxref{Hooks}).
1198 Use the command @kbd{M-x normal-mode} to reset the local variables
1199 and major mode of a buffer according to the file name and contents,
1200 including the local variables list if any. @xref{Choosing Modes}.
1202 @node Safe File Variables
1203 @subsubsection Safety of File Variables
1205 File-local variables can be dangerous; when you visit someone else's
1206 file, there's no telling what its local variables list could do to
1207 your Emacs. Improper values of the @code{eval} ``variable'', and
1208 other variables such as @code{load-path}, could execute Lisp code you
1209 didn't intend to run.
1211 Therefore, whenever Emacs encounters file local variable values that
1212 are not known to be safe, it displays the file's entire local
1213 variables list, and asks you for confirmation before setting them.
1214 You can type @kbd{y} or @key{SPC} to put the local variables list into
1215 effect, or @kbd{n} to ignore it. When Emacs is run in batch mode
1216 (@pxref{Initial Options}), it can't really ask you, so it assumes the
1219 Emacs normally recognizes certain variable/value pairs as safe.
1220 For instance, it is safe to give @code{comment-column} or
1221 @code{fill-column} any integer value. If a file specifies only
1222 known-safe variable/value pairs, Emacs does not ask for confirmation
1223 before setting them. Otherwise, you can tell Emacs to record all the
1224 variable/value pairs in this file as safe, by typing @kbd{!} at the
1225 confirmation prompt. When Emacs encounters these variable/value pairs
1226 subsequently, in the same file or others, it will assume they are
1229 @vindex safe-local-variable-values
1230 @cindex risky variable
1231 Some variables, such as @code{load-path}, are considered
1232 particularly @dfn{risky}: there is seldom any reason to specify them
1233 as local variables, and changing them can be dangerous. If a file
1234 contains only risky local variables, Emacs neither offers nor accepts
1235 @kbd{!} as input at the confirmation prompt. If some of the local
1236 variables in a file are risky, and some are only potentially unsafe, you
1237 can enter @kbd{!} at the prompt. It applies all the variables, but only
1238 marks the non-risky ones as safe for the future. If you really want to
1239 record safe values for risky variables, do it directly by customizing
1240 @samp{safe-local-variable-values} (@pxref{Easy Customization}).
1242 @vindex enable-local-variables
1243 The variable @code{enable-local-variables} allows you to change the
1244 way Emacs processes local variables. Its default value is @code{t},
1245 which specifies the behavior described above. If it is @code{nil},
1246 Emacs simply ignores all file local variables. @code{:safe} means use
1247 only the safe values and ignore the rest. Any other value says to
1248 query you about each file that has local variables, without trying to
1249 determine whether the values are known to be safe.
1251 @vindex enable-local-eval
1252 @vindex safe-local-eval-forms
1253 The variable @code{enable-local-eval} controls whether Emacs
1254 processes @code{eval} variables. The three possibilities for the
1255 variable's value are @code{t}, @code{nil}, and anything else, just as
1256 for @code{enable-local-variables}. The default is @code{maybe}, which
1257 is neither @code{t} nor @code{nil}, so normally Emacs does ask for
1258 confirmation about processing @code{eval} variables.
1260 As an exception, Emacs never asks for confirmation to evaluate any
1261 @code{eval} form if that form occurs within the variable
1262 @code{safe-local-eval-forms}.
1264 @node Directory Variables
1265 @subsection Per-Directory Local Variables
1266 @cindex local variables, for all files in a directory
1267 @cindex directory-local variables
1268 @cindex per-directory local variables
1270 Sometimes, you may wish to define the same set of local variables to
1271 all the files in a certain directory and its subdirectories, such as
1272 the directory tree of a large software project. This can be
1273 accomplished with @dfn{directory-local variables}.
1275 @cindex @file{.dir-locals.el} file
1276 The usual way to define directory-local variables is to put a file
1277 named @file{.dir-locals.el}@footnote{ On MS-DOS, the name of this file
1278 should be @file{_dir-locals.el}, due to limitations of the DOS
1279 filesystems. If the filesystem is limited to 8+3 file names, the name
1280 of the file will be truncated by the OS to @file{_dir-loc.el}. } in a
1281 directory. Whenever Emacs visits any file in that directory or any of
1282 its subdirectories, it will apply the directory-local variables
1283 specified in @file{.dir-locals.el}, as though they had been defined as
1284 file-local variables for that file (@pxref{File Variables}). Emacs
1285 searches for @file{.dir-locals.el} starting in the directory of the
1286 visited file, and moving up the directory tree. To avoid slowdown,
1287 this search is skipped for remote files.
1289 The @file{.dir-locals.el} file should hold a specially-constructed
1290 list, which maps major mode names (symbols) to alists
1291 (@pxref{Association Lists,,, elisp, The Emacs Lisp Reference Manual}).
1292 Each alist entry consists of a variable name and the directory-local
1293 value to assign to that variable, when the specified major mode is
1294 enabled. Instead of a mode name, you can specify @samp{nil}, which
1295 means that the alist applies to any mode; or you can specify a
1296 subdirectory name (a string), in which case the alist applies to all
1297 files in that subdirectory.
1299 Here's an example of a @file{.dir-locals.el} file:
1302 ((nil . ((indent-tabs-mode . t)
1303 (fill-column . 80)))
1304 (c-mode . ((c-file-style . "BSD")))
1307 . ((nil . ((change-log-default-name
1308 . "ChangeLog.local"))))))
1312 This sets @samp{indent-tabs-mode} and @code{fill-column} for any file
1313 in the directory tree, and the indentation style for any C source
1314 file. The special @code{subdirs} element is not a variable, but a
1315 special keyword which indicates that the C mode settings are only to
1316 be applied in the current directory, not in any subdirectories.
1317 Finally, it specifies a different @file{ChangeLog} file name for any
1318 file in the @file{src/imported} subdirectory.
1320 @findex add-dir-local-variable
1321 @findex delete-dir-local-variable
1322 @findex copy-file-locals-to-dir-locals
1323 Instead of editing the @file{.dir-locals.el} file by hand, you can
1324 use the command @kbd{M-x add-dir-local-variable}. This prompts for a
1325 mode or subdirectory name, and for variable and value, and adds the
1326 entry defining the directory-local variable. @kbd{M-x
1327 delete-dir-local-variable} deletes an entry. @kbd{M-x
1328 copy-file-locals-to-dir-locals} copies the file-local variables in the
1329 current file into @file{.dir-locals.el}.
1331 @findex dir-locals-set-class-variables
1332 @findex dir-locals-set-directory-class
1333 Another method of specifying directory-local variables is to define
1334 a group of variables/value pairs in a @dfn{directory class}, using the
1335 @code{dir-locals-set-class-variables} function; then, tell Emacs which
1336 directories correspond to the class by using the
1337 @code{dir-locals-set-directory-class} function. These function calls
1338 normally go in your initialization file (@pxref{Init File}). This
1339 method is useful when you can't put @file{.dir-locals.el} in a
1340 directory for some reason. For example, you could apply settings to
1341 an unwritable directory this way:
1344 (dir-locals-set-class-variables 'unwritable-directory
1345 '((nil . ((some-useful-setting . value)))))
1347 (dir-locals-set-directory-class
1348 "/usr/include/" 'unwritable-directory)
1351 If a variable has both a directory-local and file-local value
1352 specified, the file-local value takes effect. Unsafe directory-local
1353 variables are handled in the same way as unsafe file-local variables
1354 (@pxref{Safe File Variables}).
1356 Directory-local variables also take effect in certain buffers that
1357 do not visit a file directly but perform work within a directory, such
1358 as Dired buffers (@pxref{Dired}).
1361 @section Customizing Key Bindings
1362 @cindex key bindings
1364 This section describes @dfn{key bindings}, which map keys to
1365 commands, and @dfn{keymaps}, which record key bindings. It also
1366 explains how to customize key bindings, which is done by editing your
1367 init file (@pxref{Init Rebinding}).
1370 * Keymaps:: Generalities. The global keymap.
1371 * Prefix Keymaps:: Keymaps for prefix keys.
1372 * Local Keymaps:: Major and minor modes have their own keymaps.
1373 * Minibuffer Maps:: The minibuffer uses its own local keymaps.
1374 * Rebinding:: How to redefine one key's meaning conveniently.
1375 * Init Rebinding:: Rebinding keys with your initialization file.
1376 * Modifier Keys:: Using modifier keys in key bindings.
1377 * Function Keys:: Rebinding terminal function keys.
1378 * Named ASCII Chars:: Distinguishing @key{TAB} from @kbd{C-i}, and so on.
1379 * Mouse Buttons:: Rebinding mouse buttons in Emacs.
1380 * Disabling:: Disabling a command means confirmation is required
1381 before it can be executed. This is done to protect
1382 beginners from surprises.
1389 As described in @ref{Commands}, each Emacs command is a Lisp
1390 function whose definition provides for interactive use. Like every
1391 Lisp function, a command has a function name, which usually consists
1392 of lower-case letters and hyphens.
1394 A @dfn{key sequence} (@dfn{key}, for short) is a sequence of
1395 @dfn{input events} that have a meaning as a unit. Input events
1396 include characters, function keys and mouse buttons---all the inputs
1397 that you can send to the computer. A key sequence gets its meaning
1398 from its @dfn{binding}, which says what command it runs.
1400 The bindings between key sequences and command functions are
1401 recorded in data structures called @dfn{keymaps}. Emacs has many of
1402 these, each used on particular occasions.
1404 @cindex global keymap
1405 The @dfn{global} keymap is the most important keymap because it is
1406 always in effect. The global keymap defines keys for Fundamental mode
1407 (@pxref{Major Modes}); most of these definitions are common to most or
1408 all major modes. Each major or minor mode can have its own keymap
1409 which overrides the global definitions of some keys.
1411 For example, a self-inserting character such as @kbd{g} is
1412 self-inserting because the global keymap binds it to the command
1413 @code{self-insert-command}. The standard Emacs editing characters
1414 such as @kbd{C-a} also get their standard meanings from the global
1415 keymap. Commands to rebind keys, such as @kbd{M-x global-set-key},
1416 work by storing the new binding in the proper place in the global map
1417 (@pxref{Rebinding}).
1419 @cindex function key
1420 Most modern keyboards have function keys as well as character keys.
1421 Function keys send input events just as character keys do, and keymaps
1422 can have bindings for them. Key sequences can mix function keys and
1423 characters. For example, if your keyboard has a @key{Home} function
1424 key, Emacs can recognize key sequences like @kbd{C-x @key{Home}}. You
1425 can even mix mouse events with keyboard events, such as
1426 @kbd{S-down-mouse-1}.
1428 On text terminals, typing a function key actually sends the computer
1429 a sequence of characters; the precise details of the sequence depends
1430 on the function key and on the terminal type. (Often the sequence
1431 starts with @kbd{@key{ESC} [}.) If Emacs understands your terminal
1432 type properly, it automatically handles such sequences as single input
1435 @node Prefix Keymaps
1436 @subsection Prefix Keymaps
1438 Internally, Emacs records only single events in each keymap.
1439 Interpreting a key sequence of multiple events involves a chain of
1440 keymaps: the first keymap gives a definition for the first event,
1441 which is another keymap, which is used to look up the second event in
1442 the sequence, and so on. Thus, a prefix key such as @kbd{C-x} or
1443 @key{ESC} has its own keymap, which holds the definition for the event
1444 that immediately follows that prefix.
1446 The definition of a prefix key is usually the keymap to use for
1447 looking up the following event. The definition can also be a Lisp
1448 symbol whose function definition is the following keymap; the effect is
1449 the same, but it provides a command name for the prefix key that can be
1450 used as a description of what the prefix key is for. Thus, the binding
1451 of @kbd{C-x} is the symbol @code{Control-X-prefix}, whose function
1452 definition is the keymap for @kbd{C-x} commands. The definitions of
1453 @kbd{C-c}, @kbd{C-x}, @kbd{C-h} and @key{ESC} as prefix keys appear in
1454 the global map, so these prefix keys are always available.
1456 Aside from ordinary prefix keys, there is a fictitious ``prefix key''
1457 which represents the menu bar; see @ref{Menu Bar,,,elisp, The Emacs Lisp
1458 Reference Manual}, for special information about menu bar key bindings.
1459 Mouse button events that invoke pop-up menus are also prefix keys; see
1460 @ref{Menu Keymaps,,,elisp, The Emacs Lisp Reference Manual}, for more
1463 Some prefix keymaps are stored in variables with names:
1468 @code{ctl-x-map} is the variable name for the map used for characters that
1472 @code{help-map} is for characters that follow @kbd{C-h}.
1475 @code{esc-map} is for characters that follow @key{ESC}. Thus, all Meta
1476 characters are actually defined by this map.
1479 @code{ctl-x-4-map} is for characters that follow @kbd{C-x 4}.
1481 @vindex mode-specific-map
1482 @code{mode-specific-map} is for characters that follow @kbd{C-c}.
1486 @subsection Local Keymaps
1488 @cindex local keymap
1489 @cindex minor mode keymap
1490 So far, we have explained the ins and outs of the global map. Major
1491 modes customize Emacs by providing their own key bindings in
1492 @dfn{local keymaps}. For example, C mode overrides @key{TAB} to make
1493 it indent the current line for C code. Minor modes can also have
1494 local keymaps; whenever a minor mode is in effect, the definitions in
1495 its keymap override both the major mode's local keymap and the global
1496 keymap. In addition, portions of text in the buffer can specify their
1497 own keymaps, which override all other keymaps.
1499 A local keymap can redefine a key as a prefix key by defining it as
1500 a prefix keymap. If the key is also defined globally as a prefix, its
1501 local and global definitions (both keymaps) effectively combine: both
1502 definitions are used to look up the event that follows the prefix key.
1503 For example, if a local keymap defines @kbd{C-c} as a prefix keymap,
1504 and that keymap defines @kbd{C-z} as a command, this provides a local
1505 meaning for @kbd{C-c C-z}. This does not affect other sequences that
1506 start with @kbd{C-c}; if those sequences don't have their own local
1507 bindings, their global bindings remain in effect.
1509 Another way to think of this is that Emacs handles a multi-event key
1510 sequence by looking in several keymaps, one by one, for a binding of the
1511 whole key sequence. First it checks the minor mode keymaps for minor
1512 modes that are enabled, then it checks the major mode's keymap, and then
1513 it checks the global keymap. This is not precisely how key lookup
1514 works, but it's good enough for understanding the results in ordinary
1517 @node Minibuffer Maps
1518 @subsection Minibuffer Keymaps
1520 @cindex minibuffer keymaps
1521 @vindex minibuffer-local-map
1522 @vindex minibuffer-local-ns-map
1523 @vindex minibuffer-local-completion-map
1524 @vindex minibuffer-local-must-match-map
1525 @vindex minibuffer-local-filename-completion-map
1526 @vindex minibuffer-local-must-match-filename-map
1527 The minibuffer has its own set of local keymaps; they contain various
1528 completion and exit commands.
1532 @code{minibuffer-local-map} is used for ordinary input (no completion).
1534 @code{minibuffer-local-ns-map} is similar, except that @key{SPC} exits
1535 just like @key{RET}.
1537 @code{minibuffer-local-completion-map} is for permissive completion.
1539 @code{minibuffer-local-must-match-map} is for strict completion and
1540 for cautious completion.
1542 @code{minibuffer-local-filename-completion-map} and
1543 @code{minibuffer-local-must-match-filename-map} are like the two
1544 previous ones, but they are specifically for file name completion.
1545 They do not bind @key{SPC}.
1549 @subsection Changing Key Bindings Interactively
1550 @cindex key rebinding, this session
1551 @cindex redefining keys, this session
1552 @cindex binding keys
1554 The way to redefine an Emacs key is to change its entry in a keymap.
1555 You can change the global keymap, in which case the change is
1556 effective in all major modes (except those that have their own
1557 overriding local bindings for the same key). Or you can change a
1558 local keymap, which affects all buffers using the same major mode.
1560 In this section, we describe how to rebind keys for the present
1561 Emacs session. @xref{Init Rebinding}, for a description of how to
1562 make key rebindings affect future Emacs sessions.
1564 @findex global-set-key
1565 @findex local-set-key
1566 @findex global-unset-key
1567 @findex local-unset-key
1569 @item M-x global-set-key @key{RET} @var{key} @var{cmd} @key{RET}
1570 Define @var{key} globally to run @var{cmd}.
1571 @item M-x local-set-key @key{RET} @var{key} @var{cmd} @key{RET}
1572 Define @var{key} locally (in the major mode now in effect) to run
1574 @item M-x global-unset-key @key{RET} @var{key}
1575 Make @var{key} undefined in the global map.
1576 @item M-x local-unset-key @key{RET} @var{key}
1577 Make @var{key} undefined locally (in the major mode now in effect).
1580 For example, the following binds @kbd{C-z} to the @code{shell}
1581 command (@pxref{Interactive Shell}), replacing the normal global
1582 definition of @kbd{C-z}:
1585 M-x global-set-key @key{RET} C-z shell @key{RET}
1589 The @code{global-set-key} command reads the command name after the
1590 key. After you press the key, a message like this appears so that you
1591 can confirm that you are binding the key you want:
1594 Set key C-z to command:
1597 You can redefine function keys and mouse events in the same way; just
1598 type the function key or click the mouse when it's time to specify the
1601 You can rebind a key that contains more than one event in the same
1602 way. Emacs keeps reading the key to rebind until it is a complete key
1603 (that is, not a prefix key). Thus, if you type @kbd{C-f} for
1604 @var{key}, that's the end; it enters the minibuffer immediately to
1605 read @var{cmd}. But if you type @kbd{C-x}, since that's a prefix, it
1606 reads another character; if that is @kbd{4}, another prefix character,
1607 it reads one more character, and so on. For example,
1610 M-x global-set-key @key{RET} C-x 4 $ spell-other-window @key{RET}
1614 redefines @kbd{C-x 4 $} to run the (fictitious) command
1615 @code{spell-other-window}.
1617 You can remove the global definition of a key with
1618 @code{global-unset-key}. This makes the key @dfn{undefined}; if you
1619 type it, Emacs will just beep. Similarly, @code{local-unset-key} makes
1620 a key undefined in the current major mode keymap, which makes the global
1621 definition (or lack of one) come back into effect in that major mode.
1623 If you have redefined (or undefined) a key and you subsequently wish
1624 to retract the change, undefining the key will not do the job---you need
1625 to redefine the key with its standard definition. To find the name of
1626 the standard definition of a key, go to a Fundamental mode buffer in a
1627 fresh Emacs and use @kbd{C-h c}. The documentation of keys in this
1628 manual also lists their command names.
1630 If you want to prevent yourself from invoking a command by mistake, it
1631 is better to disable the command than to undefine the key. A disabled
1632 command is less work to invoke when you really want to.
1635 @node Init Rebinding
1636 @subsection Rebinding Keys in Your Init File
1637 @cindex rebinding major mode keys
1638 @c This node is referenced in the tutorial. When renaming or deleting
1639 @c it, the tutorial needs to be adjusted. (TUTORIAL.de)
1641 If you have a set of key bindings that you like to use all the time,
1642 you can specify them in your initialization file by writing Lisp code.
1643 @xref{Init File}, for a description of the initialization file.
1646 There are several ways to write a key binding using Lisp. The
1647 simplest is to use the @code{kbd} macro, which converts a textual
1648 representation of a key sequence---similar to how we have written key
1649 sequences in this manual---into a form that can be passed as an
1650 argument to @code{global-set-key}. For example, here's how to bind
1651 @kbd{C-z} to the @code{shell} command (@pxref{Interactive Shell}):
1654 (global-set-key (kbd "C-z") 'shell)
1658 The single-quote before the command name, @code{shell}, marks it as a
1659 constant symbol rather than a variable. If you omit the quote, Emacs
1660 would try to evaluate @code{shell} as a variable. This probably
1661 causes an error; it certainly isn't what you want.
1663 Here are some additional examples, including binding function keys
1667 (global-set-key (kbd "C-c y") 'clipboard-yank)
1668 (global-set-key (kbd "C-M-q") 'query-replace)
1669 (global-set-key (kbd "<f5>") 'flyspell-mode)
1670 (global-set-key (kbd "C-<f5>") 'linum-mode)
1671 (global-set-key (kbd "C-<right>") 'forward-sentence)
1672 (global-set-key (kbd "<mouse-2>") 'mouse-save-then-kill)
1675 Instead of using the @code{kbd} macro, you can use a Lisp string or
1676 vector to specify the key sequence. Using a string is simpler, but
1677 only works for @acronym{ASCII} characters and Meta-modified
1678 @acronym{ASCII} characters. For example, here's how to bind @kbd{C-x
1679 M-l} to @code{make-symbolic-link} (@pxref{Misc File Ops}):
1682 (global-set-key "\C-x\M-l" 'make-symbolic-link)
1685 To put @key{TAB}, @key{RET}, @key{ESC}, or @key{DEL} in the string,
1686 use the Emacs Lisp escape sequences @samp{\t}, @samp{\r}, @samp{\e},
1687 and @samp{\d} respectively. Here is an example which binds @kbd{C-x
1688 @key{TAB}} to @code{indent-rigidly} (@pxref{Indentation}):
1691 (global-set-key "\C-x\t" 'indent-rigidly)
1694 When the key sequence includes function keys or mouse button events,
1695 or non-@acronym{ASCII} characters such as @code{C-=} or @code{H-a},
1696 you can use a vector to specify the key sequence. Each element in the
1697 vector stands for an input event; the elements are separated by spaces
1698 and surrounded by a pair of square brackets. If a vector element is a
1699 character, write it as a Lisp character constant: @samp{?} followed by
1700 the character as it would appear in a string. Function keys are
1701 represented by symbols (@pxref{Function Keys}); simply write the
1702 symbol's name, with no other delimiters or punctuation. Here are some
1706 (global-set-key [?\C-=] 'make-symbolic-link)
1707 (global-set-key [?\M-\C-=] 'make-symbolic-link)
1708 (global-set-key [?\H-a] 'make-symbolic-link)
1709 (global-set-key [f7] 'make-symbolic-link)
1710 (global-set-key [C-mouse-1] 'make-symbolic-link)
1714 You can use a vector for the simple cases too:
1717 (global-set-key [?\C-z ?\M-l] 'make-symbolic-link)
1720 Language and coding systems may cause problems with key bindings for
1721 non-@acronym{ASCII} characters. @xref{Init Non-ASCII}.
1723 As described in @ref{Local Keymaps}, major modes and minor modes can
1724 define local keymaps. These keymaps are constructed when the mode is
1725 used for the first time in a session. If you wish to change one of
1726 these keymaps, you must use the @dfn{mode hook} (@pxref{Hooks}).
1729 For example, Texinfo mode runs the hook @code{texinfo-mode-hook}.
1730 Here's how you can use the hook to add local bindings for @kbd{C-c n}
1731 and @kbd{C-c p} in Texinfo mode:
1734 (add-hook 'texinfo-mode-hook
1736 (define-key texinfo-mode-map "\C-cp"
1737 'backward-paragraph)
1738 (define-key texinfo-mode-map "\C-cn"
1739 'forward-paragraph)))
1743 @subsection Modifier Keys
1744 @cindex modifier keys
1746 The default key bindings in Emacs are set up so that modified
1747 alphabetical characters are case-insensitive. In other words,
1748 @kbd{C-A} does the same thing as @kbd{C-a}, and @kbd{M-A} does the
1749 same thing as @kbd{M-a}. This concerns only alphabetical characters,
1750 and does not apply to ``shifted'' versions of other keys; for
1751 instance, @kbd{C-@@} is not the same as @kbd{C-2}.
1753 A @key{Control}-modified alphabetical character is always considered
1754 case-insensitive: Emacs always treats @kbd{C-A} as @kbd{C-a},
1755 @kbd{C-B} as @kbd{C-b}, and so forth. The reason for this is
1758 For all other modifiers, you can make the modified alphabetical
1759 characters case-sensitive when you customize Emacs. For instance, you
1760 could make @kbd{M-a} and @kbd{M-A} run different commands.
1762 Although only the @key{Control} and @key{Meta} modifier keys are
1763 commonly used, Emacs supports three other modifier keys. These are
1764 called @key{Super}, @key{Hyper} and @key{Alt}. Few terminals provide
1765 ways to use these modifiers; the key labeled @key{Alt} on most
1766 keyboards usually issues the @key{Meta} modifier, not @key{Alt}. The
1767 standard key bindings in Emacs do not include any characters with
1768 these modifiers. However, you can customize Emacs to assign meanings
1769 to them. The modifier bits are labeled as @samp{s-}, @samp{H-} and
1770 @samp{A-} respectively.
1772 Even if your keyboard lacks these additional modifier keys, you can
1773 enter it using @kbd{C-x @@}: @kbd{C-x @@ h} adds the ``hyper'' flag to
1774 the next character, @kbd{C-x @@ s} adds the ``super'' flag, and
1775 @kbd{C-x @@ a} adds the ``alt'' flag. For instance, @kbd{C-x @@ h
1776 C-a} is a way to enter @kbd{Hyper-Control-a}. (Unfortunately, there
1777 is no way to add two modifiers by using @kbd{C-x @@} twice for the
1778 same character, because the first one goes to work on the @kbd{C-x}.)
1781 @subsection Rebinding Function Keys
1783 Key sequences can contain function keys as well as ordinary
1784 characters. Just as Lisp characters (actually integers) represent
1785 keyboard characters, Lisp symbols represent function keys. If the
1786 function key has a word as its label, then that word is also the name of
1787 the corresponding Lisp symbol. Here are the conventional Lisp names for
1788 common function keys:
1791 @item @code{left}, @code{up}, @code{right}, @code{down}
1794 @item @code{begin}, @code{end}, @code{home}, @code{next}, @code{prior}
1795 Other cursor repositioning keys.
1797 @item @code{select}, @code{print}, @code{execute}, @code{backtab}
1798 @itemx @code{insert}, @code{undo}, @code{redo}, @code{clearline}
1799 @itemx @code{insertline}, @code{deleteline}, @code{insertchar}, @code{deletechar}
1800 Miscellaneous function keys.
1802 @item @code{f1}, @code{f2}, @dots{} @code{f35}
1803 Numbered function keys (across the top of the keyboard).
1805 @item @code{kp-add}, @code{kp-subtract}, @code{kp-multiply}, @code{kp-divide}
1806 @itemx @code{kp-backtab}, @code{kp-space}, @code{kp-tab}, @code{kp-enter}
1807 @itemx @code{kp-separator}, @code{kp-decimal}, @code{kp-equal}
1808 Keypad keys (to the right of the regular keyboard), with names or punctuation.
1810 @item @code{kp-0}, @code{kp-1}, @dots{} @code{kp-9}
1811 Keypad keys with digits.
1813 @item @code{kp-f1}, @code{kp-f2}, @code{kp-f3}, @code{kp-f4}
1817 These names are conventional, but some systems (especially when using
1818 X) may use different names. To make certain what symbol is used for a
1819 given function key on your terminal, type @kbd{C-h c} followed by that
1822 @xref{Init Rebinding}, for examples of binding function keys.
1825 Many keyboards have a ``numeric keypad'' on the right hand side.
1826 The numeric keys in the keypad double up as cursor motion keys,
1827 toggled by a key labeled @samp{Num Lock}. By default, Emacs
1828 translates these keys to the corresponding keys in the main keyboard.
1829 For example, when @samp{Num Lock} is on, the key labeled @samp{8} on
1830 the numeric keypad produces @code{kp-8}, which is translated to
1831 @kbd{8}; when @samp{Num Lock} is off, the same key produces
1832 @code{kp-up}, which is translated to @key{UP}. If you rebind a key
1833 such as @kbd{8} or @key{UP}, it affects the equivalent keypad key too.
1834 However, if you rebind a @samp{kp-} key directly, that won't affect
1835 its non-keypad equivalent. Note that the modified keys are not
1836 translated: for instance, if you hold down the @key{META} key while
1837 pressing the @samp{8} key on the numeric keypad, that generates
1840 Emacs provides a convenient method for binding the numeric keypad
1841 keys, using the variables @code{keypad-setup},
1842 @code{keypad-numlock-setup}, @code{keypad-shifted-setup}, and
1843 @code{keypad-numlock-shifted-setup}. These can be found in the
1844 @samp{keyboard} customization group (@pxref{Easy Customization}). You
1845 can rebind the keys to perform other tasks, such as issuing numeric
1848 @node Named ASCII Chars
1849 @subsection Named @acronym{ASCII} Control Characters
1851 @key{TAB}, @key{RET}, @key{BS}, @key{LFD}, @key{ESC} and @key{DEL}
1852 started out as names for certain @acronym{ASCII} control characters,
1853 used so often that they have special keys of their own. For instance,
1854 @key{TAB} was another name for @kbd{C-i}. Later, users found it
1855 convenient to distinguish in Emacs between these keys and the ``same''
1856 control characters typed with the @key{CTRL} key. Therefore, on most
1857 modern terminals, they are no longer the same: @key{TAB} is different
1860 Emacs can distinguish these two kinds of input if the keyboard does.
1861 It treats the ``special'' keys as function keys named @code{tab},
1862 @code{return}, @code{backspace}, @code{linefeed}, @code{escape}, and
1863 @code{delete}. These function keys translate automatically into the
1864 corresponding @acronym{ASCII} characters @emph{if} they have no
1865 bindings of their own. As a result, neither users nor Lisp programs
1866 need to pay attention to the distinction unless they care to.
1868 If you do not want to distinguish between (for example) @key{TAB} and
1869 @kbd{C-i}, make just one binding, for the @acronym{ASCII} character @key{TAB}
1870 (octal code 011). If you do want to distinguish, make one binding for
1871 this @acronym{ASCII} character, and another for the ``function key'' @code{tab}.
1873 With an ordinary @acronym{ASCII} terminal, there is no way to distinguish
1874 between @key{TAB} and @kbd{C-i} (and likewise for other such pairs),
1875 because the terminal sends the same character in both cases.
1878 @subsection Rebinding Mouse Buttons
1879 @cindex mouse button events
1880 @cindex rebinding mouse buttons
1881 @cindex click events
1884 @cindex button down events
1886 Emacs uses Lisp symbols to designate mouse buttons, too. The ordinary
1887 mouse events in Emacs are @dfn{click} events; these happen when you
1888 press a button and release it without moving the mouse. You can also
1889 get @dfn{drag} events, when you move the mouse while holding the button
1890 down. Drag events happen when you finally let go of the button.
1892 The symbols for basic click events are @code{mouse-1} for the leftmost
1893 button, @code{mouse-2} for the next, and so on. Here is how you can
1894 redefine the second mouse button to split the current window:
1897 (global-set-key [mouse-2] 'split-window-below)
1900 The symbols for drag events are similar, but have the prefix
1901 @samp{drag-} before the word @samp{mouse}. For example, dragging the
1902 first button generates a @code{drag-mouse-1} event.
1904 You can also define bindings for events that occur when a mouse button
1905 is pressed down. These events start with @samp{down-} instead of
1906 @samp{drag-}. Such events are generated only if they have key bindings.
1907 When you get a button-down event, a corresponding click or drag event
1910 @cindex double clicks
1911 @cindex triple clicks
1912 If you wish, you can distinguish single, double, and triple clicks. A
1913 double click means clicking a mouse button twice in approximately the
1914 same place. The first click generates an ordinary click event. The
1915 second click, if it comes soon enough, generates a double-click event
1916 instead. The event type for a double-click event starts with
1917 @samp{double-}: for example, @code{double-mouse-3}.
1919 This means that you can give a special meaning to the second click at
1920 the same place, but it must act on the assumption that the ordinary
1921 single click definition has run when the first click was received.
1923 This constrains what you can do with double clicks, but user interface
1924 designers say that this constraint ought to be followed in any case. A
1925 double click should do something similar to the single click, only
1926 ``more so.'' The command for the double-click event should perform the
1927 extra work for the double click.
1929 If a double-click event has no binding, it changes to the
1930 corresponding single-click event. Thus, if you don't define a
1931 particular double click specially, it executes the single-click command
1934 Emacs also supports triple-click events whose names start with
1935 @samp{triple-}. Emacs does not distinguish quadruple clicks as event
1936 types; clicks beyond the third generate additional triple-click events.
1937 However, the full number of clicks is recorded in the event list, so
1938 if you know Emacs Lisp you can distinguish if you really want to
1939 (@pxref{Click Events,,, elisp, The Emacs Lisp Reference Manual}).
1940 We don't recommend distinct meanings for more than three clicks, but
1941 sometimes it is useful for subsequent clicks to cycle through the same
1942 set of three meanings, so that four clicks are equivalent to one
1943 click, five are equivalent to two, and six are equivalent to three.
1945 Emacs also records multiple presses in drag and button-down events.
1946 For example, when you press a button twice, then move the mouse while
1947 holding the button, Emacs gets a @samp{double-drag-} event. And at the
1948 moment when you press it down for the second time, Emacs gets a
1949 @samp{double-down-} event (which is ignored, like all button-down
1950 events, if it has no binding).
1952 @vindex double-click-time
1953 The variable @code{double-click-time} specifies how much time can
1954 elapse between clicks and still allow them to be grouped as a multiple
1955 click. Its value is in units of milliseconds. If the value is
1956 @code{nil}, double clicks are not detected at all. If the value is
1957 @code{t}, then there is no time limit. The default is 500.
1959 @vindex double-click-fuzz
1960 The variable @code{double-click-fuzz} specifies how much the mouse
1961 can move between clicks and still allow them to be grouped as a multiple
1962 click. Its value is in units of pixels on windowed displays and in
1963 units of 1/8 of a character cell on text-mode terminals; the default is
1966 The symbols for mouse events also indicate the status of the modifier
1967 keys, with the usual prefixes @samp{C-}, @samp{M-}, @samp{H-},
1968 @samp{s-}, @samp{A-} and @samp{S-}. These always precede @samp{double-}
1969 or @samp{triple-}, which always precede @samp{drag-} or @samp{down-}.
1971 A frame includes areas that don't show text from the buffer, such as
1972 the mode line and the scroll bar. You can tell whether a mouse button
1973 comes from a special area of the screen by means of dummy ``prefix
1974 keys.'' For example, if you click the mouse in the mode line, you get
1975 the prefix key @code{mode-line} before the ordinary mouse-button symbol.
1976 Thus, here is how to define the command for clicking the first button in
1977 a mode line to run @code{scroll-up-command}:
1980 (global-set-key [mode-line mouse-1] 'scroll-up-command)
1983 Here is the complete list of these dummy prefix keys and their
1988 The mouse was in the mode line of a window.
1990 The mouse was in the vertical line separating side-by-side windows. (If
1991 you use scroll bars, they appear in place of these vertical lines.)
1992 @item vertical-scroll-bar
1993 The mouse was in a vertical scroll bar. (This is the only kind of
1994 scroll bar Emacs currently supports.)
1996 The mouse was in the menu bar.
1998 The mouse was in a header line.
2000 @item horizontal-scroll-bar
2001 The mouse was in a horizontal scroll bar. Horizontal scroll bars do
2002 horizontal scrolling, and people don't use them often.
2006 You can put more than one mouse button in a key sequence, but it isn't
2010 @subsection Disabling Commands
2011 @cindex disabled command
2013 Disabling a command means that invoking it interactively asks for
2014 confirmation from the user. The purpose of disabling a command is to
2015 prevent users from executing it by accident; we do this for commands
2016 that might be confusing to the uninitiated.
2018 Attempting to invoke a disabled command interactively in Emacs
2019 displays a window containing the command's name, its documentation,
2020 and some instructions on what to do immediately; then Emacs asks for
2021 input saying whether to execute the command as requested, enable it
2022 and execute it, or cancel. If you decide to enable the command, you
2023 must then answer another question---whether to do this permanently, or
2024 just for the current session. (Enabling permanently works by
2025 automatically editing your initialization file.) You can also type
2026 @kbd{!} to enable @emph{all} commands, for the current session only.
2028 The direct mechanism for disabling a command is to put a
2029 non-@code{nil} @code{disabled} property on the Lisp symbol for the
2030 command. Here is the Lisp program to do this:
2033 (put 'delete-region 'disabled t)
2036 If the value of the @code{disabled} property is a string, that string
2037 is included in the message displayed when the command is used:
2040 (put 'delete-region 'disabled
2041 "It's better to use `kill-region' instead.\n")
2044 @findex disable-command
2045 @findex enable-command
2046 You can make a command disabled either by editing the initialization
2047 file directly, or with the command @kbd{M-x disable-command}, which
2048 edits the initialization file for you. Likewise, @kbd{M-x
2049 enable-command} edits the initialization file to enable a command
2050 permanently. @xref{Init File}.
2052 If Emacs was invoked with the @option{-q} or @option{--no-init-file}
2053 options (@pxref{Initial Options}), it will not edit your
2054 initialization file. Doing so could lose information because Emacs
2055 has not read your initialization file.
2057 Whether a command is disabled is independent of what key is used to
2058 invoke it; disabling also applies if the command is invoked using
2059 @kbd{M-x}. However, disabling a command has no effect on calling it
2060 as a function from Lisp programs.
2063 @section The Emacs Initialization File
2066 @cindex ~/.emacs file
2067 @cindex Emacs initialization file
2068 @cindex key rebinding, permanent
2069 @cindex rebinding keys, permanently
2070 @cindex startup (init file)
2072 When Emacs is started, it normally tries to load a Lisp program from
2073 an @dfn{initialization file}, or @dfn{init file} for short. This
2074 file, if it exists, specifies how to initialize Emacs for you. Emacs
2075 looks for your init file using the filenames @file{~/.emacs},
2076 @file{~/.emacs.el}, or @file{~/.emacs.d/init.el}; you can choose to
2077 use any one of these three names (@pxref{Find Init}). Here, @file{~/}
2078 stands for your home directory.
2080 You can use the command line switch @samp{-q} to prevent loading
2081 your init file, and @samp{-u} (or @samp{--user}) to specify a
2082 different user's init file (@pxref{Initial Options}).
2084 @cindex @file{default.el}, the default init file
2085 There can also be a @dfn{default init file}, which is the library
2086 named @file{default.el}, found via the standard search path for
2087 libraries. The Emacs distribution contains no such library; your site
2088 may create one for local customizations. If this library exists, it is
2089 loaded whenever you start Emacs (except when you specify @samp{-q}).
2090 But your init file, if any, is loaded first; if it sets
2091 @code{inhibit-default-init} non-@code{nil}, then @file{default} is not
2094 @cindex site init file
2095 @cindex @file{site-start.el}, the site startup file
2096 Your site may also have a @dfn{site startup file}; this is named
2097 @file{site-start.el}, if it exists. Like @file{default.el}, Emacs
2098 finds this file via the standard search path for Lisp libraries.
2099 Emacs loads this library before it loads your init file. To inhibit
2100 loading of this library, use the option @samp{--no-site-file}.
2101 @xref{Initial Options}. We recommend against using
2102 @file{site-start.el} for changes that some users may not like. It is
2103 better to put them in @file{default.el}, so that users can more easily
2106 You can place @file{default.el} and @file{site-start.el} in any of
2107 the directories which Emacs searches for Lisp libraries. The variable
2108 @code{load-path} (@pxref{Lisp Libraries}) specifies these directories.
2109 Many sites put these files in the @file{site-lisp} subdirectory of the
2110 Emacs installation directory, typically
2111 @file{/usr/local/share/emacs/site-lisp}.
2113 Byte-compiling your init file is not recommended (@pxref{Byte
2114 Compilation,, Byte Compilation, elisp, the Emacs Lisp Reference
2115 Manual}). It generally does not speed up startup very much, and often
2116 leads to problems when you forget to recompile the file. A better
2117 solution is to use the Emacs server to reduce the number of times you
2118 have to start Emacs (@pxref{Emacs Server}). If your init file defines
2119 many functions, consider moving them to a separate (byte-compiled)
2120 file that you load in your init file.
2122 If you are going to write actual Emacs Lisp programs that go beyond
2123 minor customization, you should read the @cite{Emacs Lisp Reference Manual}.
2125 @xref{Top, Emacs Lisp, Emacs Lisp, elisp, the Emacs Lisp Reference
2130 * Init Syntax:: Syntax of constants in Emacs Lisp.
2131 * Init Examples:: How to do some things with an init file.
2132 * Terminal Init:: Each terminal type can have an init file.
2133 * Find Init:: How Emacs finds the init file.
2134 * Init Non-ASCII:: Using non-@acronym{ASCII} characters in an init file.
2138 @subsection Init File Syntax
2140 The init file contains one or more Lisp expressions. Each of these
2141 consists of a function name followed by arguments, all surrounded by
2142 parentheses. For example, @code{(setq fill-column 60)} calls the
2143 function @code{setq} to set the variable @code{fill-column}
2144 (@pxref{Filling}) to 60.
2146 You can set any Lisp variable with @code{setq}, but with certain
2147 variables @code{setq} won't do what you probably want in the
2148 @file{.emacs} file. Some variables automatically become buffer-local
2149 when set with @code{setq}; what you want in @file{.emacs} is to set
2150 the default value, using @code{setq-default}. Some customizable minor
2151 mode variables do special things to enable the mode when you set them
2152 with Customize, but ordinary @code{setq} won't do that; to enable the
2153 mode in your @file{.emacs} file, call the minor mode command. The
2154 following section has examples of both of these methods.
2156 The second argument to @code{setq} is an expression for the new
2157 value of the variable. This can be a constant, a variable, or a
2158 function call expression. In @file{.emacs}, constants are used most
2159 of the time. They can be:
2163 Numbers are written in decimal, with an optional initial minus sign.
2166 @cindex Lisp string syntax
2167 @cindex string syntax
2168 Lisp string syntax is the same as C string syntax with a few extra
2169 features. Use a double-quote character to begin and end a string constant.
2171 In a string, you can include newlines and special characters literally.
2172 But often it is cleaner to use backslash sequences for them: @samp{\n}
2173 for newline, @samp{\b} for backspace, @samp{\r} for carriage return,
2174 @samp{\t} for tab, @samp{\f} for formfeed (control-L), @samp{\e} for
2175 escape, @samp{\\} for a backslash, @samp{\"} for a double-quote, or
2176 @samp{\@var{ooo}} for the character whose octal code is @var{ooo}.
2177 Backslash and double-quote are the only characters for which backslash
2178 sequences are mandatory.
2180 @samp{\C-} can be used as a prefix for a control character, as in
2181 @samp{\C-s} for @acronym{ASCII} control-S, and @samp{\M-} can be used as a prefix for
2182 a Meta character, as in @samp{\M-a} for @kbd{Meta-A} or @samp{\M-\C-a} for
2183 @kbd{Control-Meta-A}.@refill
2185 @xref{Init Non-ASCII}, for information about including
2186 non-@acronym{ASCII} in your init file.
2189 @cindex Lisp character syntax
2190 @cindex character syntax
2191 Lisp character constant syntax consists of a @samp{?} followed by
2192 either a character or an escape sequence starting with @samp{\}.
2193 Examples: @code{?x}, @code{?\n}, @code{?\"}, @code{?\)}. Note that
2194 strings and characters are not interchangeable in Lisp; some contexts
2195 require one and some contexts require the other.
2197 @xref{Init Non-ASCII}, for information about binding commands to
2198 keys which send non-@acronym{ASCII} characters.
2201 @code{t} stands for `true'.
2204 @code{nil} stands for `false'.
2206 @item Other Lisp objects:
2207 @cindex Lisp object syntax
2208 Write a single-quote (@code{'}) followed by the Lisp object you want.
2212 @subsection Init File Examples
2214 Here are some examples of doing certain commonly desired things with
2219 Add a directory to the variable @code{load-path}. You can then put
2220 Lisp libraries that are not included with Emacs in this directory, and
2221 load them with @kbd{M-x load-library}. @xref{Lisp Libraries}.
2224 (add-to-list 'load-path "/path/to/lisp/libraries")
2228 Make @key{TAB} in C mode just insert a tab if point is in the middle of a
2232 (setq c-tab-always-indent nil)
2235 Here we have a variable whose value is normally @code{t} for `true'
2236 and the alternative is @code{nil} for `false'.
2239 Make searches case sensitive by default (in all buffers that do not
2243 (setq-default case-fold-search nil)
2246 This sets the default value, which is effective in all buffers that do
2247 not have local values for the variable (@pxref{Locals}). Setting
2248 @code{case-fold-search} with @code{setq} affects only the current
2249 buffer's local value, which is probably not what you want to do in an
2253 @vindex user-mail-address
2254 Specify your own email address, if Emacs can't figure it out correctly.
2257 (setq user-mail-address "cheney@@torture.gov")
2260 Various Emacs packages, such as Message mode, consult
2261 @code{user-mail-address} when they need to know your email address.
2262 @xref{Mail Headers}.
2265 Make Text mode the default mode for new buffers.
2268 (setq-default major-mode 'text-mode)
2271 Note that @code{text-mode} is used because it is the command for
2272 entering Text mode. The single-quote before it makes the symbol a
2273 constant; otherwise, @code{text-mode} would be treated as a variable
2278 Set up defaults for the Latin-1 character set
2279 which supports most of the languages of Western Europe.
2282 (set-language-environment "Latin-1")
2287 Turn off Line Number mode, a global minor mode.
2290 (line-number-mode 0)
2295 Turn on Auto Fill mode automatically in Text mode and related modes
2299 (add-hook 'text-mode-hook 'auto-fill-mode)
2303 Load the installed Lisp library named @file{foo} (actually a file
2304 @file{foo.elc} or @file{foo.el} in a standard Emacs directory).
2310 When the argument to @code{load} is a relative file name, not starting
2311 with @samp{/} or @samp{~}, @code{load} searches the directories in
2312 @code{load-path} (@pxref{Lisp Libraries}).
2315 Load the compiled Lisp file @file{foo.elc} from your home directory.
2321 Here a full file name is used, so no searching is done.
2324 @cindex loading Lisp libraries automatically
2325 @cindex autoload Lisp libraries
2326 Tell Emacs to find the definition for the function @code{myfunction}
2327 by loading a Lisp library named @file{mypackage} (i.e.@: a file
2328 @file{mypackage.elc} or @file{mypackage.el}):
2331 (autoload 'myfunction "mypackage" "Do what I say." t)
2335 Here the string @code{"Do what I say."} is the function's
2336 documentation string. You specify it in the @code{autoload}
2337 definition so it will be available for help commands even when the
2338 package is not loaded. The last argument, @code{t}, indicates that
2339 this function is interactive; that is, it can be invoked interactively
2340 by typing @kbd{M-x myfunction @key{RET}} or by binding it to a key.
2341 If the function is not interactive, omit the @code{t} or use
2345 Rebind the key @kbd{C-x l} to run the function @code{make-symbolic-link}
2346 (@pxref{Init Rebinding}).
2349 (global-set-key "\C-xl" 'make-symbolic-link)
2355 (define-key global-map "\C-xl" 'make-symbolic-link)
2358 Note once again the single-quote used to refer to the symbol
2359 @code{make-symbolic-link} instead of its value as a variable.
2362 Do the same thing for Lisp mode only.
2365 (define-key lisp-mode-map "\C-xl" 'make-symbolic-link)
2369 Redefine all keys which now run @code{next-line} in Fundamental mode
2370 so that they run @code{forward-line} instead.
2372 @findex substitute-key-definition
2374 (substitute-key-definition 'next-line 'forward-line
2379 Make @kbd{C-x C-v} undefined.
2382 (global-unset-key "\C-x\C-v")
2385 One reason to undefine a key is so that you can make it a prefix.
2386 Simply defining @kbd{C-x C-v @var{anything}} will make @kbd{C-x C-v} a
2387 prefix, but @kbd{C-x C-v} must first be freed of its usual non-prefix
2391 Make @samp{$} have the syntax of punctuation in Text mode.
2392 Note the use of a character constant for @samp{$}.
2395 (modify-syntax-entry ?\$ "." text-mode-syntax-table)
2399 Enable the use of the command @code{narrow-to-region} without confirmation.
2402 (put 'narrow-to-region 'disabled nil)
2406 Adjusting the configuration to various platforms and Emacs versions.
2408 Users typically want Emacs to behave the same on all systems, so the
2409 same init file is right for all platforms. However, sometimes it
2410 happens that a function you use for customizing Emacs is not available
2411 on some platforms or in older Emacs versions. To deal with that
2412 situation, put the customization inside a conditional that tests whether
2413 the function or facility is available, like this:
2416 (if (fboundp 'blink-cursor-mode)
2417 (blink-cursor-mode 0))
2419 (if (boundp 'coding-category-utf-8)
2420 (set-coding-priority '(coding-category-utf-8)))
2424 You can also simply disregard the errors that occur if the
2425 function is not defined.
2429 (set-face-background 'region "grey75")
2433 A @code{setq} on a variable which does not exist is generally
2434 harmless, so those do not need a conditional.
2438 @subsection Terminal-specific Initialization
2440 Each terminal type can have a Lisp library to be loaded into Emacs when
2441 it is run on that type of terminal. For a terminal type named
2442 @var{termtype}, the library is called @file{term/@var{termtype}} and it is
2443 found by searching the directories @code{load-path} as usual and trying the
2444 suffixes @samp{.elc} and @samp{.el}. Normally it appears in the
2445 subdirectory @file{term} of the directory where most Emacs libraries are
2448 The usual purpose of the terminal-specific library is to map the
2449 escape sequences used by the terminal's function keys onto more
2450 meaningful names, using @code{input-decode-map} (or
2451 @code{function-key-map} before it). See the file
2452 @file{term/lk201.el} for an example of how this is done. Many function
2453 keys are mapped automatically according to the information in the
2454 Termcap data base; the terminal-specific library needs to map only the
2455 function keys that Termcap does not specify.
2457 When the terminal type contains a hyphen, only the part of the name
2458 before the first hyphen is significant in choosing the library name.
2459 Thus, terminal types @samp{aaa-48} and @samp{aaa-30-rv} both use
2460 the library @file{term/aaa}. The code in the library can use
2461 @code{(getenv "TERM")} to find the full terminal type name.@refill
2463 @vindex term-file-prefix
2464 The library's name is constructed by concatenating the value of the
2465 variable @code{term-file-prefix} and the terminal type. Your @file{.emacs}
2466 file can prevent the loading of the terminal-specific library by setting
2467 @code{term-file-prefix} to @code{nil}.
2469 @vindex term-setup-hook
2470 Emacs runs the hook @code{term-setup-hook} at the end of
2471 initialization, after both your @file{.emacs} file and any
2472 terminal-specific library have been read in. Add hook functions to this
2473 hook if you wish to override part of any of the terminal-specific
2474 libraries and to define initializations for terminals that do not have a
2475 library. @xref{Hooks}.
2478 @subsection How Emacs Finds Your Init File
2480 Normally Emacs uses the environment variable @env{HOME}
2481 (@pxref{General Variables, HOME}) to find @file{.emacs}; that's what
2482 @samp{~} means in a file name. If @file{.emacs} is not found inside
2483 @file{~/} (nor @file{.emacs.el}), Emacs looks for
2484 @file{~/.emacs.d/init.el} (which, like @file{~/.emacs.el}, can be
2487 However, if you run Emacs from a shell started by @code{su}, Emacs
2488 tries to find your own @file{.emacs}, not that of the user you are
2489 currently pretending to be. The idea is that you should get your own
2490 editor customizations even if you are running as the super user.
2492 More precisely, Emacs first determines which user's init file to use.
2493 It gets your user name from the environment variables @env{LOGNAME} and
2494 @env{USER}; if neither of those exists, it uses effective user-ID.
2495 If that user name matches the real user-ID, then Emacs uses @env{HOME};
2496 otherwise, it looks up the home directory corresponding to that user
2497 name in the system's data base of users.
2498 @c LocalWords: backtab
2500 @node Init Non-ASCII
2501 @subsection Non-@acronym{ASCII} Characters in Init Files
2502 @cindex international characters in @file{.emacs}
2503 @cindex non-@acronym{ASCII} characters in @file{.emacs}
2504 @cindex non-@acronym{ASCII} keys, binding
2505 @cindex rebinding non-@acronym{ASCII} keys
2507 Language and coding systems may cause problems if your init file
2508 contains non-@acronym{ASCII} characters, such as accented letters, in
2509 strings or key bindings.
2511 If you want to use non-@acronym{ASCII} characters in your init file,
2512 you should put a @w{@samp{-*-coding: @var{coding-system}-*-}} tag on
2513 the first line of the init file, and specify a coding system that
2514 supports the character(s) in question. @xref{Recognize Coding}. This
2515 is because the defaults for decoding non-@acronym{ASCII} text might
2516 not yet be set up by the time Emacs reads those parts of your init
2517 file which use such strings, possibly leading Emacs to decode those
2518 strings incorrectly. You should then avoid adding Emacs Lisp code
2519 that modifies the coding system in other ways, such as calls to
2520 @code{set-language-environment}.
2522 To bind non-@acronym{ASCII} keys, you must use a vector (@pxref{Init
2523 Rebinding}). The string syntax cannot be used, since the
2524 non-@acronym{ASCII} characters will be interpreted as meta keys. For
2528 (global-set-key [?@var{char}] 'some-function)
2532 Type @kbd{C-q}, followed by the key you want to bind, to insert @var{char}.
2534 @strong{Warning:} if you change the keyboard encoding, or change
2535 between multibyte and unibyte mode, or anything that would alter which
2536 code @kbd{C-q} would insert for that character, this key binding may
2537 stop working. It is therefore advisable to use one and only one
2538 coding system, for your init file as well as the files you edit. For
2539 example, don't mix the @samp{latin-1} and @samp{latin-9} coding