Customization settings are organized into customization groups. These groups are collected into bigger groups, all the way up to a master group called Emacs. M-x customize creates a customization buffer that shows the top-level Emacs group. It looks like this, in part:

For help using this buffer, see [Easy Customization] in the [Emacs manual].

________________________________________ [ Search ]

 Operate on all settings in this buffer:
 [ Revert... ] [ Apply ] [ Apply and Save ]


Emacs group: Customization of the One True Editor.
      [State]: visible group members are all at standard values.
      See also [Manual].

[Editing]      Basic text editing facilities.
[Convenience]  Convenience features for faster editing.

@var{...more second-level groups...}

The main part of this buffer shows the Emacs customization group, which contains several other groups (Editing, Convenience, etc.). The contents of those groups are not listed here, only one line of documentation each. The state of the group indicates whether setting in that group has been edited, set, or saved. Changing a Variable. Most of the customization buffer is read-only, but it includes some editable fields that you can edit. For example, at the top of the customization buffer is an editable field for searching for settings (Browsing Custom). There are also buttons and links, which you can activate by either clicking with the mouse, or moving point there and typing RET. For example, the group names like [Editing] are links; activating one of these links brings up the customization buffer for that group. In the customization buffer, you can type TAB (widget-forward) to move forward to the next button or editable field. S-TAB (widget-backward) moves back to the previous button or editable field.

From the top-level customization buffer created by M-x customize, you can follow the links to the subgroups of the Emacs customization group. These subgroups may contain settings for you to customize; they may also contain further subgroups, dealing with yet more specialized subsystems of Emacs. As you navigate the hierarchy of customization groups, you should find some settings that you want to customize. If you are interested in customizing a particular setting or customization group, you can go straight there with the commands M-x customize-option, M-x customize-face, or M-x customize-group. Specific Customization. If you don't know exactly what groups or settings you want to customize, you can search for them using the editable search field at the top of each customization buffer. Here, you can type in a search term—either one or more words separated by spaces, or a regular expression (Regexps). Then type RET in the field, or activate the Search button next to it, to switch to a customization buffer containing groups and settings that match those terms. Note, however, that this feature only finds groups and settings that are loaded in the current Emacs session. If you don't want customization buffers to show the search field, change the variable custom-search-field to nil. The command M-x customize-apropos is similar to using the search field, except that it reads the search term(s) using the minibuffer. Specific Customization. M-x customize-browse is another way to browse the available settings. This command creates a special customization buffer, which shows only the names of groups and settings, in a structured layout. You can show the contents of a group, in the same buffer, by invoking the [+] button next to the group name. When the group contents are shown, the button changes to [-]; invoking that hides the group contents again. Each group or setting in this buffer has a link which says [Group], [Option] or [Face]. Invoking this link creates an ordinary customization buffer showing just that group, option, or face; this is the way to change settings that you find with M-x customize-browse.

Here is an example of what a variable, or user option, looks like in the customization buffer:

[Hide] Kill Ring Max: Integer (positive or zero): 120
   [State]: STANDARD.
   Maximum length of kill ring before oldest elements are thrown away.

The first line shows that the variable is named kill-ring-max, formatted as Kill Ring Max for easier viewing, and also shows its expected type: a positive integer or zero. The default value is 120. You can move directly to the value with C-x C-i (Custom-goto-first-choice). The button labeled [Hide], if activated, hides the variable's value and state; this is useful to avoid cluttering up the customization buffer with very long values (for this reason, variables that have very long values may start out hidden). If you use the [Hide] button, it changes to [Show Value], which you can activate to reveal the value and state. On a graphical display, the [Hide] and [Show Value] buttons are replaced with graphical triangles pointing downwards and rightwards respectively. The line after the variable name indicates the customization state of the variable: in this example, STANDARD means you have not changed the variable, so its value is the default one. The [State] button gives a menu of operations for customizing the variable. Below the customization state is the documentation for the variable. This is the same documentation that would be shown by the C-h v command (Examining). If the documentation is more than one line long, only one line may be shown. If so, that line ends with a [More] button; activate this to see the full documentation. To enter a new value for Kill Ring Max, just move point to the value and edit it. For example, type M-d to delete the 60 and type in another number. As you begin to alter the text, the [State] line will change:

[State]: EDITED, shown value does not take effect until you
         set or save it.

Editing the value does not make it take effect right away. To do that, you must set the variable by activating the [State] button and choosing Set for Current Session. Then the variable's state becomes:

[State]: SET for current session only.

You don't have to worry about specifying a value that is not valid; the Set for Current Session operation checks for validity and will not install an unacceptable value. While editing certain kinds of values, such as file names, directory names, and Emacs command names, you can perform completion with C-M-i (widget-complete), or the equivalent keys M-TAB or ESC TAB. This behaves much like minibuffer completion (Completion). Typing RET on an editable value field moves point forward to the next field or button, like TAB. You can thus type RET when you are finished editing a field, to move on to the next button or field. To insert a newline within an editable field, use C-o or C-q C-j. For some variables, there is only a fixed set of legitimate values, and you are not allowed to edit the value directly. Instead, a [Value Menu] button appears before the value; activating this button presents a choice of values. For a boolean "on or off" value, the button says [Toggle], and flips the value. After using the [Value Menu] or [Toggle] button, you must again set the variable to make the chosen value take effect. Some variables have values with complex structure. For example, the value of minibuffer-frame-alist is an association list. Here is how it appears in the customization buffer:

[Hide] Minibuffer Frame Alist:
[INS] [DEL] Parameter: width
            Value: 80
[INS] [DEL] Parameter: height
            Value: 2
[INS]
   [ State ]: STANDARD.
   Alist of parameters for the initial minibuffer frame. [Hide]
   @r{[@dots{}more lines of documentation@dots{}]}

In this case, each association in the list consists of two items, one labeled Parameter and one labeled Value; both are editable fields. You can delete an association from the list with the [DEL] button next to it. To add an association, use the [INS] button at the position where you want to insert it; the very last [INS] button inserts at the end of the list. When you set a variable, the new value takes effect only in the current Emacs session. To save the value for future sessions, use the [State] button and select the Save for Future Sessions operation. Saving Customizations. You can also restore the variable to its standard value by using the [State] button and selecting the Erase Customization operation. There are actually four reset operations:

Undo Edits

If you have modified but not yet set the variable, this restores the text in the customization buffer to match the actual value.

Revert This Session's Customizations

This restores the value of the variable to the last saved value, if there was one. Otherwise it restores the standard value. It updates the text accordingly.

Erase Customization

This sets the variable to its standard value. Any saved value that you have is also eliminated.

Set to Backup Value

This sets the variable to a previous value that was set in the customization buffer in this session. If you customize a variable and then reset it, which discards the customized value, you can get the discarded value back again with this operation.

Sometimes it is useful to record a comment about a specific customization. Use the Add Comment item from the [State] menu to create a field for entering the comment. Near the top of the customization buffer are two lines of buttons:

Operate on all settings in this buffer:
 [Revert...] [Apply] [Apply and Save]

The [Revert...] button drops a menu with the first 3 reset operations described above. The [Apply] button applies the settings for the current session. The [Apply and Save] button applies the settings and saves them for future sessions; this button does not appear if Emacs was started with the -q or -Q option (Initial Options). The command C-c C-c (Custom-set) is equivalent to using the [Set for Current Session] button. The command C-x C-s (Custom-save) is like using the [Save for Future Sessions] button. Likewise, C-c C-k (Custom-reset-standard) is like using the [Revert...] button. The [Exit] button switches out of the customization buffer, and buries the buffer at the bottom of the buffer list. To make it kill the customization buffer instead, change the variable custom-buffer-done-kill to t.

In the customization buffer, you can save a customization setting by choosing the Save for Future Sessions choice from its [State] button. The C-x C-s (Custom-save) command, or the [Apply and Save] button at the top of the customization buffer, saves all applicable settings in the buffer. Saving works by writing code to a file, usually your initialization file (Init File). Future Emacs sessions automatically read this file at startup, which sets up the customizations again. You can choose to save customizations somewhere other than your initialization file. To make this work, you must add a couple of lines of code to your initialization file, to set the variable custom-file to the name of the desired file, and to load that file. For example:

(setq custom-file "~/.config/emacs-custom.el")
(load custom-file)

You can even specify different customization files for different Emacs versions, like this:

(cond ((< emacs-major-version 28)
       ;; @r{Emacs 27 customization.}
       (setq custom-file "~/.config/custom-27.el"))
      ((and (= emacs-major-version 26)
            (< emacs-minor-version 3))
       ;; @r{Emacs 26 customization, before version 26.3.}
       (setq custom-file "~/.config/custom-26.el"))
      (t
       ;; @r{Emacs version 28.1 or later.}
       (setq custom-file "~/.config/emacs-custom.el")))

(load custom-file)

If Emacs was invoked with the -q or --no-init-file options (Initial Options), it will not let you save your customizations in your initialization file. This is because saving customizations from such a session would wipe out all the other customizations you might have on your initialization file. Please note that any customizations you have not chosen to save for future sessions will be lost when you terminate Emacs. If you'd like to be prompted about unsaved customizations at termination time, add the following to your initialization file:

(add-hook 'kill-emacs-query-functions
          'custom-prompt-customize-unsaved-options)

You can customize faces (Faces), which determine how Emacs displays different types of text. Customization groups can contain both variables and faces. For example, in programming language modes, source code comments are shown with font-lock-comment-face (Font Lock). In a customization buffer, that face appears like this, after you click on the [Show All Attributes] link:

[Hide] Font Lock Comment Face:[sample]
   [State] : STANDARD.
   Font Lock mode face used to highlight comments.
   [ ] Font Family: --
   [ ] Font Foundry: --
   [ ] Width: --
   [ ] Height: --
   [ ] Weight: --
   [ ] Slant: --
   [ ] Underline: --
   [ ] Overline: --
   [ ] Strike-through: --
   [ ] Box around text: --
   [ ] Inverse-video: --
   [X] Foreground: Firebrick     [Choose]  (sample)
   [ ] Background: --
   [ ] Stipple: --
   [ ] Inherit: --
   [Hide Unused Attributes]

The first three lines show the name, [State] button, and documentation for the face. Below that is a list of face attributes. In front of each attribute is a checkbox. A filled checkbox, [X], means that the face specifies a value for this attribute; an empty checkbox, [ ], means that the face does not specify any special value for the attribute. You can activate a checkbox to specify or unspecify its attribute. A face does not have to specify every single attribute; in fact, most faces only specify a few attributes. In the above example, font-lock-comment-face only specifies the foreground color. Any unspecified attribute is taken from the special face named default, whose attributes are all specified. The default face is the face used to display any text that does not have an explicitly-assigned face; furthermore, its background color attribute serves as the background color of the frame. The [Hide Unused Attributes] button, at the end of the attribute list, hides the unspecified attributes of the face. When attributes are being hidden, the button changes to [Show All Attributes], which reveals the entire attribute list. The customization buffer may start out with unspecified attributes hidden, to avoid cluttering the interface. When an attribute is specified, you can change its value in the usual ways. Foreground and background colors can be specified using either color names or RGB triplets (Colors). You can also use the [Choose] button to switch to a list of color names; select a color with RET in that buffer to put the color name in the value field. Setting, saving and resetting a face work like the same operations for variables (Changing a Variable). A face can specify different appearances for different types of displays. For example, a face can make text red on a color display, but use a bold font on a monochrome display. To specify multiple appearances for a face, select For All Kinds of Displays in the menu you get from invoking [State].

M-x customize-option RET option RET, M-x customize-variable RET option RET

Set up a customization buffer for just one user option, option.

M-x customize-face RET face RET

Set up a customization buffer for just one face, face.

M-x customize-icon RET face RET

Set up a customization buffer for just one icon, icon.

M-x customize-group RET group RET

Set up a customization buffer for just one group, group.

M-x customize-apropos RET regexp RET

Set up a customization buffer for all the settings and groups that match regexp.

M-x customize-changed RET version RET

Set up a customization buffer with all the user options, faces and groups whose meaning has changed since (or been added after) Emacs version version.

M-x customize-saved

Set up a customization buffer containing all settings that you have saved with customization buffers.

M-x customize-unsaved

Set up a customization buffer containing all settings that you have set but not saved.

If you want to customize a particular user option, type M-x customize-option. This reads the variable name, and sets up the customization buffer with just that one user option. When entering the variable name into the minibuffer, completion is available, but only for the names of variables that have been loaded into Emacs. Likewise, you can customize a specific face using M-x customize-face. You can set up a customization buffer for a specific customization group using M-x customize-group. M-x customize-apropos prompts for a search term—either one or more words separated by spaces, or a regular expression—and sets up a customization buffer for all loaded settings and groups with matching names. This is like using the search field at the top of the customization buffer (Customization Groups). When you upgrade to a new Emacs version, you might want to consider customizing new settings, and settings whose meanings or default values have changed. To do this, use M-x customize-changed and specify a previous Emacs version number using the minibuffer. It creates a customization buffer which shows all the settings and groups whose definitions have been changed since the specified version, loading them if necessary. If you change settings and then decide the change was a mistake, you can use two commands to revisit your changes. Use M-x customize-saved to customize settings that you have saved. Use M-x customize-unsaved to customize settings that you have set but not saved.

Custom themes are collections of settings that can be enabled or disabled as a unit. You can use Custom themes to switch easily between various collections of settings, and to transfer such collections from one computer to another. A Custom theme is stored as an Emacs Lisp source file. If the name of the Custom theme is name, the theme file is named name-theme.el. Creating Custom Themes, for the format of a theme file and how to make one. Type M-x customize-themes to switch to a buffer named *Custom Themes*, which lists the Custom themes that Emacs knows about. By default, Emacs looks for theme files in two locations: the directory specified by the variable custom-theme-directory (which defaults to ~/.emacs.d/), and a directory named etc/themes in your Emacs installation (see the variable data-directory). The latter contains several Custom themes distributed with Emacs that customize Emacs's faces to fit various color schemes. (Note, however, that Custom themes need not be restricted to this purpose; they can be used to customize variables too.) If you want Emacs to look for Custom themes in some other directory, add the directory to the list variable custom-theme-load-path. Its default value is (custom-theme-directory t); here, the symbol custom-theme-directory has the special meaning of the value of the variable custom-theme-directory, while t stands for the built-in theme directory etc/themes. The themes listed in the *Custom Themes* buffer are those found in the directories specified by custom-theme-load-path. In the *Custom Themes* buffer, you can activate the checkbox next to a Custom theme to enable or disable the theme for the current Emacs session. When a Custom theme is enabled, all of its settings (variables and faces) take effect in the Emacs session. To apply the choice of theme(s) to future Emacs sessions, type C-x C-s (custom-theme-save) or use the [Save Theme Settings] button. When you first enable a Custom theme, Emacs displays the contents of the theme file and asks if you really want to load it. Because loading a Custom theme can execute arbitrary Lisp code, you should only say yes if you know that the theme is safe; in that case, Emacs offers to remember in the future that the theme is safe (this is done by saving the theme file's SHA-256 hash to the variable custom-safe-themes; if you want to treat all themes as safe, change its value to t). Themes that come with Emacs (in the etc/themes directory) are exempt from this check, and are always considered safe. Setting or saving Custom themes actually works by customizing the variable custom-enabled-themes. The value of this variable is a list of Custom theme names (as Lisp symbols, e.g., tango). Instead of using the *Custom Themes* buffer to set custom-enabled-themes, you can customize the variable using the usual customization interface, e.g., with M-x customize-option. Note that Custom themes are not allowed to set custom-enabled-themes themselves. Any customizations that you make through the customization buffer take precedence over theme settings. This lets you easily override individual theme settings that you disagree with. If settings from two different themes overlap, the theme occurring earlier in custom-enabled-themes takes precedence. In the customization buffer, if a setting has been changed from its default by a Custom theme, its State display shows THEMED instead of STANDARD. You can enable a specific Custom theme in the current Emacs session by typing M-x load-theme. This prompts for a theme name, loads the theme from the theme file, and enables it. If a theme file has been loaded before, you can enable the theme without loading its file by typing M-x enable-theme. To disable a Custom theme, type M-x disable-theme. Some themes provide a set of user options (Newcomers Theme), that might vary over time. If you want to persist the current set of options, you can copy the user option of a theme into your own configuration, you can use the copy-theme-options command. To see a description of a Custom theme, type ? on its line in the *Custom Themes* buffer; or type M-x describe-theme anywhere in Emacs and enter the theme name. Some themes have variants (most often just two: light and dark). You can switch to another variant using M-x theme-choose-variant. If the currently active theme has only one other variant, it will be selected; if there are more variants, the command will prompt you which one to switch to. Note that theme-choose-variant only works if a single theme is active.

You can define a Custom theme using an interface similar to the customization buffer, by typing M-x customize-create-theme. This switches to a buffer named *Custom Theme*. It also offers to insert some common Emacs faces into the theme (a convenience, since Custom themes are often used to customize faces). If you answer no, the theme will initially contain no settings. Near the top of the *Custom Theme* buffer, there are editable fields where you can enter the theme's name and description. The name can be anything except user. The description is the one that will be shown when you invoke M-x describe-theme for the theme. Its first line should be a brief one-sentence summary; in the buffer made by M-x customize-themes, this sentence is displayed next to the theme name. To add a new setting to the theme, use the [Insert Additional Face] or [Insert Additional Variable] buttons. Each button reads a face or variable name using the minibuffer, with completion, and inserts a customization entry for the face or variable. You can edit the variable values or face attributes in the same way as in a normal customization buffer. To remove a face or variable from the theme, uncheck the checkbox next to its name. After specifying the Custom theme's faces and variables, type C-x C-s (custom-theme-write) or use the buffer's [Save Theme] button. This saves the theme file, named name-theme.el where name is the theme name, in the directory named by custom-theme-directory. From the *Custom Theme* buffer, you can view and edit an existing Custom theme by activating the [Visit Theme] button and specifying the theme name. You can also add the settings of another theme into the buffer, using the [Merge Theme] button. You can import your non-theme settings into a Custom theme by using the [Merge Theme] button and specifying the special theme named user. A theme file is simply an Emacs Lisp source file, and loading the Custom theme works by loading the Lisp file. Therefore, you can edit a theme file directly instead of using the *Custom Theme* buffer. Custom Themes, for details.

C-h v var RET

Display the value and documentation of variable var (describe-variable).

M-x set-variable RET var RET value RET

Change the value of variable var to value.

To examine the value of a variable, use C-h v (describe-variable). This reads a variable name using the minibuffer, with completion, and displays both the value and the documentation of the variable. For example,

C-h v fill-column @key{RET}

displays something like this:

fill-column is a variable defined in @quoteleft{}C source code@quoteright{}.
Its value is 70

  Automatically becomes buffer-local when set.
  This variable is safe as a file local variable if its value
  satisfies the predicate @quoteleft{}integerp@quoteright{}.
  Probably introduced at or before Emacs version 18.

Documentation:
Column beyond which automatic line-wrapping should happen.
Interactively, you can set the buffer local value using C-x f.

You can customize this variable.

The line that says You can customize the variable indicates that this variable is a user option. C-h v is not restricted to user options; it allows non-customizable variables too. The most convenient way to set a specific customizable variable is with M-x set-variable. This reads the variable name with the minibuffer (with completion), and then reads a Lisp expression for the new value using the minibuffer a second time (you can insert the old value into the minibuffer for editing via M-n). For example,

M-x set-variable @key{RET} fill-column @key{RET} 75 @key{RET}

sets fill-column to 75. M-x set-variable is limited to customizable variables, but you can set any variable with a Lisp expression like this:

(setq fill-column 75)

To execute such an expression, type M-: (eval-expression) and enter the expression in the minibuffer (Lisp Eval). Alternatively, go to the *scratch* buffer, type in the expression, and then type C-j (Lisp Interaction). Setting variables, like all means of customizing Emacs except where otherwise stated, affects only the current Emacs session. The only way to alter the variable in future sessions is to put something in your initialization file (Init File). If you're setting a customizable variable, and you don't want to use the Customize interface, you can use the setopt macro. For instance:

M-: (setopt fill-column 75) @key{RET}

Or, if you want to do this in your initialization file:

(setopt fill-column 75)

This works the same as setq, but if the variable has any special setter functions, they will be run automatically when using setopt. You can also use setopt on other, non-customizable variables, but this is less efficient than using setq. There is also a buffer-local version of setopt, called setopt-local, that you can use to set buffer specific values for customizable options, for example, in mode hooks (Hooks). This works the same as setq-local, but if the variable has any special setter functions, they will be run automatically when using setopt-local. You can also use setopt-local on other, non-customizable variables, but this is less efficient than using setq-local. If you want to change the value of a customizable variable only in your current buffer, you can use the setopt-local macro. For instance:

M-: (setopt-local fill-column 75) @key{RET}

Or, if you want to do this in your initialization file, use the following inside a mode hook so this variable will be automatically customized in buffers of that mode (Hooks):

(setopt-local fill-column 75)

Hooks are an important mechanism for customizing Emacs. A hook is a Lisp variable which holds a list of functions, to be called on some well-defined occasion. (This is called running the hook.) The individual functions in the list are called the hook functions of the hook. For example, the hook kill-emacs-hook runs just before exiting Emacs (Exiting). Most hooks are normal hooks. This means that when Emacs runs the hook, it calls each hook function in turn, with no arguments. We have made an effort to keep most hooks normal, so that you can use them in a uniform way. Every variable whose name ends in -hook is a normal hook. A few hooks are abnormal hooks. Their names end in -functions, instead of -hook (some old code may also use the deprecated suffix -hooks). What makes these hooks abnormal is the way its functions are called—perhaps they are given arguments, or perhaps the values they return are used in some way. For example, find-file-not-found-functions is abnormal because as soon as one hook function returns a non-nil value, the rest are not called at all (Visiting). The documentation of each abnormal hook variable explains how its functions are used. You can set a hook variable with setq like any other Lisp variable, but the recommended way to add a function to a hook (either normal or abnormal) is to use add-hook, as shown by the following examples. Hooks, for details. Most major modes run one or more mode hooks as the last step of initialization. Mode hooks are a convenient way to customize the behavior of individual modes; they are always normal. For example, here's how to set up a hook to turn on Auto Fill mode in Text mode and other modes based on Text mode:

(add-hook 'text-mode-hook 'auto-fill-mode)

This works by calling auto-fill-mode, which enables the minor mode when no argument is supplied (Minor Modes). Next, suppose you don't want Auto Fill mode turned on in LaTeX mode, which is one of the modes based on Text mode. You can do this with the following additional line:

(add-hook 'latex-mode-hook (lambda () (auto-fill-mode -1)))

Here we have used the special macro lambda to construct an anonymous function (Lambda Expressions), which calls auto-fill-mode with an argument of -1 to disable the minor mode. Because LaTeX mode runs latex-mode-hook after running text-mode-hook, the result leaves Auto Fill mode disabled. Here is a more complex example, showing how to use a hook to customize the indentation of C code:

(setq my-c-style
  '((c-comment-only-line-offset . 4)
    (c-cleanup-list . (scope-operator
                       empty-defun-braces
                       defun-close-semi))))

(add-hook 'c-mode-common-hook
  (lambda () (c-add-style "my-style" my-c-style t)))

Major mode hooks also apply to other major modes derived from the original mode (Derived Modes). For instance, HTML mode is derived from Text mode (HTML Mode); when HTML mode is enabled, it runs text-mode-hook before running html-mode-hook. This provides a convenient way to use a single hook to affect several related modes. In particular, if you want to apply a hook function to any programming language mode, add it to prog-mode-hook; Prog mode is a major mode that does little else than to let other major modes inherit from it, exactly for this purpose. It is best to design your hook functions so that the order in which they are executed does not matter. Any dependence on the order is asking for trouble. However, the order is predictable: the hook functions are executed in the order they appear in the hook. If you play with adding various different versions of a hook function by calling add-hook over and over, remember that all the versions you added will remain in the hook variable together. You can clear out individual functions by calling remove-hook, or do (setq hook-variable nil) to remove everything. If the hook variable is buffer-local, the buffer-local variable will be used instead of the global variable. However, if the buffer-local variable contains the element t, the global hook variable will be run as well.

M-x make-local-variable RET var RET

Make variable var have a local value in the current buffer.

M-x kill-local-variable RET var RET

Make variable var use its global value in the current buffer.

M-x make-variable-buffer-local RET var RET

Mark variable var so that setting it will make it local to the buffer that is current at that time.

Almost any variable can be made local to a specific Emacs buffer. This means that its value in that buffer is independent of its value in other buffers. A few variables are always local in every buffer. Every other Emacs variable has a global value which is in effect in all buffers that have not made the variable local. M-x make-local-variable reads the name of a variable and makes it local to the current buffer. Changing its value subsequently in this buffer will not affect others, and changes in its global value will not affect this buffer. M-x make-variable-buffer-local marks a variable so it will become local automatically whenever it is set. More precisely, once a variable has been marked in this way, the usual ways of setting the variable automatically do make-local-variable first. We call such variables per-buffer variables. Many variables in Emacs are normally per-buffer; the variable's document string tells you when this is so. A per-buffer variable's global value is normally never effective in any buffer, but it still has a meaning: it is the initial value of the variable for each new buffer. Major modes (Major Modes) always make variables local to the buffer before setting the variables. This is why changing major modes in one buffer has no effect on other buffers. Minor modes also work by setting variables—normally, each minor mode has one controlling variable which is non-nil when the mode is enabled (Minor Modes). For many minor modes, the controlling variable is per buffer, and thus always buffer-local. Otherwise, you can make it local in a specific buffer like any other variable. A few variables cannot be local to a buffer because they are always local to each display instead (Multiple Displays). If you try to make one of these variables buffer-local, you'll get an error message. M-x kill-local-variable makes a specified variable cease to be local to the current buffer. The global value of the variable henceforth is in effect in this buffer. Setting the major mode kills all the local variables of the buffer except for a few variables specially marked as permanent locals. To set the global value of a variable, regardless of whether the variable has a local value in the current buffer, you can use the Lisp construct setq-default. This construct is used just like setq, but it sets variables' global values instead of their local values (if any). When the current buffer does have a local value, the new global value may not be visible until you switch to another buffer. Here is an example:

(setq-default fill-column 75)

setq-default is the only way to set the global value of a variable that has been marked with make-variable-buffer-local. Lisp programs can use default-value to look at a variable's default value. This function takes a symbol as argument and returns its default value. The argument is evaluated; usually you must quote it explicitly. For example, here's how to obtain the default value of fill-column:

(default-value 'fill-column)

A file can specify local variable values to use when editing the file with Emacs. Visiting the file or setting a major mode checks for local variable specifications; it automatically makes these variables local to the buffer, and sets them to the values specified in the file. There are two ways to set file local variables: in the first line, or with a local variables list near the end of the file. If a file has local variables in both a local variables list and in line one, Emacs processes everything in line one first, and everything in the local variables list afterward. The exception to this is a major mode specification. Emacs applies this first, wherever it appears, since most major modes kill all local variables as part of their initialization. File local variables override directory local variables (Directory Variables), if any are specified for a file's directory.

-*- mode: @var{modename}; @var{var}: @var{value}; @dots{} -*-

;; -*- mode: Lisp; fill-column: 75; comment-column: 50; -*-

/* Local Variables:  */
/* mode: c           */
/* comment-column: 0 */
/* End:              */

# Local Variables:
# compile-command: "cc foo.c -Dfoo=bar -Dhack=whatever \
#   -Dmumble=blaah"
# End:

-*- mode: my-old; mode: my-new -*-

Local variables:
mode: my-old
mode: my-new

;; Local Variables:
;; eval: (eldoc-mode)
;; eval: (font-lock-mode -1)
;; End:

Sometimes, you may wish to define the same set of local variables to all the files in a certain directory and its subdirectories, such as the directory tree of a large software project. This can be accomplished with directory-local variables. File local variables override directory local variables, so if some of the files in a directory need specialized settings, you can specify the settings for the majority of the directory's files in directory variables, and then define file local variables in a few files which need the general settings overridden. The usual way to define directory-local variables is to put a file named .dir-locals.el=(On MS-DOS) in a directory. Whenever Emacs visits any file in that directory or any of its subdirectories, it will apply the directory-local variables specified in =.dir-locals.el, as though they had been defined as file-local variables for that file (File Variables). Emacs searches for .dir-locals.el starting in the directory of the visited file, and moving up the directory tree. To avoid slowdown, this search is skipped for remote files. If needed, the search can be extended for remote files by setting the variable enable-remote-dir-locals to t. You can also use .dir-locals-2.el; if found in the same directory as .dir-locals.el, Emacs loads it in addition to .dir-locals.el. This is useful when .dir-locals.el is under version control in a shared repository and can't be used for personal customizations. The .dir-locals.el file should hold a specially-constructed list, which maps major mode names (symbols) to alists (Association Lists). Each alist entry consists of a variable name and the directory-local value to assign to that variable, when the specified major mode is enabled. Instead of a mode name, you can specify nil, which means that the alist applies to any mode; or you can specify a subdirectory (a string), in which case the alist applies to all files in that subdirectory. Here's an example of a .dir-locals.el file:

((nil . ((indent-tabs-mode . t)
         (fill-column . 80)
         (mode . auto-fill)))
 (c-mode . ((c-file-style . "BSD")
            (subdirs . nil)))
 ("src/imported"
  . ((nil . ((change-log-default-name
              . "ChangeLog.local"))))))

This sets the variables indent-tabs-mode and fill-column for any file in the directory tree, and the indentation style for any C source file. The special mode element specifies the minor mode to be enabled. So (mode . auto-fill) specifies that the minor mode auto-fill-mode needs to be enabled. The special subdirs element is not a variable, but a special keyword which indicates that the C mode settings are only to be applied in the current directory, not in any subdirectories. Finally, it specifies a different ChangeLog file name for any file in the src/imported subdirectory. If the .dir-locals.el file contains multiple different values for a variable using different mode names or directories, the values will be applied in an order such that the values for more specific modes take priority over more generic modes. Values specified under a directory have even more priority. For example:

((nil . ((fill-column . 40)))
 (c-mode . ((fill-column . 50)))
 (prog-mode . ((fill-column . 60)))
 ("narrow-files" . ((nil . ((fill-column . 20))))))

Files that use c-mode also match prog-mode because the former inherits from the latter. The value used for fill-column in C files will however be 50 because the mode name is more specific than prog-mode. Files using other modes inheriting from prog-mode will use 60. Any file under the directory narrow-files will use the value 20 even if they use c-mode because directory entries have priority over mode entries. You can specify the variables mode, eval, and unibyte in your .dir-locals.el, and they have the same meanings as they would have in file local variables. coding cannot be specified as a directory local variable. File Variables. The special key auto-mode-alist in a .dir-locals.el lets you set a file's major mode. It works much like the variable auto-mode-alist (Choosing Modes). For example, here is how you can tell Emacs that .def source files in this directory should be in C mode:

((auto-mode-alist . (("\\.def\\'" . c-mode))))

Instead of editing the .dir-locals.el file by hand, you can use the command M-x add-dir-local-variable. This prompts for a mode or subdirectory, and for variable and value, and adds the entry defining the directory-local variable. M-x delete-dir-local-variable deletes an entry. M-x copy-file-locals-to-dir-locals copies the file-local variables in the current file into .dir-locals.el, or .dir-locals-2.el if that file is also present. With a prefix argument, all three commands prompt for the file you want to modify. Although it doesn't have to exist, you must enter a valid filename, either .dir-locals.el or .dir-locals-2.el. There's also a command to pop up an Easy Customization buffer (Easy Customization) to edit directory local variables, customize-dirlocals. Another method of specifying directory-local variables is to define a group of variables/value pairs in a directory class, using the dir-locals-set-class-variables function; then, tell Emacs which directories correspond to the class by using the dir-locals-set-directory-class function. These function calls normally go in your initialization file (Init File). This method is useful when you can't put .dir-locals.el in a directory for some reason. For example, you could apply settings to an unwritable directory this way:

(dir-locals-set-class-variables 'unwritable-directory
   '((nil . ((some-useful-setting . value)))))

(dir-locals-set-directory-class
   "/usr/include/" 'unwritable-directory)

If a variable has both a directory-local and file-local value specified, the file-local value takes effect. Unsafe directory-local variables are handled in the same way as unsafe file-local variables (Safe File Variables). Directory-local variables also take effect in certain buffers that do not visit a file directly but perform work within a directory, such as Dired buffers (Dired).

Most of the variables reflect the situation on the local machine. Often, they must use a different value when you operate in buffers with a remote default directory. Think about the behavior when calling shell — on your local machine, you might use /bin/bash and rely on termcap, but on a remote machine, it may be /bin/ksh and terminfo. This can be accomplished with connection-local variables. Such variables are declared depending on the value of default-directory of the current buffer. When a buffer has a remote default-directory, and there exist a connection-local variable which matches default-directory, this alternative value of the variable is used. Directory and file local variables override connection-local variables. Unsafe connection-local variables are handled in the same way as unsafe file-local variables (Safe File Variables). Connection-local variables are declared as a group of variables/value pairs in a profile, using the connection-local-set-profile-variables function. The function connection-local-set-profiles declares profiles for a given criteria (the first argument), identifying a remote machine with respect to default-directory of the current buffer:

(connection-local-set-profile-variables 'remote-terminfo
   '((system-uses-terminfo . t)
     (comint-terminfo-terminal . "dumb-emacs-ansi")))

(connection-local-set-profile-variables 'remote-ksh
   '((shell-file-name . "/bin/ksh")
     (shell-command-switch . "-c")))

(connection-local-set-profile-variables 'remote-bash
   '((shell-file-name . "/bin/bash")
     (shell-command-switch . "-c")))

(connection-local-set-profiles
   '(:application tramp :machine "remotemachine")
   'remote-terminfo 'remote-ksh)

This code declares three different profiles, remote-terminfo, remote-ksh, and remote-bash. The profiles remote-terminfo and remote-ksh are applied to all buffers which have a remote default-directory matching the string "remotemachine" as host name. Criteria, the first argument of connection-local-set-profiles, specifies, how the profiles match default-directory. It is a plist identifying a connection and the application using this connection. Property names might be :application, :protocol, :user and :machine. The property value of :application is a symbol, all other property values are strings. In general the symbol tramp should be used as :application value. Some packages use a different :application (for example eshell or vc-git); they say it in their documentation then. All properties are optional. The other properties are used for checking default-directory. The propertiy :protocol is used for the method a remote default-directory uses, the property :user is the remote user name, and the property :machine is the remote host name. All checks are performed via string-equal. The nil criteria matches all buffers with a remote default directory. Connection-local variables are not activated by default. A package which uses connection-local variables must activate them for a given buffer, specifying for which :application it uses them. Applying Connection Local Variables, for details. After the above definition of profiles and their activation, any connection made by Tramp to the remotemachine system will use

• t as the connection-specific value of system-uses-terminfo,
• dumb-emacs-ansi as the connection-specific value of comint-terminfo-terminal,
• /bin/ksh as the connection-specific value of as shell-file-name,
• -c as the connection-specific value of shell-command-switch.

Be careful when declaring different profiles with the same variable, and setting these profiles to criteria which could match in parallel. It is unspecified which variable value is used then. Be also careful when setting connection-local variables in a buffer, which changes its major mode afterwards. Because all buffer-local variables will be killed when changing the major mode, the connection-local variable's value would be lost. You can prevent this by setting the respective variable's permanent-local symbol property to non-nil.

As described in Commands, each Emacs command is a Lisp function whose definition provides for interactive use. Like every Lisp function, a command has a function name, which usually consists of lower-case letters and hyphens. A key sequence (key, for short) is a sequence of input events that have a meaning as a unit. Input events include characters, function keys, and mouse buttons—all the inputs that you can send to the computer. A key sequence gets its meaning from its binding, which says what command it runs. The bindings between key sequences and command functions are recorded in data structures called keymaps. Emacs has many of these, each used on particular occasions. The global keymap is the most important keymap because it is always in effect. The global keymap defines keys for Fundamental mode (Major Modes); most of these definitions are common to most or all major modes. Each major or minor mode can have its own keymap which overrides the global definitions of some keys. For example, a self-inserting character such as g is self-inserting because the global keymap binds it to the command self-insert-command. The standard Emacs editing characters such as C-a also get their standard meanings from the global keymap. Commands to rebind keys, such as M-x keymap-global-set, work by storing the new binding in the proper place in the global map (Rebinding). To view the current key bindings, use the C-h b command. Most modern keyboards have function keys as well as character keys. Function keys send input events just as character keys do, and keymaps can have bindings for them. Key sequences can mix function keys and characters. For example, if your keyboard has a Home function key, Emacs can recognize key sequences like C-x Home. You can even mix mouse events with keyboard events, such as S-down-mouse-1. On text terminals, typing a function key actually sends the computer a sequence of characters; the precise details of the sequence depend on the function key and on the terminal type. (Often the sequence starts with ESC [.) If Emacs understands your terminal type properly, it automatically handles such sequences as single input events. Key sequences that consist of C-c followed by a letter (upper or lower case; ASCII or non-ASCII) are reserved for users. Emacs itself will never bind those key sequences, and Emacs extensions should avoid binding them. In other words, users can bind key sequences like C-c a or C-c @ and rely on these never being shadowed by other Emacs bindings.

Internally, Emacs records only single events in each keymap. Interpreting a key sequence of multiple events involves a chain of keymaps: the first keymap gives a definition for the first event, which is another keymap, which is used to look up the second event in the sequence, and so on. Thus, a prefix key such as C-x or ESC has its own keymap, which holds the definition for the event that immediately follows that prefix. The definition of a prefix key is usually the keymap to use for looking up the following event. The definition can also be a Lisp symbol whose function definition is the following keymap; the effect is the same, but it provides a command name for the prefix key that can be used as a description of what the prefix key is for. Thus, the binding of C-x is the symbol Control-X-prefix, whose function definition is the keymap for C-x commands. The definitions of C-c, C-x, C-h, and ESC as prefix keys appear in the global map, so these prefix keys are always available. Aside from ordinary prefix keys, there is a fictitious "prefix key" which represents the menu bar; see Menu Bar, for special information about menu bar key bindings. Mouse button events that invoke pop-up menus are also prefix keys; see Menu Keymaps, for more details. Some prefix keymaps are stored in variables with names:

• ctl-x-map is the variable name for the map used for characters that follow C-x.
• help-map is for characters that follow C-h.
• esc-map is for characters that follow ESC. Thus, all Meta characters are actually defined by this map.
• ctl-x-4-map is for characters that follow C-x 4.
• mode-specific-map is for characters that follow C-c.
• project-prefix-map is for characters that follow C-x p, used for project-related commands (Projects).

So far, we have explained the ins and outs of the global map. Major modes customize Emacs by providing their own key bindings in local keymaps. For example, C mode overrides TAB to make it indent the current line for C code. Minor modes can also have local keymaps; whenever a minor mode is in effect, the definitions in its keymap override both the major mode's local keymap and the global keymap. In addition, portions of text in the buffer can specify their own keymaps, which override all other keymaps. A local keymap can redefine a key as a prefix key by defining it as a prefix keymap. If the key is also defined globally as a prefix, its local and global definitions (both keymaps) effectively combine: both definitions are used to look up the event that follows the prefix key. For example, if a local keymap defines C-c as a prefix keymap, and that keymap defines C-z as a command, this provides a local meaning for C-c C-z. This does not affect other sequences that start with C-c; if those sequences don't have their own local bindings, their global bindings remain in effect. Another way to think of this is that Emacs handles a multi-event key sequence by looking in several keymaps, one by one, for a binding of the whole key sequence. First it checks the minor mode keymaps for minor modes that are enabled, then it checks the major mode's keymap, and then it checks the global keymap. This is not precisely how key lookup works, but it's good enough for understanding the results in ordinary circumstances.

The minibuffer has its own set of local keymaps; they contain various completion and exit commands.

• minibuffer-local-map is used for ordinary input (no completion).
• minibuffer-local-ns-map is similar, except that SPC exits just like RET.
• minibuffer-local-completion-map is for permissive completion.
• minibuffer-local-must-match-map is for strict completion and for cautious completion.
• minibuffer-local-filename-completion-map is like the two previous ones, but specifically for file name completion. It does not bind SPC.

By default, TAB, SPC and ? do completion in minibuffer-local-completion-map. If you commonly complete over collections that have elements with space or question mark characters in them, it may be convenient to disable completion on those keys by putting this in your init file:

(keymap-set minibuffer-local-completion-map "SPC" 'self-insert-command)
(keymap-set minibuffer-local-completion-map "?" 'self-insert-command)

The way to redefine an Emacs key is to change its entry in a keymap. You can change the global keymap, in which case the change is effective in all major modes (except those that have their own overriding local bindings for the same key). Or you can change a local keymap, which affects all buffers using the same major mode. In this section, we describe how to rebind keys for the present Emacs session. Init Rebinding, for a description of how to make key rebindings affect future Emacs sessions.

M-x keymap-global-set RET key cmd RET

Define key globally to run cmd.

M-x keymap-local-set RET key cmd RET

Define key locally (in the major mode now in effect) to run cmd.

M-x keymap-global-unset RET key

Make key undefined in the global map.

M-x keymap-local-unset RET key

Make key undefined locally (in the major mode now in effect).

For example, the following binds C-z to the shell command (Interactive Shell), replacing the normal global definition of C-z:

M-x keymap-global-set @key{RET} C-z shell @key{RET}

The keymap-global-set command reads the command name after the key. After you press the key, a message like this appears so that you can confirm that you are binding the key you want:

Set key C-z to command:

You can redefine function keys and mouse events in the same way; just type the function key or click the mouse when it's time to specify the key to rebind. You can rebind a key that contains more than one event in the same way. Emacs keeps reading the key to rebind until it is a complete key (that is, not a prefix key). Thus, if you type C-f for key, that's the end; it enters the minibuffer immediately to read cmd. But if you type C-x, since that's a prefix, it reads another character; if that is 4, another prefix character, it reads one more character, and so on. For example,

M-x keymap-global-set @key{RET} C-x 4 $ spell-other-window @key{RET}

redefines C-x 4 $ to run the (fictitious) command spell-other-window. You can remove the global definition of a key with keymap-global-unset. This makes the key undefined; if you type it, Emacs will just beep. Similarly, keymap-local-unset makes a key undefined in the current major mode keymap, which makes the global definition (or lack of one) come back into effect in that major mode. If you have redefined (or undefined) a key and you subsequently wish to retract the change, undefining the key will not do the job—you need to redefine the key with its standard definition. To find the name of the standard definition of a key, go to a Fundamental mode buffer in a fresh Emacs and use C-h c. The documentation of keys in this manual also lists their command names. If you want to prevent yourself from invoking a command by mistake, it is better to disable the command than to undefine the key. A disabled command is less work to invoke when you really want to. Disabling.

If you have a set of key bindings that you like to use all the time, you can specify them in your initialization file by writing Lisp code. Init File, for a description of the initialization file. The recommended way to write a key binding using Lisp is to use either the keymap-global-set or the keymap-set functions. For example, here's how to bind C-z to the shell command in the global keymap (Interactive Shell):

(keymap-global-set "C-z" 'shell)

The first argument to keymap-global-set describes the key sequence. It is a string made of a series of characters separated by spaces, with each character corresponding to a key. Keys with modifiers can be specified by prepending the modifier, such as C- for Control, or M- for Meta. Special keys, such as TAB and RET, can be specified within angle brackets as in TAB and RET. The single-quote before the command name that is being bound to the key sequence, shell in the above example, marks it as a constant symbol rather than a variable. If you omit the quote, Emacs would try to evaluate shell as a variable. This will probably cause an error; it certainly isn't what you want. Here are some additional examples, including binding function keys and mouse events:

(keymap-global-set "C-c y" 'clipboard-yank)
(keymap-global-set "C-M-q" 'query-replace)
(keymap-global-set "<f5>" 'flyspell-mode)
(keymap-global-set "C-<f5>" 'display-line-numbers-mode)
(keymap-global-set "C-<right>" 'forward-sentence)
(keymap-global-set "<mouse-2>" 'mouse-save-then-kill)

Key sequences can also be bound directly to Lisp strings rather than commands. Such strings are written using the same syntax as key sequences. For example, to bind C-c h to the string hello:

(keymap-global-set "C-c h" "h e l l o")

Since this is somewhat cumbersome to write, the convenience function key-description can be used instead:

(keymap-global-set "C-c h" (key-description "hello"))

Non-ASCII characters can be specified directly in the string. To bind to, for example, ol@'a, use:

(keymap-global-set "C-c h" (key-description "ol@'a"))

However, be aware that language and coding systems may cause problems with key bindings for non-ASCII characters (Init Non-ASCII). Writing the binding directly with the Unicode codepoint avoids these problems (International Chars for how to determine the codepoint of a character from within Emacs):

(keymap-global-set "C-c h" (key-description "ol\u00E1"))

Alternatively, you can use the low level functions define-key and global-set-key. For example, to bind C-z to the shell command, as in the above example, using these low-level functions, use:

(global-set-key (kbd "C-z") 'shell)

There are various ways to specify the key sequence but the simplest is to use the function kbd as shown in the example above. kbd takes a single string argument that is a textual representation of a key sequence, and converts it into a form suitable for low-level functions such as global-set-key. For more details about binding keys using Lisp, Keymaps. As described in Local Keymaps, major modes and minor modes can define local keymaps. These keymaps are constructed when the mode is loaded for the first time in a session. The function keymap-set can be used to make changes in a specific keymap. To remove a key binding, use keymap-unset. Since a mode's keymaps are not constructed until it has been loaded, you must delay running code which modifies them, e.g., by putting it on a mode hook (Hooks). For example, Texinfo mode runs the hook texinfo-mode-hook. Here's how you can use the hook to add local bindings for C-c n and C-c p, and remove the one for C-c C-x x in Texinfo mode:

(add-hook 'texinfo-mode-hook
          (lambda ()
            (keymap-set texinfo-mode-map "C-c p"
                        'backward-paragraph)
            (keymap-set texinfo-mode-map "C-c n"
                        'forward-paragraph)
            (keymap-set texinfo-mode-map "C-c C-x x" nil)))

The default key bindings in Emacs are set up so that modified alphabetical characters are case-insensitive. In other words, C-A does the same thing as C-a, and M-A does the same thing as M-a. This concerns only alphabetical characters, and does not apply to shifted versions of other keys; for instance, C-@@ is not the same as C-2. A Control-modified alphabetical character is generally considered case-insensitive: Emacs always treats C-A as C-a, C-B as C-b, and so forth. The reason for this is historical: In non-graphical environments there is no distinction between those keystrokes. However, you can bind shifted Control alphabetical keystrokes in GUI frames:

(keymap-global-set "C-S-n" #'previous-line)

For all other modifiers, you can make the modified alphabetical characters case-sensitive (even on non-graphical frames) when you customize Emacs. For instance, you could make M-a and M-A run different commands. Although only the Control and Meta modifier keys are commonly used, Emacs supports three other modifier keys. These are called Super, Hyper, and Alt. Few terminals provide ways to use these modifiers; the key labeled Alt on most keyboards usually issues the Meta modifier, not Alt. The standard key bindings in Emacs do not include any characters with the Super and Hyper modifiers, and only a small number of standard key bindings use Alt. However, you can customize Emacs to assign meanings to key bindings that use these modifiers. The modifier bits are labeled as s-, H- and A- respectively. Even if your keyboard lacks these additional modifier keys, you can enter them using C-x @@: C-x @@ h adds the Hyper flag to the next character, C-x @@ s adds the Super flag, and C-x @@ a adds the Alt flag. For instance, C-x @@ h C-a is a way to enter Hyper-Control-a. (Unfortunately, there is no way to add two modifiers by using C-x @@ twice for the same character, because the first one goes to work on the C-x.) You can similarly enter the Shift, Control, and Meta modifiers by using C-x @@ S, C-x @@ c, and C-x @@ m, respectively, although this is rarely needed. On graphical terminals, you can enable the Modifier Bar mode, which allows simulating the missing modifier keys by clicking a tool-bar button. Tool Bars.

Key sequences can contain function keys as well as ordinary characters. Just as Lisp characters (actually integers) represent keyboard characters, Lisp symbols represent function keys. If the function key has a word as its label, then that word is also the name of the corresponding Lisp symbol. Here are the conventional Lisp names for common function keys:

left, up, right, down

Cursor arrow keys.

begin, end, home, next, prior

Other cursor repositioning keys.

select, print, execute, backtab, insert, undo, redo, clearline, insertline, deleteline, insertchar, deletechar

Miscellaneous function keys.

f1, f2, … f35

Numbered function keys (across the top of the keyboard).

kp-add, kp-subtract, kp-multiply, kp-divide, kp-backtab, kp-space, kp-tab, kp-enter, kp-separator, kp-decimal, kp-equal, kp-prior, kp-next, kp-end, kp-home, kp-left, kp-up, kp-right, kp-down, kp-insert, kp-delete

Keypad keys (to the right of the regular keyboard), with names or punctuation.

kp-0, kp-1, … kp-9

Keypad keys with digits.

kp-f1, kp-f2, kp-f3, kp-f4

Keypad PF keys.

These names are conventional, but some systems (especially when using X) may use different names. To make certain what symbol is used for a given function key on your terminal, type C-h c followed by that key. Init Rebinding, for examples of binding function keys. Many keyboards have a numeric keypad on the right-hand side. The numeric keys in the keypad double up as cursor motion keys, toggled by a key labeled Num Lock. By default, Emacs translates these keys to the corresponding keys on the main keyboard. For example, when Num Lock is on, the key labeled 8 on the numeric keypad produces kp-8, which is translated to 8; when Num Lock is off, the same key produces kp-up, which is translated to UP. If you rebind a key such as 8 or UP, it affects the equivalent keypad key too. However, if you rebind a kp- key directly, that won't affect its non-keypad equivalent. Note that the modified keys are not translated: for instance, if you hold down the Meta key while pressing the 8 key on the numeric keypad, that generates M-kp-8. Emacs provides a convenient method for binding the numeric keypad keys, using the variables keypad-setup, keypad-numlock-setup, keypad-shifted-setup, and keypad-numlock-shifted-setup. These can be found in the keyboard customization group (Easy Customization). You can rebind the keys to perform other tasks, such as issuing numeric prefix arguments.

TAB, RET, BS, LFD, ESC, and DEL started out as names for certain ASCII control characters, used so often that they have special keys of their own. For instance, TAB was another name for C-i. Later, users found it convenient to distinguish in Emacs between these keys and the corresponding control characters typed with the Ctrl key. Therefore, on most modern terminals, they are no longer the same: TAB is different from C-i. Emacs can distinguish these two kinds of input if the keyboard does. It treats the special keys as function keys named tab, return, backspace, linefeed, escape, and delete. These function keys translate automatically into the corresponding ASCII characters if they have no bindings of their own. As a result, neither users nor Lisp programs need to pay attention to the distinction unless they care to. If you do not want to distinguish between (for example) TAB and C-i, make just one binding, for the ASCII character TAB (octal code 011). If you do want to distinguish, make one binding for this ASCII character, and another for the function key tab. With an ordinary ASCII terminal, there is no way to distinguish between TAB and C-i (and likewise for other such pairs), because the terminal sends the same character in both cases.

Emacs uses Lisp symbols to designate mouse buttons, too. The ordinary mouse events in Emacs are click events; these happen when you press a button and release it without moving the mouse. You can also get drag events, when you move the mouse while holding the button down. Drag events happen when you finally let go of the button. The symbols for basic click events are mouse-1 for the leftmost button, mouse-2 for the next, and so on. Here is how you can redefine the second mouse button to split the current window:

(keymap-global-set "<mouse-2>" 'split-window-below)

The symbols for drag events are similar, but have the prefix drag- before the word mouse. For example, dragging the first button generates a drag-mouse-1 event. You can also define bindings for events that occur when a mouse button is pressed down. These events start with down- instead of drag-. Such events are generated only if they have key bindings. When you get a button-down event, a corresponding click or drag event will always follow. If you wish, you can distinguish single, double, and triple clicks. A double click means clicking a mouse button twice in approximately the same place. The first click generates an ordinary click event. The second click, if it comes soon enough, generates a double-click event instead. The event type for a double-click event starts with double-: for example, double-mouse-3. This means that you can give a special meaning to the second click at the same place, but it must act on the assumption that the ordinary single click definition has run when the first click was received. This constrains what you can do with double clicks, but user interface designers say that this constraint ought to be followed in any case. A double click should do something similar to the single click, only more so. The command for the double-click event should perform the extra work for the double click. If a double-click event has no binding, it changes to the corresponding single-click event. Thus, if you don't define a particular double click specially, it executes the single-click command twice. Emacs also supports triple-click events whose names start with triple-. Emacs does not distinguish quadruple clicks as event types; clicks beyond the third generate additional triple-click events. However, the full number of clicks is recorded in the event list, so if you know Emacs Lisp you can distinguish if you really want to (Click Events). We don't recommend distinct meanings for more than three clicks, but sometimes it is useful for subsequent clicks to cycle through the same set of three meanings, so that four clicks are equivalent to one click, five are equivalent to two, and six are equivalent to three. Emacs also records multiple presses in drag and button-down events. For example, when you press a button twice, then move the mouse while holding the button, Emacs gets a double-drag- event. And at the moment when you press it down for the second time, Emacs gets a double-down- event (which is ignored, like all button-down events, if it has no binding). The variable double-click-time specifies how much time can elapse between clicks and still allow them to be grouped as a multiple click. Its value is in units of milliseconds. If the value is nil, double clicks are not detected at all. If the value is t, then there is no time limit. The default is 500. The variable double-click-fuzz specifies how much the mouse can move between clicks and still allow them to be grouped as a multiple click. Its value is in units of pixels on windowed displays and in units of 1/8 of a character cell on text-mode terminals; the default is 3. The symbols for mouse events also indicate the status of the modifier keys, with the usual prefixes C-, M-, H-, s-, A-, and S-. These always precede double- or triple-, which always precede drag- or down-. A frame includes areas that don't show text from the buffer, such as the mode line and the scroll bar. You can tell whether a mouse button comes from a special area of the screen by means of dummy prefix keys. For example, if you click the mouse in the mode line, you get the prefix key mode-line before the ordinary mouse-button symbol. Thus, here is how to define the command for clicking the first button in a mode line to run scroll-up-command:

(keymap-global-set "<mode-line> <mouse-1>" 'scroll-up-command)

Here is the complete list of these dummy prefix keys and their meanings:

mode-line

The mouse was in the mode line of a window.

vertical-line

The mouse was in the vertical line separating side-by-side windows. (If you use scroll bars, they appear in place of these vertical lines.)

vertical-scroll-bar

The mouse was in a vertical scroll bar. (This is the only kind of scroll bar Emacs currently supports.)

menu-bar

The mouse was in the menu bar.

tab-bar

The mouse was in a tab bar.

tab-line

The mouse was in a tab line.

header-line

The mouse was in a header line.

You can put more than one mouse button in a key sequence, but it isn't usual to do so.

Disabling a command means that invoking it interactively asks for confirmation from the user. The purpose of disabling a command is to prevent users from executing it by accident; we do this for commands that might be confusing to the uninitiated. Attempting to invoke a disabled command interactively in Emacs displays a window containing the command's name, its documentation, and some instructions on what to do immediately; then Emacs asks for input saying whether to execute the command as requested, enable it and execute it, or cancel. If you decide to enable the command, you must then answer another question—whether to do this permanently, or just for the current session. (Enabling permanently works by automatically editing your initialization file.) You can also type ! to enable all commands, for the current session only. The direct mechanism for disabling a command is to put a non-nil disabled property on the Lisp symbol for the command. Here is the Lisp program to do this:

(put 'delete-region 'disabled t)

If the value of the disabled property is a string, that string is included in the message displayed when the command is used:

(put 'delete-region 'disabled
     "It's better to use `kill-region' instead.\n")

As a less heavy-handed alternative to disabling commands, you may want to be queried before executing a command. For instance, to be queried before executing the M-> (end-of-buffer) command, you could put something like the following in your init file:

(command-query
 'end-of-buffer
 "Do you really want to go to the end of the buffer?")

By default, you'll be queried with a y=/=n question, but if you give a non-nil value to the third, optional argument, you'll be queried with yes=/=no instead. You can make a command disabled either by editing the initialization file directly, or with the command M-x disable-command, which edits the initialization file for you. Likewise, M-x enable-command edits the initialization file to enable a command permanently. Init File. If Emacs was invoked with the -q or --no-init-file options (Initial Options), it will not edit your initialization file. Doing so could lose information because Emacs has not read your initialization file. Whether a command is disabled is independent of what key is used to invoke it; disabling also applies if the command is invoked using M-x. However, disabling a command has no effect on calling it as a function from Lisp programs.

The init file contains one or more Lisp expressions. Each of these consists of a function name followed by arguments, all surrounded by parentheses. For example, (setq fill-column 60) calls the function setq to set the variable fill-column (Filling) to 60. You can set any Lisp variable with setq, but with certain variables setq won't do what you probably want in the init file. Some variables automatically become buffer-local when set with setq; what you want in the init file is to set the default value, using setq-default. (The following section has examples of both of these methods.) Some customizable minor mode variables do special things to enable the mode when you set them with Customize, but ordinary setq won't do that; to enable the mode in your init file, call the minor mode command. Finally, a few customizable user options are initialized in complex ways, and these have to be set either via the customize interface (Customization), or by using customize-set-variable=/=setopt (Examining). The second argument to setq is an expression for the new value of the variable. This can be a constant, a variable, or a function call expression. In the init file, constants are used most of the time. They can be:

Numbers:

Numbers are written in decimal, with an optional initial minus sign.

Strings:

Lisp string syntax is the same as C string syntax with a few extra features. Use a double-quote character to begin and end a string constant. In a string, you can include newlines and special characters literally. But often it is cleaner to use backslash sequences for them: \n for newline, \b for backspace, \r for carriage return, \t for tab, \f for formfeed (control-L), \e for escape, \\ for a backslash, \" for a double-quote, or \/ooo/ for the character whose octal code is ooo. Backslash and double-quote are the only characters for which backslash sequences are mandatory. \C- can be used as a prefix for a control character, as in \C-s for ASCII control-S, and \M- can be used as a prefix for a Meta character, as in \M-a for Meta-A or \M-\C-a for Ctrl-Meta-A. Init Non-ASCII, for information about including non-ASCII in your init file.

Characters:

Lisp character constant syntax consists of a ? followed by either a character or an escape sequence starting with \. Examples: ?x, ?\n, ?\", ?\). Note that strings and characters are not interchangeable in Lisp; some contexts require one and some contexts require the other. Init Non-ASCII, for information about binding commands to keys which send non-ASCII characters.

True:

t stands for "true".

False:

nil stands for "false".

Other Lisp objects:

Write a single-quote (') followed by the Lisp object you want.

For more information on the Emacs Lisp syntax, Introduction.

Here are some examples of doing certain commonly desired things with Lisp expressions:

• Add a directory to the variable load-path. You can then put Lisp libraries that are not included with Emacs in this directory, and load them with M-x load-library. Lisp Libraries. (add-to-list 'load-path "/path/to/lisp/libraries")
• Make TAB in C mode just insert a tab if point is in the middle of a line. (setq c-tab-always-indent nil) Here we have a variable whose value is normally t for "true" and the alternative is nil for "false".
• Make searches case sensitive by default (in all buffers that do not override this). (setq-default case-fold-search nil) This sets the default value, which is effective in all buffers that do not have local values for the variable (Locals). Setting case-fold-search with setq affects only the current buffer's local value, which is probably not what you want to do in an init file.
• Specify your own email address, if Emacs can't figure it out correctly. (setq user-mail-address "cheney@@torture.gov") Various Emacs packages, such as Message mode, consult user-mail-address when they need to know your email address. Mail Headers.
• Make Text mode the default mode for new buffers. (setq-default major-mode 'text-mode) Note that text-mode is used because it is the command for entering Text mode. The single-quote before it makes the symbol a constant; otherwise, text-mode would be treated as a variable name. @need 1500
• Set up defaults for the Latin-1 character set, which supports most of the languages of Western Europe. (set-language-environment "Latin-1") @need 1500
• Turn off Line Number mode, a global minor mode. (line-number-mode 0) @need 1500
• Turn on Auto Fill mode automatically in Text mode and related modes (Hooks). (add-hook 'text-mode-hook 'auto-fill-mode)
• Change the coding system used when using the clipboard (Communication Coding). (setopt selection-coding-system 'utf-8)
• Load the installed Lisp library named foo (actually a file foo.elc or foo.el in a standard Emacs directory). (load "foo") When the argument to load is a relative file name, not starting with / or ~, load searches the directories in load-path (Lisp Libraries).
• Load the compiled Lisp file foo.elc from your home directory. (load "~/foo.elc") Here a full file name is used, so no searching is done.
• Tell Emacs to find the definition for the function myfunction by loading a Lisp library named mypackage (i.e., a file mypackage.elc or mypackage.el): (autoload 'myfunction "mypackage" "Do what I say." t) Here the string "Do what I say." is the function's documentation string. You specify it in the autoload definition so it will be available for help commands even when the package is not loaded. The last argument, t, indicates that this function is interactive; that is, it can be invoked interactively by typing M-x myfunction RET or by binding it to a key. If the function is not interactive, omit the t or use nil.
• Rebind the key C-x l to run the function make-symbolic-link (Init Rebinding). (keymap-global-set "C-x l" 'make-symbolic-link) or (keymap-set global-map "C-x l" 'make-symbolic-link) Note once again the single-quote used to refer to the symbol make-symbolic-link instead of its value as a variable.
• Do the same thing for Lisp mode only. (keymap-set lisp-mode-map "C-x l" 'make-symbolic-link)
• Redefine all keys which now run next-line in Fundamental mode so that they run forward-line instead. (keymap-substitute global-map 'next-line 'forward-line)
• Make C-x C-v undefined. (keymap-global-unset "C-x C-v") One reason to undefine a key is so that you can make it a prefix. Simply defining C-x C-v anything will make C-x C-v a prefix, but C-x C-v must first be freed of its usual non-prefix definition.
• Make $ have the syntax of punctuation in Text mode. Note the use of a character constant for $. (modify-syntax-entry ?\$ "." text-mode-syntax-table)
• Enable the use of the command narrow-to-region without confirmation. (put 'narrow-to-region 'disabled nil)
• Adjusting the configuration to various platforms and Emacs versions. Users typically want Emacs to behave the same on all systems, so the same init file is right for all platforms. However, sometimes it happens that a function you use for customizing Emacs is not available on some platforms or in older Emacs versions. To deal with that situation, put the customization inside a conditional that tests whether the function or facility is available, like this: (if (fboundp 'blink-cursor-mode) (blink-cursor-mode 0)) (if (boundp 'coding-category-utf-8) (set-coding-priority '(coding-category-utf-8))) You can also simply disregard the errors that occur if the function is not defined. (ignore-errors (set-face-background 'region "grey75")) A setq on a variable which does not exist is generally harmless, so those do not need a conditional.
• Using use-package to automatically load and configure a package. (use-package hi-lock :defer t :init (add-hook 'some-hook 'hi-lock-mode) :config (use-package my-hi-lock) :bind (("M-o l" . highlight-lines-matching-regexp) ("M-o r" . highlight-regexp) ("M-o w" . highlight-phrase))) This will load hi-lock when some of its commands or variables are first used, bind 3 keys to its commands, and additionally load the my-hi-lock package (presumably further customizing hi-lock) after loading hi-lock. The use-package facility is fully documented in its own manual, Top.

Each terminal type can have a Lisp library to be loaded into Emacs when it is run on that type of terminal. For a terminal type named termtype, the library is called term/termtype. (If there is an entry of the form (termtype . alias) in the term-file-aliases association list, Emacs uses alias in place of termtype.) The library is found by searching the directories load-path as usual and trying the suffixes .elc and .el. Normally it appears in the subdirectory term of the directory where most Emacs libraries are kept. The usual purpose of the terminal-specific library is to map the escape sequences used by the terminal's function keys onto more meaningful names, using input-decode-map. See the file term/lk201.el for an example of how this is done. Many function keys are mapped automatically according to the information in the Termcap data base; the terminal-specific library needs to map only the function keys that Termcap does not specify. When the terminal type contains a hyphen, only the part of the name before the first hyphen is significant in choosing the library name. Thus, terminal types aaa-48 and aaa-30-rv both use the library term/aaa. The code in the library can use (getenv "TERM") to find the full terminal type name. The library's name is constructed by concatenating the value of the variable term-file-prefix and the terminal type. Your .emacs file can prevent the loading of the terminal-specific library by setting term-file-prefix to nil. Emacs runs the hook tty-setup-hook at the end of initialization, after both your .emacs file and any terminal-specific library have been read in. Add hook functions to this hook if you wish to override part of any of the terminal-specific libraries and to define initializations for terminals that do not have a library. Hooks.

Emacs normally finds your init file in a location under your home directory(On MS-Windows). Init File. Emacs looks for your init file using the filenames ~/.emacs.el, ~/.emacs, or ~/.emacs.d/init.el in that order; you can choose to use any one of these names. (Note that only the locations directly in your home directory have a leading dot in the location's basename.) Emacs can also look in an XDG-compatible location for init.el, the default is the directory ~/.config/emacs. This can be overridden by setting XDG_CONFIG_HOME in your environment, its value replaces ~/.config in the name of the default XDG init file. However ~/.emacs.d, ~/.emacs, and ~/.emacs.el are always preferred if they exist, which means that you must delete or rename them in order to use the XDG location. Note also that if neither the XDG location nor ~/.emacs.d exist, then Emacs will create ~/.emacs.d (and therefore use it during subsequent invocations). Emacs will set user-emacs-directory to the directory it decides to use. This directory is subsequently used to look for your other user-specific Emacs files, such as custom-file (Saving Customizations), the saved desktop (Saving Emacs Sessions) and others. It is also used to compute the value of the native-comp-eln-load-path (Lisp Libraries), which is where Emacs looks for natively-compiled Lisp code and where it deposits the newly-compiled Lisp code produced by asynchronous compilation of packages your init files and the subsequent Emacs session load. The --init-directory command-line option (Initial Options) overrides the value of user-emacs-directory determined as side effect of the search for your user init file described above. Since user-emacs-directory, once determined by Emacs, is used by the rest of the startup code to locate other files and directories, we do not recommend changing its value in your init files, as that could disrupt or break the correct startup of your Emacs sessions. Although this is backward-compatible with older Emacs versions, modern POSIX platforms prefer putting your initialization files under ~/.config so that troubleshooting a problem that might be due to a bad init file, or archiving a collection of init files, can be done by renaming that directory. To help older Emacs versions find configuration files in their current default locations, you can execute the following Emacs Lisp code:

(make-symbolic-link ".config/emacs" "~/.emacs.d")

However, if you run Emacs from a shell started by su and XDG_CONFIG_HOME is not set in your environment, Emacs tries to find your own initialization files, not that of the user you are currently pretending to be. The idea is that you should get your own editor customizations even if you are running as the super user. More precisely, Emacs first determines which user's init file to use. It gets your user name from the environment variables LOGNAME and USER; if neither of those exists, it uses the effective user-ID. If that user name matches the real user-ID, then Emacs uses HOME; otherwise, it looks up the home directory corresponding to that user name in the system's data base of users. For brevity the rest of the Emacs documentation generally uses just the current default location ~/.emacs.d/init.el for the init file.

Language and coding systems may cause problems if your init file contains non-ASCII characters, such as accented letters, in strings or key bindings. If you want to use non-ASCII characters in your init file, you should put a -*-coding: /coding-system/-*- tag on the first line of the init file, and specify a coding system that supports the character(s) in question. Recognize Coding. This is because the defaults for decoding non-ASCII text might not yet be set up by the time Emacs reads those parts of your init file which use such strings, possibly leading Emacs to decode those strings incorrectly. You should then avoid adding Emacs Lisp code that modifies the coding system in other ways, such as calls to set-language-environment. An alternative to using non-ASCII characters directly is to use one of the character escape syntaxes described in General Escape Syntax, as they allow all Unicode codepoints to be specified using only ASCII characters. To bind non-ASCII keys, you must use a vector (Init Rebinding). The string syntax cannot be used, since the non-ASCII characters will be interpreted as meta keys. For instance:

(global-set-key [?@var{char}] 'some-function)

Type C-q, followed by the key you want to bind, to insert char.

Most customizations for Emacs should be put in the normal init file. Init File. However, it is sometimes necessary to have customizations take effect during Emacs startup earlier than the normal init file is processed. Such customizations can be put in the early init file, ~/.config/emacs/early-init.el or ~/.emacs.d/early-init.el. This file is loaded before the package system and GUI is initialized, so in it you can customize variables that affect the package initialization process, such as package-enable-at-startup, package-load-list, and package-user-dir. Note that variables like package-archives which only affect the installation of new packages, and not the process of making already-installed packages available, may be customized in the regular init file. Package Installation. We do not recommend that you move into early-init.el customizations that can be left in the normal init files. That is because the early init file is read before the GUI is initialized, so customizations related to GUI features will not work reliably in early-init.el. By contrast, the normal init files are read after the GUI is initialized. If you must have customizations in the early init file that rely on GUI features, make them run off hooks provided by the Emacs startup, such as window-setup-hook or tty-setup-hook. Hooks. For more information on the early init file, Init File.

If the directory specified by user-lisp-directory, defaulting to ~/.config/emacs/user-lisp/ or ~/.emacs.d/user-lisp/, exists, then at startup Emacs will prepare Lisp files within that directory for use in the session. Specifically, Emacs does the following:

• Gather and activate autoload cookies. This means that you can use autoloaded commands and other entry points for the files in your user-lisp-directory without explicitly loading any of the files in your initialization file. Autoload.
• Byte-compile all the files (Byte Compilation), and if supported by your build of Emacs, compile them to native code as well (Native Compilation). This speeds up the execution of the code in those files when they are loaded and when they are executed later.
• Adjust load-path such that all the files can be loaded and autoloaded in the usual ways. Library Search.

The User Lisp directory is processed before loading your init file (Init File). Therefore any customizations to the user options discussed below must be made in your early init file (Early Init File) in order to have any effect. By default, Emacs considers all Lisp files within user-lisp-directory, including within subdirectories. You can prevent Emacs from descending into specific subdirectories by customizing user-lisp-ignored-directories. You can completely disable scraping at startup by customizing user-lisp-auto-scrape to nil. In addition to how Emacs prepares the Lisp files automatically at startup, you can manually invoke preparation using the command prepare-user-lisp. Although Emacs automatically handles recompilation when the contents of any Lisp files within the User Lisp directory have changed, there are other reasons why recompilation can become necessary that Emacs can't autodetect. A good rule of thumb that will catch most (but not all) such issues is to force recompilation each time you upgrade to a new release of Emacs. Start the new version of Emacs, type C-u M-x prepare-user-lisp, then quit and restart Emacs again. The User Lisp directory is a simpler mechanism than package installation (Packages). In particular, there is no automatic dependency resolution or upgrading for files in the User Lisp directory, or any facility for building and registering package documentation. This means that usually the User Lisp directory is best for code you have written only for yourself. However, it is possible to use the User Lisp directory for third party packages or public packages you maintain.