Variable: xterm--auto-xt-mouse-allowed-names

xterm--auto-xt-mouse-allowed-names is a variable defined in xterm.el.gz.

Value

"\\`\\(?:Konsole\\|WezTerm\\|iTerm2\\|kitty\\)\\>"

Documentation

Regexp for terminals that automatically enable xterm-mouse-mode(var)/xterm-mouse-mode(fun) at startup.

This will get matched against the terminal's XTVERSION string.

It is expected that any matching terminal supports the following functionality:

"Set selection data" (OSC52): Allows Emacs to set the OS clipboard.
"Get selection data" (OSC52 or bracketed paste): Allows Emacs to get
    the contents of the OS clipboard.
"Basic mouse mode" (DECSET1000): Allows Emacs to get events on mouse
    clicks.
"Mouse motion mode" (DECSET1003): Allows Emacs to get event on mouse
    motion.

Also see xterm--auto-xt-mouse-allowed-types which matches against the value of TERM instead. If either xterm--auto-xt-mouse-allowed-names or xterm--auto-xt-mouse-allowed-types matches, then xterm-mouse-mode(var)/xterm-mouse-mode(fun) will get enabled automatically.

Source Code

;; Defined in /usr/src/emacs/lisp/term/xterm.el.gz
(defconst xterm--auto-xt-mouse-allowed-names
  (rx string-start
      (or "Konsole"
          "WezTerm"
          ;; "XTerm"   ;Disabled because OSC52 support is opt-in only.
          "iTerm2"     ;OSC52 support has opt-in/out UI on first usage
          "kitty")
      word-end)
  "Regexp for terminals that automatically enable `xterm-mouse-mode' at startup.
This will get matched against the terminal's XTVERSION string.

It is expected that any matching terminal supports the following
functionality:

\"Set selection data\" (OSC52): Allows Emacs to set the OS clipboard.
\"Get selection data\" (OSC52 or bracketed paste): Allows Emacs to get
    the contents of the OS clipboard.
\"Basic mouse mode\" (DECSET1000): Allows Emacs to get events on mouse
    clicks.
\"Mouse motion mode\" (DECSET1003): Allows Emacs to get event on mouse
    motion.

Also see `xterm--auto-xt-mouse-allowed-types' which matches against the
value of TERM instead.  If either `xterm--auto-xt-mouse-allowed-names'
or `xterm--auto-xt-mouse-allowed-types' matches, then `xterm-mouse-mode'
will get enabled automatically.")