|Internet Business Consultant|
|Home||Blog||Bio||Projects||Contact||Latest Blog (new site): How to Get to Genius|
This chapter talks about various topics relevant to adapting the behavior of Emacs in minor ways. See The Emacs Lisp Reference Manual for how to make more far-reaching changes.
Customization that you do within Emacs normally affects only the particular Emacs session that you do it in--it does not persist between sessions unless you save the customization in a file such as `.emacs' or `.Xdefaults' that will affect future sessions. See section AD.7 The Init File, `~/.emacs'. In the customization buffer, when you save customizations for future sessions, this actually works by editing `.emacs' for you.
AD.1 Minor Modes
Minor modes are optional features which you can turn on or off. For example, Auto Fill mode is a minor mode in which SPC breaks lines between words as you type. All the minor modes are independent of each other and of the selected major mode. Most minor modes say in the mode line when they are on; for example, `Fill' in the mode line means that Auto Fill mode is on.
Some minor modes are global: while enabled, they affect everything you do in the Emacs session, in all buffers. Other minor modes are buffer-local; they apply only to the current buffer, so you can enable the mode in certain buffers and not others.
For most minor modes, the command name is also the name of a
variable which directly controls the mode. The mode is enabled
whenever this variable's value is non-
These minor-mode variables provide a good way for Lisp programs to turn minor modes on and off; they are also useful in a file's local variables list. But please think twice before setting minor modes with a local variables list, because most minor modes are matter of user preference--other users editing the same file might not want the same minor modes you prefer.
The buffer-local minor modes include Abbrev mode, Auto Fill mode, Auto Save mode, Font-Lock mode, Glasses mode, ISO Accents mode, Outline minor mode, Overwrite mode, and Binary Overwrite mode.
Abbrev mode allows you to define abbreviations that automatically expand as you type them. For example, `amd' might expand to `abbrev mode'. See section X. Abbrevs, for full information.
Auto Fill mode allows you to enter filled text without breaking lines explicitly. Emacs inserts newlines as necessary to prevent lines from becoming too long. See section T.5 Filling Text.
Auto Save mode causes the contents of a buffer to be saved periodically to reduce the amount of work you can lose in case of a system crash. See section M.5 Auto-Saving: Protection Against Disasters.
Enriched mode enables editing and saving of formatted text. See section T.11 Editing Formatted Text.
Flyspell mode automatically highlights misspelled words. See section L.4 Checking and Correcting Spelling.
Font-Lock mode automatically highlights certain textual units found in programs, such as comments, strings, and function names being defined. This requires a window system that can display multiple fonts. See section J.1 Using Multiple Typefaces.
ISO Accents mode makes the characters ``', `'', `"', `^', `/' and `~' combine with the following letter, to produce an accented letter in the ISO Latin-1 character set. The newer and more general feature of input methods more or less supersedes ISO Accents mode. See section Q.13 Single-byte Character Set Support.
Outline minor mode provides the same facilities as the major mode called Outline mode; but since it is a minor mode instead, you can combine it with any major mode. See section T.8 Outline Mode.
Overwrite mode causes ordinary printing characters to replace existing text instead of shoving it to the right. For example, if point is in front of the `B' in `FOOBAR', then in Overwrite mode typing a G changes it to `FOOGAR', instead of producing `FOOGBAR' as usual. In Overwrite mode, the command C-q inserts the next character whatever it may be, even if it is a digit--this gives you a way to insert a character instead of replacing an existing character.
Binary Overwrite mode is a variant of Overwrite mode for editing binary files; it treats newlines and tabs like other characters, so that they overwrite other characters and can be overwritten by them. In Binary Overwrite mode, digits after C-q specify an octal character code, as usual.
The following minor modes normally apply to all buffers at once. Since each is enabled or disabled by the value of a variable, you can set them differently for particular buffers, by explicitly making the corresponding variables local in those buffers. See section AD.2.4 Local Variables.
Icomplete mode displays an indication of available completions when you are in the minibuffer and completion is active. See section E.3.4 Completion Options.
Line Number mode enables continuous display in the mode line of the line number of point, and Column Number mode enables display of the column number. See section B.3 The Mode Line.
Scroll Bar mode gives each window a scroll bar (see section P.13 Scroll Bars). Menu Bar mode gives each frame a menu bar (see section P.15 Menu Bars). Both of these modes are enabled by default when you use the X Window System.
In Transient Mark mode, every change in the buffer contents "deactivates" the mark, so that commands that operate on the region will get an error. This means you must either set the mark, or explicitly "reactivate" it, before each command that uses the region. The advantage of Transient Mark mode is that Emacs can display the region highlighted (currently only when using X). See section H. The Mark and the Region.
A variable is a Lisp symbol which has a value. The symbol's name is also called the name of the variable. A variable name can contain any characters that can appear in a file, but conventionally variable names consist of words separated by hyphens. A variable can have a documentation string which describes what kind of value it should have and how the value will be used.
Lisp allows any variable to have any kind of value, but most variables
that Emacs uses require a value of a certain type. Often the value should
always be a string, or should always be a number. Sometimes we say that a
certain feature is turned on if a variable is "non-
Emacs uses many Lisp variables for internal record keeping, as any Lisp program must, but the most interesting variables for you are the ones that exist for the sake of customization. Emacs does not (usually) change the values of these variables; instead, you set the values, and thereby alter and control the behavior of certain Emacs commands. These variables are called user options. Most user options are documented in this manual, and appear in the Variable Index (see section Variable Index).
One example of a variable which is a user option is
AD.2.1 Examining and Setting Variables
To examine the value of a single variable, use C-h v
displays something like this:
The star at the beginning of the documentation indicates that this variable is a user option. C-h v is not restricted to user options; it allows any variable name.
The most convenient way to set a specific user option 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. For example,
M-x set-variable is limited to user option variables, but you can
set any variable with a Lisp expression, using the function
To execute an expression like this one, go to the `*scratch*' buffer, type in the expression, and then type C-j. See section V.9 Lisp Interaction Buffers.
Setting variables, like all means of customizing Emacs except where otherwise stated, affects only the current Emacs session.
AD.2.2 Easy Customization Interface
A convenient way to find the user option variables that you want to change, and then change them, is with M-x customize. This command creates a customization buffer with which you can browse through the Emacs user options in a logically organized structure, then edit and set their values. You can also use the customization buffer to save settings permanently. (Not all Emacs user options are included in this structure as of yet, but we are adding the rest.)
The appearance of the example buffers in the following is typically different under a window system where faces can be used to indicate the active fields and other features.
AD.2.2.1 Customization Groups
For customization purposes, user options are organized into
groups to help you find them. Groups are collected into bigger
groups, all the way up to a master group called
M-x customize creates a customization buffer that shows the
This says that the buffer displays the contents of the
Most of the text in the customization buffer is read-only, but it typically includes some editable fields that you can edit. There are also active fields; this means a field that does something when you invoke it. To invoke an active field, either click on it with Mouse-1, or move point to it and type RET.
For example, the phrase `[Go to Group]' that appears in a second-level group is an active field. Invoking the `[Go to Group]' field for a group creates a new customization buffer, which shows that group and its contents. This field is a kind of hypertext link to another group.
You can view the structure of customization groups on a larger scale with M-x customize-browse. This command creates a special kind of customization buffer which shows only the names of the groups (and options and faces), and their structure.
In this buffer, you can show the contents of a group by invoking `[+]'. When the group contents are visible, this button changes to `[-]'; invoking that hides the group contents.
Each group, option or face name in this buffer has an active field which says `[Group]', `[Option]' or `[Face]'. Invoking that active field creates an ordinary customization buffer showing just that group and its contents, just that option, or just that face. This is the way to set values in it.
AD.2.2.2 Changing an Option
Here is an example of what a user option looks like in the customization buffer:
The text following `[Hide]', `60' in this case, indicates the current value of the option. If you see `[Show]' instead of `[Hide]', it means that the value is hidden; the customization buffer initially hides values that take up several lines. Invoke `[Show]' to show the value.
The line after the option name indicates the customization state of the option: in the example above, it says you have not changed the option yet. The word `[State]' at the beginning of this line is active; you can get a menu of various operations by invoking it with Mouse-1 or RET. These operations are essential for customizing the variable.
The line after the `[State]' line displays the beginning of the option's documentation string. If there are more lines of documentation, this line ends with `[More]'; invoke this to show the full documentation string.
To enter a new value for `Kill Ring Max', move point to the value and edit it textually. For example, you can type M-d, then insert another number.
When you begin to alter the text, you will see the `[State]' line change to say that you have edited the value:
The state of the option changes visibly when you set it:
You don't have to worry about specifying a value that is not valid; setting the option checks for validity and will not really install an unacceptable value.
Some options have a small fixed set of possible legitimate values. These options don't let you edit the value textually. Instead, an active field `[Value Menu]' appears before the value; invoke this field to edit the value. For a boolean "on or off" value, the active field says `[Toggle]', and it changes to the other value. `[Value Menu]' and `[Toggle]' edit the buffer; the changes take effect when you use the `Set for Current Session' operation.
Some options have values with complex structure. For example, the
Each association in the list appears on four lines, with several editable or "active" fields. You can edit the regexps and coding systems using ordinary editing commands. You can also invoke `[Value Menu]' to switch to a kind of value--for instance, to specify a function instead of a pair of coding systems.
To delete an association from the list, invoke the `[DEL]' button for that item. To add an association, invoke `[INS]' at the position where you want to add it. There is an `[INS]' button between each pair of association, another at the beginning and another at the end, so you can add the new association at any position in the list.
Two special commands, TAB and S-TAB, are useful for
moving through the customization buffer. TAB
Typing RET on an editable field also moves forward, just like TAB. We set it up this way because people often type RET when they are finished editing a field. To insert a newline within an editable field, use C-o or C-q C-j.
Setting the option changes its value in the current Emacs session; saving the value changes it for future sessions as well. This works by writing code into your `~/.emacs' file so as to set the option variable again each time you start Emacs. To save the option, invoke `[State]' and select the `Save for Future Sessions' operation.
If Emacs was invoked with the `-q' or `--no-init-file' options (see section AE.2 Initial Options), it will not let you save your customizations in your `~/.emacs' init file. This is because saving customizations from such a session would wipe out all the other customizations you might have on your init file.
You can also restore the option to its standard value by invoking `[State]' and selecting the `Erase Customization' operation. There are actually three reset operations:
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. The comment you enter will be saved, and displayed again if you again view the same option in a customization buffer, even in another session.
The state of a group indicates whether anything in that group has been edited, set or saved. You can select `Set for Current Session', `Save for Future Sessions' and the various kinds of `Reset' operation for the group; these operations on the group apply to all options in the group and its subgroups.
Near the top of the customization buffer there are two lines containing several active fields:
Invoking `[Finish]' either buries or kills this customization
buffer according to the setting of the option
AD.2.2.3 Customizing Faces
In addition to user options, some customization groups also include faces. When you show the contents of a group, both the user options and the faces in the group appear in the customization buffer. Here is an example of how a face looks:
Each face attribute has its own line. The `[x]' field before the attribute name indicates whether the attribute is enabled; `X' means that it is. You can enable or disable the attribute by invoking that field. When the attribute is enabled, you can change the attribute value in the usual ways.
On a black-and-white display, the colors you can use for the background are `black', `white', `gray', `gray1', and `gray3'. Emacs supports these shades of gray by using background stipple patterns instead of a color.
Setting, saving and resetting a face work like the same operations for options (see section AD.2.2.2 Changing an Option).
A face can specify different appearances for different types of display. 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 `Show all display specs' in the menu you get from invoking `[State]'.
Another more basic way to set the attributes of a specific face is with M-x modify-face. This command reads the name of a face, then reads the attributes one by one. For the color and stipple attributes, the attribute's current value is the default--type just RET if you don't want to change that attribute. Type `none' if you want to clear out the attribute.
AD.2.2.4 Customizing Specific Items
Instead of finding the options you want to change by moving down through the structure of groups, you can specify the particular option, face or group that you want to customize.
If you want to alter a particular user option variable with the customization buffer, and you know its name, you can use the command M-x customize-option and specify the option name. This sets up the customization buffer with just one option--the one that you asked for. Editing, setting and saving the value work as described above, but only for the specified option.
You can also set up the customization buffer with a specific group, using M-x customize-group. The immediate contents of the chosen group, including option variables, faces, and other groups, all appear as well. However, these subgroups' own contents start out hidden. You can show their contents in the usual way, by invoking `[Show]'.
To control more precisely what to customize, you can use M-x customize-apropos. You specify a regular expression as argument; then all options, faces and groups whose names match this regular expression are set up in the customization buffer. If you specify an empty regular expression, this includes all groups, options and faces in the customization buffer (but that takes a long time).
When you upgrade to a new Emacs version, you might want to customize new options and options whose meanings or default values have changed. To do this, use M-x customize-changed-options and specify a previous Emacs version number using the minibuffer. It creates a customization buffer which shows all the options (and groups) whose definitions have been changed since the specified version.
If you change option values and then decide the change was a mistake, you can use two special commands to revisit your previous changes. Use M-x customize-saved to look at the options and faces that you have saved. Use M-x customize-customized to look at the options and faces that you have set but not saved.
Hooks are an important mechanism for customization of 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. With rare exceptions, hooks in Emacs are empty when Emacs starts up, so the only hook functions in any given hook are the ones you explicitly put there as customization.
Most major modes run one or more mode hooks as the last step of
initialization. This makes it easy for you to customize the behavior of
the mode, by setting up a hook function to override the local variable
assignments already made by the mode. But hooks are also used in other
contexts. For example, the hook
Most Emacs hooks are normal hooks. This means that running the hook operates by calling all the hook functions, unconditionally, 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 in Emacs whose name ends in `-hook' is a normal hook.
There are also a few abnormal hooks. These variables' names end
in `-hooks' or `-functions', instead of `-hook'. What
makes these hooks abnormal is that there is something peculiar about the
way its functions are called--perhaps they are given arguments, or
perhaps the values they return are used in some way. For example,
The recommended way to add a hook function to a hook (either normal or
abnormal) is by calling
For example, here's how to set up a hook to turn on Auto Fill mode when entering Text mode and other modes based on Text mode:
The next example shows how to use a hook to customize the indentation of C code. (People often have strong personal preferences for one format compared to another.) Here the hook function is an anonymous lambda expression.
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 most recently added hook functions are executed first.
AD.2.4 Local Variables
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. Further changes in this buffer will not affect others, and further changes in the global value will not affect this buffer.
M-x make-variable-buffer-local reads the name of a variable and
changes the future behavior of the variable so that it will become local
automatically when it is set. More precisely, once a variable has been
marked in this way, the usual ways of setting the variable automatically
Major modes (see section R. 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-
Emacs contains a number of variables that are always per-buffer.
A few variables cannot be local to a buffer because they are always local to each display instead (see section P.10 Multiple Displays). If you try to make one of these variables buffer-local, you'll get an error message.
M-x kill-local-variable reads the name of a variable and makes it 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
Lisp programs can use
AD.2.5 Local Variables in Files
A file can specify local variable values for use when you edit the file with Emacs. Visiting the file 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 specify local variable values: in the first line, or with a local variables list. Here's how to specify them in the first line:
You can specify any number of variables/value pairs in this way, each
pair with a colon and semicolon as shown above.
You can also specify the coding system for a file in this way: just
specify a value for the "variable" named
In shell scripts, the first line is used to identify the script interpreter, so you cannot put any local variables there. To accommodate for this, when Emacs visits a shell script, it looks for local variable specifications in the second line.
A local variables list goes near the end of the file, in the last page. (It is often best to put it on a page by itself.) The local variables list starts with a line containing the string `Local Variables:', and ends with a line containing the string `End:'. In between come the variable names and values, one set per line, as `variable: value'. The values are not evaluated; they are used literally. If a file has both a local variables list and a `-*-' line, Emacs processes everything in the `-*-' line first, and everything in the local variables list afterward.
Here is an example of a local variables list:
As you see, each line starts with the prefix `;;; ' and each line ends with the suffix ` ***'. Emacs recognizes these as the prefix and suffix based on the first line of the list, by finding them surrounding the magic string `Local Variables:'; then it automatically discards them from the other lines of the list.
The usual reason for using a prefix and/or suffix is to embed the
local variables list in a comment, so it won't confuse other programs
that the file is intended as input for. The example above is for a
language where comment lines start with `;;; ' and end with
`***'; the local values for
Two "variable names" have special meanings in a local variables
list: a value for the variable
You can use the
For example, you may be tempted to try to turn on Auto Fill mode with a local variable list. That is a mistake. The choice of Auto Fill mode or not is a matter of individual taste, not a matter of the contents of particular files. If you want to use Auto Fill, set up major mode hooks with your `.emacs' file to turn it on (when appropriate) for you alone (see section AD.7 The Init File, `~/.emacs'). Don't use a local variable list to impose your taste on everyone.
The start of the local variables list must be no more than 3000 characters from the end of the file, and must be in the last page if the file is divided into pages. Otherwise, Emacs will not notice it is there. The purpose of this rule is so that a stray `Local Variables:' not in the last page does not confuse Emacs, and so that visiting a long file that is all one page and has no local variables list need not take the time to search the whole file.
Use the command
AD.3 Keyboard Macros
A keyboard macro is a command defined by the user to stand for another sequence of keys. For example, if you discover that you are about to type C-n C-d forty times, you can speed your work by defining a keyboard macro to do C-n C-d and calling it with a repeat count of forty.
Keyboard macros differ from ordinary Emacs commands in that they are written in the Emacs command language rather than in Lisp. This makes it easier for the novice to write them, and makes them more convenient as temporary hacks. However, the Emacs command language is not powerful enough as a programming language to be useful for writing anything intelligent or general. For such things, Lisp must be used.
You define a keyboard macro while executing the commands which are the definition. Put differently, as you define a keyboard macro, the definition is being executed for the first time. This way, you can see what the effects of your commands are, so that you don't have to figure them out in your head. When you are finished, the keyboard macro is defined and also has been, in effect, executed once. You can then do the whole thing over again by invoking the macro.
AD.3.1 Basic Use
To start defining a keyboard macro, type the C-x ( command
defines a macro to move forward a word and then insert `foo'.
The macro thus defined can be invoked again with the C-x e
If you wish to repeat an operation at regularly spaced places in the text, define a macro and include as part of the macro the commands to move to the next place you want to use it. For example, if you want to change each line, you should position point at the start of a line, and define a macro to change that line and leave point at the start of the next line. Then repeating the macro will operate on successive lines.
When a command reads an argument with the minibuffer, your minibuffer input becomes part of the macro along with the command. So when you replay the macro, the command gets the same argument as when you entered the macro. For example,
defines a macro that copies the current line into the buffer `foo', then returns to the original buffer.
You can use function keys in a keyboard macro, just like keyboard keys. You can even use mouse events, but be careful about that: when the macro replays the mouse event, it uses the original mouse position of that event, the position that the mouse had while you were defining the macro. The effect of this may be hard to predict. (Using the current mouse position would be even less predictable.)
One thing that doesn't always work well in a keyboard macro is the
command C-M-c (
After you have terminated the definition of a keyboard macro, you can add to the end of its definition by typing C-u C-x (. This is equivalent to plain C-x ( followed by retyping the whole definition so far. As a consequence it re-executes the macro as previously defined.
You can edit a keyboard macro already defined by typing C-x C-k
The command M-x apply-macro-to-region-lines repeats the last defined keyboard macro on each complete line within the current region. It does this line by line, by moving point to the beginning of the line and then executing the macro.
AD.3.2 Naming and Saving Keyboard Macros
If you wish to save a keyboard macro for longer than until you define the
next one, you must give it a name using M-x name-last-kbd-macro.
This reads a name as an argument using the minibuffer and defines that name
to execute the macro. The macro name is a Lisp symbol, and defining it in
this way makes it a valid command name for calling with M-x or for
binding a key to with
Once a macro has a command name, you can save its definition in a file. Then it can be used in another editing session. First, visit the file you want to save the definition in. Then use this command:
This inserts some Lisp code that, when executed later, will define the
same macro with the same definition it has now. (You need not
understand Lisp code to do this, because
If you give
AD.3.3 Executing Macros with Variations
Using C-x q (
The valid responses when C-x q asks are SPC (or y),
DEL (or n), RET (or q), C-l and C-r.
The answers are the same as in
These responses include SPC to continue, and DEL to skip the remainder of this repetition of the macro and start right away with the next repetition. RET means to skip the remainder of this repetition and cancel further repetitions. C-l redraws the screen and asks you again for a character to say what to do.
C-r enters a recursive editing level, in which you can perform editing which is not part of the macro. When you exit the recursive edit using C-M-c, you are asked again how to continue with the keyboard macro. If you type a SPC at this time, the rest of the macro definition is executed. It is up to you to leave point and the text in a state such that the rest of the macro will do what you want.
C-u C-x q, which is C-x q with a numeric argument, performs a completely different function. It enters a recursive edit reading input from the keyboard, both when you type it during the definition of the macro, and when it is executed from the macro. During definition, the editing you do inside the recursive edit does not become part of the macro. During macro execution, the recursive edit gives you a chance to do some particularized editing on each repetition. See section AC.26 Recursive Editing Levels.
Another way to vary the behavior of a keyboard macro is to use a register as a counter, incrementing it on each repetition of the macro. See section I.5 Keeping Numbers in Registers.
AD.4 Customizing Key Bindings
This section describes key bindings, which map keys to commands, and keymaps, which record key bindings. It also explains how to customize key bindings.
Recall that a 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.
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.
Recall that 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 with your terminal. A key sequence gets its meaning from its binding, which says what command it runs. The function of keymaps is to record these bindings.
The global keymap is the most important keymap because it is always in effect. The global keymap defines keys for Fundamental mode; 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
Meta characters work differently; Emacs translates each Meta character into a pair of characters starting with ESC. When you type the character M-a in a key sequence, Emacs replaces it with ESC a. A meta key comes in as a single input event, but becomes two events for purposes of key bindings. The reason for this is historical, and we might change it someday.
On many terminals, typing a function key actually sends the computer a sequence of characters; the precise details of the sequence depends on which function key and on the model of terminal you are using. (Often the sequence starts with ESC [.) If Emacs understands your terminal type properly, it recognizes the character sequences forming function keys wherever they occur in a key sequence (not just at the beginning). Thus, for most purposes, you can pretend the function keys reach Emacs directly and ignore their encoding as character sequences.
Mouse buttons also produce input events. These events come with other data--the window and position where you pressed or released the button, and a time stamp. But only the choice of button matters for key bindings; the other data matters only if a command looks at it. (Commands designed for mouse invocation usually do look at the other data.)
A keymap records definitions for single events. Interpreting a key sequence of multiple events involves a chain of keymaps. The first keymap gives a definition for the first event; this definition is another keymap, which is used to look up the second event in the sequence, and so on.
Key sequences can mix function keys and characters. For example, C-x SELECT is meaningful. If you make SELECT a prefix key, then SELECT C-n makes sense. You can even mix mouse events with keyboard events, but we recommend against it, because such key sequences are inconvenient to use.
As a user, you can redefine any key; but it is usually best to stick to key sequences that consist of C-c followed by a letter. These keys are "reserved for users," so they won't conflict with any properly designed Emacs extension. The function keys F5 through F9 are also reserved for users. If you redefine some other key, your definition may be overridden by certain extensions or major modes which redefine the same key.
AD.4.2 Prefix Keymaps
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
Aside from ordinary prefix keys, there is a fictitious "prefix key" which represents the menu bar; see section `Menu Bar' in The Emacs Lisp Reference Manual, for special information about menu bar key bindings. Mouse button events that invoke pop-up menus are also prefix keys; see section `Menu Keymaps' in The Emacs Lisp Reference Manual, for more details.
Some prefix keymaps are stored in variables with names:
AD.4.3 Local Keymaps
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. Portions of text in the buffer can specify their own keymaps to substitute for the keymap of the buffer's major mode.
The local keymaps for Lisp mode and several other major modes always
exist even when not in use. These are kept in variables named
All minor mode keymaps are created in advance. There is no way to defer their creation until the first time the minor mode is enabled.
A local keymap can locally redefine a key as a prefix key by defining it as a prefix keymap. If the key is also defined globally as a prefix, then its local and global definitions (both keymaps) effectively combine: both of them are used to look up the event that follows the prefix key. Thus, if the mode's local keymap defines C-c as another 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 ordinary circumstances.
To change the local bindings of a major mode, you must change the mode's local keymap. Normally you must wait until the first time the mode is used, because most major modes don't create their keymaps until then. If you want to specify something in your `~/.emacs' file to change a major mode's bindings, you must use the mode's mode hook to delay the change until the mode is first used.
For example, the command
See section AD.2.3 Hooks.
AD.4.4 Minibuffer Keymaps
AD.4.5 Changing Key Bindings Interactively
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 definitions for the same key). Or you can change the current buffer's local map, which affects all buffers using the same major mode.
For example, suppose you like to execute commands in a subshell within
an Emacs buffer, instead of suspending Emacs and executing commands in
your login shell. Normally, C-z is bound to the function
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; the minibuffer is entered immediately to read cmd. But if you type C-x, another character is read; if that is 4, another character is read, and so on. For example,
redefines C-x 4 $ to run the (fictitious) command
The two-character keys consisting of C-c followed by a letter are reserved for user customizations. Lisp programs are not supposed to define these keys, so the bindings you make for them will be available in all major modes and will never get in the way of anything.
You can remove the global definition of a key with
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 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. See section AD.4.11 Disabling Commands.
AD.4.6 Rebinding Keys in Your Init File
If you have a set of key bindings that you like to use all the time, you can specify them in your `.emacs' file by using their Lisp syntax. (See section AD.7 The Init File, `~/.emacs'.)
The simplest method for doing this works for ASCII characters and
Meta-modified ASCII characters only. This method uses a string to
represent the key sequence you want to rebind. For example, here's how
to bind C-z to
This example uses a string constant containing one character, C-z.
The single-quote before the command name,
Here is another example that binds a key sequence two characters long:
To put TAB, RET, ESC, or DEL in the string, you can use the Emacs Lisp escape sequences, `\t', `\r', `\e', and `\d'. Here is an example which binds C-x TAB:
These examples show how to write some other special ASCII characters in strings for key bindings:
When the key sequence includes function keys or mouse button events,
or non-ASCII characters such as
The way to write a vector in Emacs Lisp is with square brackets around the vector elements. Use spaces to separate the elements. If an element is a symbol, simply write the symbol's name--no other delimiters or punctuation are needed. If a vector element is a character, write it as a Lisp character constant: `?' followed by the character as it would appear in a string.
Here are examples of using vectors to rebind C-= (a control character not in ASCII), C-M-= (not in ASCII because C-= is not), H-a (a Hyper character; ASCII doesn't have Hyper at all), F7 (a function key), and C-Mouse-1 (a keyboard-modified mouse button):
You can use a vector for the simple cases too. Here's how to rewrite the first three examples above, using vectors to bind C-z, C-x l, and C-x TAB:
As you see, you represent a multi-character key sequence with a vector by listing each of the characters within the square brackets that delimit the vector.
AD.4.7 Rebinding Function Keys
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:
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.
A key sequence which contains function key symbols (or anything but
ASCII characters) must be a vector rather than a string. The vector
syntax uses spaces between the elements, and square brackets around the
whole vector. Thus, to bind function key `f1' to the command
To bind the right-arrow key to the command
This uses the Lisp syntax for a vector containing the symbol
See section AD.4.6 Rebinding Keys in Your Init File, for more information about using vectors for rebinding.
You can mix function keys and characters in a key sequence. This
example binds C-x NEXT to the command
You can use the modifier keys CTRL, META, HYPER, SUPER, ALT and SHIFT with function keys. To represent these modifiers, add the strings `C-', `M-', `H-', `s-', `A-' and `S-' at the front of the symbol name. Thus, here is how to make Hyper-Meta-RIGHT move forward a word:
AD.4.8 Named ASCII Control Characters
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. Later, users found it convenient to distinguish in Emacs between these keys and the "same" control characters typed with the CTRL key.
Emacs distinguishes these two kinds of input, when the keyboard
reports these keys to Emacs. It treats the "special" keys as function
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"
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.
AD.4.9 Non-ASCII Characters on the Keyboard
If your keyboard has keys that send non-ASCII characters, such as
accented letters, rebinding these keys is a bit tricky. There are two
solutions you can use. One is to specify a keyboard coding system,
Type C-q followed by the key you want to bind, to insert char.
If you don't specify the keyboard coding system, that approach won't work. Instead, you need to find out the actual code that the terminal sends. The easiest way to do this in Emacs is to create an empty buffer with C-x b temp RET, make it unibyte with M-x toggle-enable-multibyte-characters RET, then type the key to insert the character into this buffer.
Move point before the character, then type C-x =. This displays a message in the minibuffer, showing the character code in three ways, octal, decimal and hexadecimal, all within a set of parentheses. Use the second of the three numbers, the decimal one, inside the vector to bind:
If you bind 8-bit characters like this in your init file, you may find it convenient to specify that it is unibyte. See section Q.2 Enabling Multibyte Characters.
AD.4.10 Rebinding Mouse Buttons
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
The symbols for drag events are similar, but have the prefix
`drag-' before the word `mouse'. For example, dragging the
first button generates a
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,
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 you can distinguish if you really want to. 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 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
Here is the complete list of these dummy prefix keys and their meanings:
You can put more than one mouse button in a key sequence, but it isn't usual to do so.
AD.4.11 Disabling Commands
Disabling a command marks the command as requiring confirmation before it can be executed. The purpose of disabling a command is to prevent beginning users from executing it by accident and being confused.
An attempt 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 are asked whether to do this permanently or just for the current session. (Enabling permanently works by automatically editing your `.emacs' 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
If the value of the
You can make a command disabled either by editing the `.emacs' file directly or with the command M-x disable-command, which edits the `.emacs' file for you. Likewise, M-x enable-command edits `.emacs' to enable a command permanently. See section AD.7 The Init File, `~/.emacs'.
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. Disabling a command has no effect on calling it as a function from Lisp programs.
AD.5 Keyboard Translations
Some keyboards do not make it convenient to send all the special characters that Emacs uses. The most common problem case is the DEL character. Some keyboards provide no convenient way to type this very important character--usually because they were designed to expect the character C-h to be used for deletion. On these keyboards, if you press the key normally used for deletion, Emacs handles the C-h as a prefix character and offers you a list of help options, which is not what you want.
Keyboard translations are not the same as key bindings in keymaps (see section AD.4.1 Keymaps). Emacs contains numerous keymaps that apply in different situations, but there is only one set of keyboard translations, and it applies to every character that Emacs reads from the terminal. Keyboard translations take place at the lowest level of input processing; the keys that are looked up in keymaps contain the characters that result from keyboard translation.
On a window system, the keyboard key named DELETE is a function key and is distinct from the ASCII character named DEL. See section AD.4.8 Named ASCII Control Characters. Keyboard translations affect only ASCII character input, not function keys; thus, the above example used on a window system does not affect the DELETE key. However, the translation above isn't necessary on window systems, because Emacs can also distinguish between the BACKSPACE key and C-h; and it normally treats BACKSPACE as DEL.
For full information about how to use keyboard translations, see section `Translating Input' in The Emacs Lisp Reference Manual.
AD.6 The Syntax Table
All the Emacs commands which parse words or balance parentheses are controlled by the syntax table. The syntax table says which characters are opening delimiters, which are parts of words, which are string quotes, and so on. It does this by assigning each character to one of fifteen-odd syntax classes. In some cases it specifies some additional information also.
Each major mode has its own syntax table (though related major modes sometimes share one syntax table) which it installs in each buffer that uses the mode. The syntax table installed in the current buffer is the one that all commands use, so we call it "the" syntax table.
To display a description of the contents of the current syntax
table, type C-h s (
A syntax table is actually a Lisp object, a char-table, whose elements are cons cells. For full information on the syntax table, see section `Syntax Tables' in The Emacs Lisp Reference Manual.
AD.7 The Init File, `~/.emacs'
When Emacs is started, it normally loads a Lisp program from the file `.emacs' or `.emacs.el' in your home directory. We call this file your init file because it specifies how to initialize Emacs for you. You can use the command line switch `-q' to prevent loading your init file, and `-u' (or `--user') to specify a different user's init file (see section C. Entering and Exiting Emacs).
There can also be a default init file, which is the library
named `default.el', found via the standard search path for
libraries. The Emacs distribution contains no such library; your site
may create one for local customizations. If this library exists, it is
loaded whenever you start Emacs (except when you specify `-q').
But your init file, if any, is loaded first; if it sets
Your site may also have a site startup file; this is named `site-start.el', if it exists. Like `default.el', Emacs finds this file via the standard search path for Lisp libraries. Emacs loads this library before it loads your init file. To inhibit loading of this library, use the option `-no-site-file'. See section AE.2 Initial Options.
You can place `default.el' and `site-start.el' in any of
the directories which Emacs searches for Lisp libraries. The variable
If you have a large amount of code in your `.emacs' file, you should rename it to `~/.emacs.el', and byte-compile it. See section `Byte Compilation' in the Emacs Lisp Reference Manual, for more information about compiling Emacs Lisp programs.
If you are going to write actual Emacs Lisp programs that go beyond minor customization, you should read the Emacs Lisp Reference Manual. See section `Emacs Lisp' in the Emacs Lisp Reference Manual.
AD.7.1 Init File Syntax
The `.emacs' file contains one or more Lisp function call
expressions. Each of these consists of a function name followed by
arguments, all surrounded by parentheses. For example,
The second argument to
AD.7.2 Init File Examples
Here are some examples of doing certain commonly desired things with Lisp expressions:
AD.7.3 Terminal-specific Initialization
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' and it is
found by searching the directories
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
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
The library's name is constructed by concatenating the value of the
Emacs runs the hook
AD.7.4 How Emacs Finds Your Init File
Normally Emacs uses the environment variable
More precisely, Emacs first determines which user's init file to use.
It gets the user name from the environment variables
AD.8 Quitting and Aborting
There are two ways of canceling commands which are not finished executing: quitting with C-g, and aborting with C-] or M-x top-level. Quitting cancels a partially typed command or one which is already running. Aborting exits a recursive editing level and cancels the command that invoked the recursive edit. (See section AC.26 Recursive Editing Levels.)
Quitting with C-g is used for getting rid of a partially typed command, or a numeric argument that you don't want. It also stops a running command in the middle in a relatively safe way, so you can use it if you accidentally give a command which takes a long time. In particular, it is safe to quit out of killing; either your text will all still be in the buffer, or it will all be in the kill ring (or maybe both). Quitting an incremental search does special things documented under searching; in general, it may take two successive C-g characters to get out of a search (see section K.1 Incremental Search).
On MS-DOS, the character C-BREAK serves as a quit character like C-g. The reason is that it is not feasible, on MS-DOS, to recognize C-g while a command is running, between interactions with the user. By contrast, it is feasible to recognize C-BREAK at all times. See section AH.1 Keyboard and Mouse on MS-DOS.
C-g works by setting the variable
If you quit with C-g a second time before the first C-g is recognized, you activate the "emergency escape" feature and return to the shell. See section AD.9.8 Emergency Escape.
There may be times when you cannot quit. When Emacs is waiting for the operating system to do something, quitting is impossible unless special pains are taken for the particular system call within Emacs where the waiting occurs. We have done this for the system calls that users are likely to want to quit from, but it's possible you will find another. In one very common case--waiting for file input or output using NFS--Emacs itself knows how to quit, but many NFS implementations simply do not allow user programs to stop waiting for NFS when the NFS server is hung.
Aborting with C-] (
The command ESC ESC ESC
The command M-x top-level is equivalent to "enough" C-] commands to get you out of all the levels of recursive edits that you are in. C-] gets you out one level at a time, but M-x top-level goes out all levels at once. Both C-] and M-x top-level are like all other commands, and unlike C-g, in that they take effect only when Emacs is ready for a command. C-] is an ordinary key and has its meaning only because of its binding in the keymap. See section AC.26 Recursive Editing Levels.
C-x u (
AD.9 Dealing with Emacs Trouble
This section describes various conditions in which Emacs fails to work normally, and how to recognize them and correct them. For a list of additional problems you might encounter, see section `Bugs and problems' in GNU Emacs FAQ, and the file `etc/PROBLEMS' in the Emacs distribution. Type C-h F to read the FAQ; type C-h P to read the `PROBLEMS' file.
AD.9.1 If DEL Fails to Delete
Every keyboard has a large key, a little ways above the RET or ENTER key, which you normally use outside Emacs to erase the last character that you typed. We call this key the usual erasure key. In Emacs, it is supposed to be equivalent to DEL, and when Emacs is properly configured for your terminal, it translates that key into the character DEL.
When Emacs starts up using a window system, it determines automatically which key should be DEL. In some unusual cases Emacs gets the wrong information from the system. If the usual erasure key deletes forwards instead of backwards, that is probably what happened--Emacs ought to be treating the DELETE key as DEL, but it isn't.
With a window system, if the usual erasure key is labeled BACKSPACE and there is a DELETE key elsewhere, but the DELETE key deletes backward instead of forward, that too suggests Emacs got the wrong information--but in the opposite sense. It ought to be treating the BACKSPACE key as DEL, and treating DELETE differently, but it isn't.
On a text-only terminal, if you find the usual erasure key prompts for a Help command, like Control-h, instead of deleting a character, it means that key is actually sending the BS character. Emacs ought to be treating BS as DEL, but it isn't.
In all of those cases, the immediate remedy is the same: use the command M-x normal-erase-is-backspace-mode. This toggles between the two modes that Emacs supports for handling DEL, so if Emacs starts in the wrong mode, it should switch to the right mode. On a text-only terminal, if you want to ask for help when BS is treated as DEL, use F1; C-? may also work, if it sends character code 127.
To fix the problem automatically for every Emacs session, you can put one of the following lines into your `.emacs' file (see section AD.7 The Init File, `~/.emacs'). For the first case above, where DELETE deletes forwards instead of backwards, use this line to make DELETE act as DEL (resulting in behavior compatible with Emacs 20 and previous versions):
For the other two cases, where BACKSPACE ought to act as DEL, use this line:
Another way to fix the problem for every Emacs session is to
customize the variable
With a window system, it can also happen that the usual erasure key
is labeled BACKSPACE, there is a DELETE key elsewhere, and
both keys delete forward. This probably means that someone has
redefined your BACKSPACE key as a DELETE key. With X,
this is typically done with a command to the
AD.9.2 Recursive Editing Levels
Recursive editing levels are important and useful features of Emacs, but they can seem like malfunctions to the user who does not understand them.
If the mode line has square brackets `[...]' around the parentheses that contain the names of the major and minor modes, you have entered a recursive editing level. If you did not do this on purpose, or if you don't understand what that means, you should just get out of the recursive editing level. To do so, type M-x top-level. This is called getting back to top level. See section AC.26 Recursive Editing Levels.
AD.9.3 Garbage on the Screen
If the data on the screen looks wrong, the first thing to do is see whether the text is really wrong. Type C-l to redisplay the entire screen. If the screen appears correct after this, the problem was entirely in the previous screen update. (Otherwise, see the following section.)
Display updating problems often result from an incorrect termcap entry for the terminal you are using. The file `etc/TERMS' in the Emacs distribution gives the fixes for known problems of this sort. `INSTALL' contains general advice for these problems in one of its sections. Very likely there is simply insufficient padding for certain display operations. To investigate the possibility that you have this sort of problem, try Emacs on another terminal made by a different manufacturer. If problems happen frequently on one kind of terminal but not another kind, it is likely to be a bad termcap entry, though it could also be due to a bug in Emacs that appears for terminals that have or that lack specific features.
AD.9.4 Garbage in the Text
If C-l shows that the text is wrong, try undoing the changes to it using C-x u until it gets back to a state you consider correct. Also try C-h l to find out what command you typed to produce the observed results.
If a large portion of text appears to be missing at the beginning or end of the buffer, check for the word `Narrow' in the mode line. If it appears, the text you don't see is probably still present, but temporarily off-limits. To make it accessible again, type C-x n w. See section AC.22 Narrowing.
AD.9.5 Spontaneous Entry to Incremental Search
If Emacs spontaneously displays `I-search:' at the bottom of the screen, it means that the terminal is sending C-s and C-q according to the poorly designed xon/xoff "flow control" protocol.
If this happens to you, your best recourse is to put the terminal in a
mode where it will not use flow control, or give it so much padding that
it will never send a C-s. (One way to increase the amount of
padding is to set the variable
Typically there are particular terminal types with which you must use
flow control. You can conveniently ask for flow control on those
terminal types only, using
When flow control is enabled, you must type C-\ to get the effect of a C-s, and type C-^ to get the effect of a C-q. (These aliases work by means of keyboard translations; see AD.5 Keyboard Translations.)
AD.9.6 Running out of Memory
If you get the error message `Virtual memory exceeded', save your modified buffers with C-x s. This method of saving them has the smallest need for additional memory. Emacs keeps a reserve of memory which it makes available when this error happens; that should be enough to enable C-x s to complete its work.
Once you have saved your modified buffers, you can exit this Emacs job and start another, or you can use M-x kill-some-buffers to free space in the current Emacs job. If you kill buffers containing a substantial amount of text, you can safely go on editing. Emacs refills its memory reserve automatically when it sees sufficient free space available, in case you run out of memory another time.
Do not use M-x buffer-menu to save or kill buffers when you run out of memory, because the buffer menu needs a fair amount of memory itself, and the reserve supply may not be enough.
AD.9.7 Recovery After a Crash
If Emacs or the computer crashes, you can recover the files you were editing at the time of the crash from their auto-save files. To do this, start Emacs again and type the command M-x recover-session.
This command initially displays a buffer which lists interrupted session files, each with its date. You must choose which session to recover from. Typically the one you want is the most recent one. Move point to the one you choose, and type C-c C-c.
AD.9.8 Emergency Escape
Because at times there have been bugs causing Emacs to loop without
When you resume Emacs after a suspension caused by multiple C-g, it asks two questions before going back to what it had been doing:
Answer each one with y or n followed by RET.
Saying y to `Auto-save?' causes immediate auto-saving of all modified buffers in which auto-saving is enabled.
Saying y to `Abort (and dump core)?' causes an illegal instruction to be
executed, dumping core. This is to enable a wizard to figure out why Emacs
was failing to quit in the first place. Execution does not continue
after a core dump. If you answer n, execution does continue. With
luck, GNU Emacs will ultimately check
If Emacs is not really hung, just slow, you may invoke the double C-g feature without really meaning to. Then just resume and answer n to both questions, and you will arrive at your former state. Presumably the quit you requested will happen soon.
The double C-g feature is turned off when Emacs is running under the X Window System, since you can use the window manager to kill Emacs or to create another window and run another program.
On MS-DOS and compatible systems, the emergency escape feature is sometimes unavailable, even if you press C-BREAK twice, when some system call (MS-DOS or BIOS) hangs, or when Emacs is stuck in a very tight endless loop (in C code, not in Lisp code).
AD.9.9 Help for Total Frustration
If using Emacs (or something else) becomes terribly frustrating and none of the techniques described above solve the problem, Emacs can still help you.
First, if the Emacs you are using is not responding to commands, type C-g C-g to get out of it and then start a new one.
The doctor will help you feel better. Each time you say something to the doctor, you must end it by typing RET RET. This lets the doctor know you are finished.
AD.10 Reporting Bugs
Sometimes you will encounter a bug in Emacs. Although we cannot promise we can or will fix the bug, and we might not even agree that it is a bug, we want to hear about problems you encounter. Often we agree they are bugs and want to fix them.
To make it possible for us to fix a bug, you must report it. In order to do so effectively, you must know when and how to do it.
Before reporting a bug, it is a good idea to see if it is already known. You can find the list of known problems in the file `etc/PROBLEMS' in the Emacs distribution; type C-h P to read it. Some additional user-level problems can be found in section `Bugs and problems' in GNU Emacs FAQ. Looking up your problem in these two documents might provide you with a solution or a work-around, or give you additional information about related issues.
AD.10.1 When Is There a Bug
If Emacs executes an illegal instruction, or dies with an operating system error message that indicates a problem in the program (as opposed to something like "disk full"), then it is certainly a bug.
If Emacs updates the display in a way that does not correspond to what is in the buffer, then it is certainly a bug. If a command seems to do the wrong thing but the problem corrects itself if you type C-l, it is a case of incorrect display updating.
Taking forever to complete a command can be a bug, but you must make certain that it was really Emacs's fault. Some commands simply take a long time. Type C-g (C-BREAK on MS-DOS) and then C-h l to see whether the input Emacs received was what you intended to type; if the input was such that you know it should have been processed quickly, report a bug. If you don't know whether the command should take a long time, find out by looking in the manual or by asking for assistance.
If a command you are familiar with causes an Emacs error message in a case where its usual definition ought to be reasonable, it is probably a bug.
If a command does the wrong thing, that is a bug. But be sure you know for certain what it ought to have done. If you aren't familiar with the command, or don't know for certain how the command is supposed to work, then it might actually be working right. Rather than jumping to conclusions, show the problem to someone who knows for certain.
Finally, a command's intended definition may not be the best possible definition for editing with. This is a very important sort of problem, but it is also a matter of judgment. Also, it is easy to come to such a conclusion out of ignorance of some of the existing features. It is probably best not to complain about such a problem until you have checked the documentation in the usual ways, feel confident that you understand it, and know for certain that what you want is not available. If you are not sure what the command is supposed to do after a careful reading of the manual, check the index and glossary for any terms that may be unclear.
If after careful rereading of the manual you still do not understand what the command should do, that indicates a bug in the manual, which you should report. The manual's job is to make everything clear to people who are not Emacs experts--including you. It is just as important to report documentation bugs as program bugs.
If the on-line documentation string of a function or variable disagrees with the manual, one of them must be wrong; that is a bug.
AD.10.2 Understanding Bug Reporting
When you decide that there is a bug, it is important to report it and to report it in a way which is useful. What is most useful is an exact description of what commands you type, starting with the shell command to run Emacs, until the problem happens.
The most important principle in reporting a bug is to report facts. Hypotheses and verbal descriptions are no substitute for the detailed raw data. Reporting the facts is straightforward, but many people strain to posit explanations and report them instead of the facts. If the explanations are based on guesses about how Emacs is implemented, they will be useless; meanwhile, lacking the facts, we will have no real information about the bug.
For example, suppose that you type C-x C-f /glorp/baz.ugh RET, visiting a file which (you know) happens to be rather large, and Emacs displayed `I feel pretty today'. The best way to report the bug is with a sentence like the preceding one, because it gives all the facts.
A bad way would be to assume that the problem is due to the size of the file and say, "I visited a large file, and Emacs displayed `I feel pretty today'." This is what we mean by "guessing explanations." The problem is just as likely to be due to the fact that there is a `z' in the file name. If this is so, then when we got your report, we would try out the problem with some "large file," probably with no `z' in its name, and not see any problem. There is no way in the world that we could guess that we should try visiting a file with a `z' in its name.
Alternatively, the problem might be due to the fact that the file starts with exactly 25 spaces. For this reason, you should make sure that you inform us of the exact contents of any file that is needed to reproduce the bug. What if the problem only occurs when you have typed the C-x C-a command previously? This is why we ask you to give the exact sequence of characters you typed since starting the Emacs session.
You should not even say "visit a file" instead of C-x C-f unless you know that it makes no difference which visiting command is used. Similarly, rather than saying "if I have three characters on the line," say "after I type RET A B C RET C-p," if that is the way you entered the text.
So please don't guess any explanations when you report a bug. If you want to actually debug the problem, and report explanations that are more than guesses, that is useful--but please include the facts as well.
AD.10.3 Checklist for Bug Reports
The best way to send a bug report is to mail it electronically to the Emacs maintainers at firstname.lastname@example.org, or to email@example.com if you are pretesting an Emacs beta release. (If you want to suggest a change as an improvement, use the same address.)
If you'd like to read the bug reports, you can find them on the newsgroup `gnu.emacs.bug'; keep in mind, however, that as a spectator you should not criticize anything about what you see there. The purpose of bug reports is to give information to the Emacs maintainers. Spectators are welcome only as long as they do not interfere with this. In particular, some bug reports contain fairly large amounts of data; spectators should not complain about this.
Please do not post bug reports using netnews; mail is more reliable than netnews about reporting your correct address, which we may need in order to ask you for more information. If your data is more than 500,000 bytes, please don't include it directly in the bug report; instead, offer to send it on request, or make it available by ftp and say where.
If you can't send electronic mail, then mail the bug report on paper or machine-readable media to this address:
We do not promise to fix the bug; but if the bug is serious, or ugly, or easy to fix, chances are we will want to.
A convenient way to send a bug report for Emacs is to use the command M-x report-emacs-bug. This sets up a mail buffer (see section Z. Sending Mail) and automatically inserts some of the essential information. However, it cannot supply all the necessary information; you should still read and follow the guidelines below, so you can enter the other crucial information by hand before you send the message.
To enable maintainers to investigate a bug, your report should include all these things:
Here are some things that are not necessary in a bug report:
AD.10.4 Sending Patches for GNU Emacs
If you would like to write bug fixes or improvements for GNU Emacs, that is very helpful. When you send your changes, please follow these guidelines to make it easy for the maintainers to use them. If you don't follow these guidelines, your information might still be useful, but using it will take extra work. Maintaining GNU Emacs is a lot of work in the best of circumstances, and we can't keep up unless you do your best to help.
AD.11 Contributing to Emacs Development
If you would like to help pretest Emacs releases to assure they work well, or if you would like to work on improving Emacs, please contact the maintainers at firstname.lastname@example.org. A pretester should be prepared to investigate bugs as well as report them. If you'd like to work on improving Emacs, please ask for suggested projects or suggest your own ideas.
If you have already written an improvement, please tell us about it. If you have not yet started work, it is useful to contact email@example.com before you start; it might be possible to suggest ways to make your extension fit in better with the rest of Emacs.
AD.12 How To Get Help with GNU Emacs
If you need help installing, using or changing GNU Emacs, there are two ways to find it:
This document was generated on April 2, 2002 using texi2html
Services: Texas Internet Consultant
|Electric Speed: SEO|