From f9504b4fba75b44a1a195ef503654e1ed9a1371e Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Fri, 6 Sep 2024 22:43:26 +0530 Subject: [PATCH] Document the new click_events parameter for the shell integration protocol --- docs/shell-integration.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/shell-integration.rst b/docs/shell-integration.rst index 103b8eefb..b403139fc 100644 --- a/docs/shell-integration.rst +++ b/docs/shell-integration.rst @@ -456,6 +456,13 @@ to control its behavior, separated by semi-colons. They are:: k=s - this tells kitty that the secondary (PS2) prompt is starting at the current line. + click_events=1 - this tells kitty that the shell is capable of handling + mouse click events. kitty will thus send a click event to the shell when + the user clicks somewhere in the prompt. The shell can then move the cursor + to that position or perform some other appropriate action. Without this, + kitty will instead generate a number of fake key events to move the cursor + to the clicked location, which is not fully robust. + kitty also optionally supports sending the cmdline going to be executed with ``133;C`` as:: 133;C;cmdline=cmdline encoded by %q