masscollaborationlabs/emacs
2
0
Fork 0
mirror of https://github.com/masscollaborationlabs/emacs.git synced 2025-07-04 11:23:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve the documentation of 'key-valid-p'

Browse source 
* lisp/keymap.el (key-valid-p): Add an function key and mouse
button example.  Mention '<left>' as a cursor control key
instead of a function key.  Briefly explain what an event may
be.  (Bug#75366)
This commit is contained in:
Hong Xu 2025-01-04 12:32:24 -08:00 • committed by Eli Zaretskii
parent 6468c3f7a7
commit 82e16cae9c
1 changed files with 10 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

15
lisp/keymap.el
View file

@ -327,21 +327,26 @@ KEYS should be a string consisting of one or more key strokes,
with a single space character separating one key stroke from another. with a single space character separating one key stroke from another.
Each key stroke is either a single character, or the name of an Each key stroke is either a single character, or the name of an
event, surrounded by angle brackets <like-this>. In addition, any event, surrounded by angle brackets <like-this>. An event may be
key stroke may be preceded by one or more modifier keys. Finally, pushing a key, clicking on a menu item, pressing a mouse button, etc.
a limited number of characters have a special shorthand syntax. In addition, any key stroke may be preceded by one or more modifier
keys. Finally, a limited number of characters have a special shorthand
syntax.
Here are some example of valid key sequences. Here are some example of valid key sequences.
\"f\" (the key `f') \"f\" (the key `f')
\"<f6>\" (the function key named \"F6\")
\"<mouse-1>\" (the mouse button named \"mouse-1\", commonly referred to as
the left button)
\"S o m\" (a three-key sequence of the keys `S', `o' and `m') \"S o m\" (a three-key sequence of the keys `S', `o' and `m')
\"C-c o\" (a two-key sequence: the key `c' with the control modifier \"C-c o\" (a two-key sequence: the key `c' with the control modifier
followed by the key `o') followed by the key `o')
\"H-<left>\" (the function key named \"left\" with the hyper modifier) \"H-<left>\" (the cursor control key named \"left\" with the hyper modifier)
\"M-RET\" (the \"return\" key with a meta modifier) \"M-RET\" (the \"return\" key with a meta modifier)
\"C-M-<space>\" (the \"space\" key with both the control and meta modifiers) \"C-M-<space>\" (the \"space\" key with both the control and meta modifiers)
These are the characters that have special shorthand syntax: These characters have special shorthand syntax:
NUL, RET, TAB, LFD, ESC, SPC, DEL. NUL, RET, TAB, LFD, ESC, SPC, DEL.
Modifiers have to be specified in this order: Modifiers have to be specified in this order: