summaryrefslogtreecommitdiff
path: root/lisp/keymap.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2025-01-11 07:44:23 -0500
committerEli Zaretskii <eliz@gnu.org>2025-01-11 07:44:23 -0500
commit3d960c16c60da14a07da538cc2468f46425df634 (patch)
tree05eecbbec1a8b784e877790abe4716f0adb602ad /lisp/keymap.el
parent5060bf6ed64a6e96b4c660e6ad5204a23133b71d (diff)
parentd66b8d4becb6804d3bd912a000dc64ccfdbe6810 (diff)
downloademacs-3d960c16c60da14a07da538cc2468f46425df634.tar.gz
emacs-3d960c16c60da14a07da538cc2468f46425df634.tar.bz2
emacs-3d960c16c60da14a07da538cc2468f46425df634.zip
Merge from origin/emacs-30
d66b8d4becb Fix checkbox's child creation 26c5fadf474 Document that 'package-vc' doesn't support built-in packages ee61b9a050b ; Fix documentation of completion commands ce43d13593a ; Simplify admin/run-codespell fa1470d0699 ; Remove duplicated word in files.el Commentary dabaea97465 Improve checkdoc-common-verbs-wrong-voice docstring 6de2ee5663d Document string-as-{unibyte,multibyte} as obsolete in manual 7f76f872ebf Fix go-ts-mode var spec indentation (Bug#75362) 01464fc882d Add "text" as a thing in tsx-ts-mode 59c57337923 Improve doc string of 'package-delete' 313a191d047 ; * admin/MAINTAINERS: Remove Kelvin White. 002960ceabf Clarify that 'mac' line ending convention is not used on ... 4210e065648 Add language server for Odin ee1034422b0 ; Improve documentation of function-type display 1c49edc4080 Modernize "Commentary" section of files.el 505c1123e18 * INSTALL: Add advice how to invoke 'make install'. (Bug... 82e16cae9cc Improve the documentation of 'key-valid-p' # Conflicts: # etc/NEWS # lisp/progmodes/typescript-ts-mode.el
Diffstat (limited to 'lisp/keymap.el')
-rw-r--r--lisp/keymap.el15
1 files changed, 10 insertions, 5 deletions
diff --git a/lisp/keymap.el b/lisp/keymap.el
index 3aed1d4b4ca..d1ff52ea397 100644
--- a/lisp/keymap.el
+++ b/lisp/keymap.el
@@ -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.
Each key stroke is either a single character, or the name of an
-event, surrounded by angle brackets <like-this>. 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.
+event, surrounded by angle brackets <like-this>. An event may be
+pushing a key, clicking on a menu item, pressing a mouse button, etc.
+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.
\"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')
\"C-c o\" (a two-key sequence: the key `c' with the control modifier
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)
\"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.
Modifiers have to be specified in this order: