diff options
author | Po Lu <luangruo@yahoo.com> | 2024-03-16 15:12:33 +0800 |
---|---|---|
committer | Po Lu <luangruo@yahoo.com> | 2024-03-16 15:12:33 +0800 |
commit | 4d03f70b7f01477a8d72f827ba8b0dabba8c0a61 (patch) | |
tree | 7b078e0a8d64f9cfde1688e2c31a553b49c87b57 /src | |
parent | c77e35efd36f2c43e87066faa4257606d5c6f849 (diff) | |
download | emacs-4d03f70b7f01477a8d72f827ba8b0dabba8c0a61.tar.gz |
Correct doc strings for x-*-keysym
* src/xterm.c (syms_of_xterm): Clarify whether x-*-keysym
affects the modifier key reported for a keysym or the other way
around.
Diffstat (limited to 'src')
-rw-r--r-- | src/xterm.c | 42 |
1 files changed, 22 insertions, 20 deletions
diff --git a/src/xterm.c b/src/xterm.c index c8a43785564..bebc30c9103 100644 --- a/src/xterm.c +++ b/src/xterm.c @@ -32536,38 +32536,40 @@ Android does not support scroll bars at all. */); DEFSYM (Qreally_fast, "really-fast"); DEFVAR_LISP ("x-ctrl-keysym", Vx_ctrl_keysym, - doc: /* Which keys Emacs uses for the ctrl modifier. -This should be one of the symbols `ctrl', `alt', `hyper', `meta', -`super'. For example, `ctrl' means use the Ctrl_L and Ctrl_R keysyms. -The default is nil, which is the same as `ctrl'. */); + doc: /* Which modifer value Emacs reports when Ctrl is depressed. +This should be one of the symbols `ctrl', `alt', `hyper', `meta', or +`super', representing a modifier to be reported in key events with the +Ctrl modifier (i.e. the keysym Ctrl_L or Ctrl_R) depressed. */); Vx_ctrl_keysym = Qnil; DEFVAR_LISP ("x-alt-keysym", Vx_alt_keysym, - doc: /* Which keys Emacs uses for the alt modifier. -This should be one of the symbols `ctrl', `alt', `hyper', `meta', -`super'. For example, `alt' means use the Alt_L and Alt_R keysyms. -The default is nil, which is the same as `alt'. */); + doc: /* Which modifer value Emacs reports when Alt is depressed. +This should be one of the symbols `ctrl', `alt', `hyper', `meta', or +`super', representing a modifier to be reported in key events with the +Alt modifier (e.g. the keysym Alt_L or Alt_R, if the keyboard features a +dedicated key for Meta) depressed. */); Vx_alt_keysym = Qnil; DEFVAR_LISP ("x-hyper-keysym", Vx_hyper_keysym, - doc: /* Which keys Emacs uses for the hyper modifier. -This should be one of the symbols `ctrl', `alt', `hyper', `meta', -`super'. For example, `hyper' means use the Hyper_L and Hyper_R -keysyms. The default is nil, which is the same as `hyper'. */); + doc: /* Which modifer value Emacs reports when Hyper is depressed. +This should be one of the symbols `ctrl', `alt', `hyper', `meta', or +`super', representing a modifier to be reported in key events with the +Hyper modifier (i.e. the keysym Hyper_L or Hyper_R) depressed. */); Vx_hyper_keysym = Qnil; DEFVAR_LISP ("x-meta-keysym", Vx_meta_keysym, - doc: /* Which keys Emacs uses for the meta modifier. -This should be one of the symbols `ctrl', `alt', `hyper', `meta', -`super'. For example, `meta' means use the Meta_L and Meta_R keysyms. -The default is nil, which is the same as `meta'. */); + doc: /* Which modifer value Emacs reports when Meta is depressed. +This should be one of the symbols `ctrl', `alt', `hyper', `meta', or +`super', representing a modifier to be reported in key events with the +Meta modifier (e.g. the keysym Alt_L or Alt_R, when the keyboard does +not feature a dedicated key for Meta) depressed. */); Vx_meta_keysym = Qnil; DEFVAR_LISP ("x-super-keysym", Vx_super_keysym, - doc: /* Which keys Emacs uses for the super modifier. -This should be one of the symbols `ctrl', `alt', `hyper', `meta', -`super'. For example, `super' means use the Super_L and Super_R -keysyms. The default is nil, which is the same as `super'. */); + doc: /* Which modifer value Emacs reports when Super is depressed. +This should be one of the symbols `ctrl', `alt', `hyper', `meta', or +`super', representing a modifier to be reported in key events with the +Super modifier (i.e. the keysym Super_L or Super_R) depressed. */); Vx_super_keysym = Qnil; DEFVAR_LISP ("x-wait-for-event-timeout", Vx_wait_for_event_timeout, |