describe-key(2)

NAME

describe-key - Report keyboard key name and binding

SYNOPSIS

n describe-key "key" (C-x ?) 

DESCRIPTION

describe-key allows a key to be typed and it will report the name of the command bound to that key (if any) and the internal key-code. This command is useful when trying to locate the identity of keyboard keys for binding. The $result(5) variable is set to the bound command or an empty string if the key is not bound.

The numeric argument n is used to modify the default behavior of the command, where the bits are defined as follows:

0x01


When this bit is not set all messages to the message-line are suppressed enabling it to be used in macro code as a way of determining if a key is currently bound.

0x02


If this bit is set then message-line bindings are included in the lookup rather than buffer bindings.

0x04


If this bit is set then current buffer bindings are not included in the key lookup.

SEE ALSO

command-apropos(2), global-bind-key(2), buffer-bind-key(2), ml-bind-key(2), describe-bindings(2), describe-variable(2), $result(5).

(c) Copyright JASSPA 2025
Last Modified: 2023/06/29
Generated On: 2025/09/29