ayo/kitty
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document the new click_events parameter for the shell integration protocol

Browse source
This commit is contained in:
Kovid Goyal 2024-09-06 22:43:26 +05:30
parent b479089619
commit f9504b4fba
No known key found for this signature in database
GPG key ID: 06BC317B515ACE7C
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/shell-integration.rst
View file

@ -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 ``<OSC>133;C`` as::
<OSC>133;C;cmdline=cmdline encoded by %q<ST>