3.30 Key bindings

The commands for modifying key bindings that are described below are designed to be invoked explicitly during each session with the Editor. If the user wishes to create key bindings which are set up every session, the function editor:bind-key should be used--see Customizing default key bindings.

Bind Key

Editor Command

Argument: command key-sequence bind-type
Key sequence: None

Binds command (full command names must be used) to key-sequence .

After entering command , enter the keys of key-sequence and press Return .

bind-type can be either buffer, global or mode. If a bind-type of buffer or mode is selected, the name of the buffer or mode required must then be entered. When a bind-type of buffer is selected, the current buffer is offered as a default. The default value for bind-type is "Global".

Unless a bind type of global is selected, the scope of the new key binding is restricted as specified. Generally, most key bindings are global. Note that the Echo Area is defined as a mode, and some commands (especially those involving completion) are restricted to the Echo Area.

Bind String to Key

Editor Command

Argument: string key-sequence bind-type
Key sequence: None

Make key-sequence insert string .

After entering string , enter the keys of key-sequence and press Return .

bind-type is interpreted as in Bind Key.

Delete Key Binding

Editor Command

Argument: key-sequence bind-type
Key sequence: None

Removes a key binding, so that the key sequence no longer invokes any command. The argument bind-type can be either buffer, global or mode. If a bind-type of buffer or mode is selected, the name of the buffer or mode required must then be entered. The default value for bind-type is "Global".

It is necessary to enter the kind of binding, because a single key sequence may sometimes be bound differently in different buffers and modes.

Illegal

Editor Command

Argument: None
Key sequence: None

Signals an editor error with the message "Illegal command in the current mode" accompanied by a beep. It is sometimes useful to bind key sequences to this command, to ensure the key sequence is not otherwise bound.

Do Nothing

Editor Command

Argument: None
Key sequence: None

Does nothing. This is therefore similar to Illegal, except that there is no beep and no error message.