@key
{key-name}
Use the @key
command for the conventional name for a key on a
keyboard, as in:
@key{RET}
You can use the @key
command within the argument of an
@kbd
command when the sequence of characters to be typed
includes one or more keys that are described by name.
For example, to produce C-x ESC you would type:
@kbd{C-x @key{ESC}}
Here is a list of the recommended names for keys; they are all in upper case:
- SPC
- Space
- RET
- Return
- LFD
- Linefeed
- TAB
- Tab
- BS
- Backspace
- ESC
- Escape
- DEL
- Delete
- SFT
- Shift
- CTL
- Control
- META
- Meta
There are subtleties to handling words like `meta' or `ctl' that are
names of shift keys. When mentioning a character in which the shift
key is used, such as Meta-a, use the @kbd
command alone;
do not use the @key
command; but when you are referring to the
shift key in isolation, use the @key
command. For example,
write `@kbd{Meta-a}' to produce Meta-a and
`@key{META}' to produce META. This is because
Meta-a refers to keys that you press on a keyboard, but
META refers to a key without implying that you press it. In
short, use @kbd
for what you do, and use @key
for what
you talk about: "Press @kbd{M-a}
to move point to the
beginning of the sentence. The @key{META}
key is often in the
lower left of the keyboard."