KittyPatch/kitty
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Document the kitty protocol extensions

Browse Source
This commit is contained in:
Kovid Goyal 2017-01-17 12:58:31 +05:30
parent 2ed898c142
commit ede002a82d
2 changed files with 42 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.asciidoc
View File

@ -263,6 +263,11 @@ focus
launch emacs
....
== Protocol Extensions
kitty has a few extensions to the xterm protocol, to enable advanced features,
see link:protocol-extensions.asciidoc[Protocol Extensions].
== Note for linux/OS X packagers
While kitty does use python, it is not a traditional python package, so please do not install it in site-packages.

37
protocol-extensions.asciidoc Normal file
View File

@ -0,0 +1,37 @@
= Extensions to the xterm protocol
kitty has a few extensions to the xterm protocol, to enable advanced features.
These are typically in the form of new or re-purposed escape codes. While these
extensions are currently kitty specific, it would be nice to get some of them
adopted more broadly.
toc::[]
== Colored and styled underlines
kitty supports colored and styled (wavy) underlines. This is of particular use
in terminal editors such as vim and emacs to display red, wavy underlines under
mis-spelled words and/or syntax errors. This is done by re-purposing some SGR escape codes
that are not used in modern terminals (https://en.wikipedia.org/wiki/ANSI_escape_code#CSI_codes)
To change the underline style from straight line to curl (this used to be the
code for rapid blinking text, only support in MS-DOS ANSI.sys):
```
<ESC>[6m
```
To set the underline color (this is reserved and as far as I can tell not actually used for anything):
```
<ESC>[58...m
```
This works exactly like the codes `38, 48` that are used to set foreground and
background color respectively.
To reset the underline color (also previously reserved and unused):
```
<ESC>[59m
```