<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/key-encoding.md - fork/wezterm @ vtparse-0.7.0</title>
<meta name="description" content="docs/config/key-encoding.md in fork/wezterm at vtparse-0.7.0.">
<meta property="og:title" content="docs/config/key-encoding.md - fork/wezterm @ vtparse-0.7.0">
<meta property="og:description" content="docs/config/key-encoding.md in fork/wezterm at vtparse-0.7.0.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="vtparse-0.7.0" data-tip="3bfe6df191af37bc33fe5fe6de12a40f7067f101">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/wezterm</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/wezterm</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Wez Furlong</span><span class="commit-message" data-commit="40081cb5737da32058a3c87e14b84d8f2bfefdc4">docs: update a bunch of since lines to new macro</span><span class="snapshot-sha sha" data-commit="40081cb5737da32058a3c87e14b84d8f2bfefdc4">40081cb57</span><time datetime="2023-03-20T22:01:24-07:00" title="2023-03-20 22:01:24 -0700">2023-03-20</time></p>
<header class="topbar"><details class="switcher"><summary>vtparse-0.7.0</summary><div class="menu"><strong>branches</strong><a href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a href="/fork/wezterm/ref/termiz-0.23.1/">termiz-0.23.1</a><a href="/fork/wezterm/ref/termiz-0.23.2/">termiz-0.23.2</a><a href="/fork/wezterm/ref/termiz-0.23.3/">termiz-0.23.3</a><a href="/fork/wezterm/ref/termwiz-0.23.0/">termwiz-0.23.0</a><a href="/fork/wezterm/ref/termwiz-0.23.1/">termwiz-0.23.1</a><a href="/fork/wezterm/ref/termwiz-0.23.2/">termwiz-0.23.2</a><a href="/fork/wezterm/ref/termwiz-0.23.3/">termwiz-0.23.3</a><a class="current" href="/fork/wezterm/ref/vtparse-0.7.0/">vtparse-0.7.0</a><a class="all" href="/fork/wezterm/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/wezterm/">wezterm</a> / <a href="/fork/wezterm/ref/vtparse-0.7.0/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/vtparse-0.7.0/tree/docs/config/">config</a> / <span class="cur">key-encoding.md</span></nav>
<span class="view-stats"><span>3.5 KiB</span><span>77 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/09a7805dfdbac42d5d12e184e848f44fce28caa9/docs/config/key-encoding.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Keyboard Encoding</h1>
<p>When input that doesn't match a key assignment is processed, it is encoded into
a byte stream and sent to the PTY associated with the program that is running
in the active pane.</p>
<p>The default encoding scheme used by wezterm is xterm compatible, but there are
some configuration options that can modify the encoding.</p>
<p>The standard xterm compatible encoding generates events for key presses (but
not releases) and can represent the set of keys that existed on terminal
hardware of the 1980's.</p>
<p>That scheme has worked well for quite some time, but has some ambiguity due
to the way that the Control modifier "shifts" the ASCII representation of
keypresses like <code>Control-I</code> to be ASCII Tab, as an example.</p>
<h2>xterm <code>modifyOtherKeys</code></h2>
<p>{{since('20221119-145034-49b9839f')}}</p>
<p>When wezterm receives the sequence <code>CSI &gt;4;Nm</code>, where <code>N</code> is <code>0</code>, <code>1</code> or <code>2</code>,
the keyboard encoding is changed according to
<a href="https://invisible-island.net/xterm/manpage/xterm.html#VT100-Widget-Resources:modifyOtherKeys">modifyOtherKeys</a>,
which causes certain modified keys to be encoded as <a href="https://invisible-island.net/xterm/modified-keys.html">described in xterms
docs</a>, making it
possible for applications to distinguish between the modified and unmodified
key presses.</p>
<p>Note that <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/config/enable_csi_u_key_encoding.md">enable_csi_u_key_encoding</a>
and <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/config/allow_win32_input_mode.md">allow_win32_input_mode</a> both take
precedence over this behavior.</p>
<h2>CSI-u/fixterms/libtickit</h2>
<p><a href="http://www.leonerd.org.uk/hacks/fixterms/">Fix Keyboard Input on Terminals</a> is
an attempt at resolving the ambiguous encoding and doing a better job at
representing more modifiers. It's not a perfect attempt as there are <a href="https://sw.kovidgoyal.net/kitty/keyboard-protocol/#bugs-in-fixterms">a number
of issues with
it</a>.</p>
<p>You can enable support for this encoding by setting <code>enable_csi_u_key_encoding = true</code>, however, it is not recommended as it does change the behavior of some
keys in backwards incompatible ways and there isn't a way for applications to
detect or request this behavior.</p>
<p>See also: <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/config/enable_csi_u_key_encoding.md">enable_csi_u_key_encoding</a>.</p>
<p>Note that <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/config/allow_win32_input_mode.md">allow_win32_input_mode</a> takes
precedence over this option.</p>
<h2>Kitty Keyboard Protocol</h2>
<p>The Kitty terminal extended and enhanced the CSI-u based encoding scheme with
its <a href="https://sw.kovidgoyal.net/kitty/keyboard-protocol/">Comprehensive keyboard handling
protocol</a>.</p>
<p>The kitty protocol allows applications to request varying degrees of
enhancement over the standard encoding scheme and also allows for more modifier
keys (notably: <code>CMD</code>/<code>Super</code>/<code>Windows</code>) to be reported to the application.</p>
<p><a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/config/enable_kitty_keyboard.md">enable_kitty_keyboard</a> controls whether
wezterm will honor the application requests to modify the keyboard encoding.</p>
<h2>Windows</h2>
<p>On Windows, <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/config/allow_win32_input_mode.md">allow_win32_input_mode</a>
defaults to <code>true</code> which causes wezterm to listen for an escape sequence
generated by the ConPTY layer of Windows to enable <a href="https://github.com/microsoft/terminal/blob/main/doc/specs/%234999%20-%20Improved%20keyboard%20handling%20in%20Conpty.md">Win32 Input Mode</a>.</p>
<p>In this mode, key release events as well as events that can distinguish between
positional (left/right) modifier keys are generated and this mode provides the
best compatibility with win32 console applications such as Far Manager.</p>
<p><code>allow_win32_input_mode</code> takes precedence over
<a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/config/enable_csi_u_key_encoding.md">enable_csi_u_key_encoding</a>.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Keyboard Encoding</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">When input that doesn&#39;t match a key assignment is processed, it is encoded into</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">a byte stream and sent to the PTY associated with the program that is running</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">in the active pane.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">The default encoding scheme used by wezterm is xterm compatible, but there are</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">some configuration options that can modify the encoding.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">The standard xterm compatible encoding generates events for key presses (but</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">not releases) and can represent the set of keys that existed on terminal</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">hardware of the 1980&#39;s.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">That scheme has worked well for quite some time, but has some ambiguity due</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">to the way that the Control modifier &quot;shifts&quot; the ASCII representation of</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">keypresses like `Control-I` to be ASCII Tab, as an example.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>##</a-p> <a-tt>xterm `modifyOtherKeys`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">{{since(&#39;20221119-145034-49b9839f&#39;)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">When wezterm receives the sequence `CSI &gt;4;Nm`, where `N` is `0`, `1` or `2`,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">the keyboard encoding is changed according to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">[modifyOtherKeys](https://invisible-island.net/xterm/manpage/xterm.html#VT100-Widget-Resources:modifyOtherKeys),</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">which causes certain modified keys to be encoded as [described in xterms</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">docs](https://invisible-island.net/xterm/modified-keys.html), making it</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">possible for applications to distinguish between the modified and unmodified</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text">key presses.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text">Note that [enable_csi_u_key_encoding](lua/config/enable_csi_u_key_encoding.md)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text">and [allow_win32_input_mode](lua/config/allow_win32_input_mode.md) both take</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text">precedence over this behavior.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>##</a-p> <a-tt>CSI-u/fixterms/libtickit</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text">[Fix Keyboard Input on Terminals](http://www.leonerd.org.uk/hacks/fixterms/) is</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text">an attempt at resolving the ambiguous encoding and doing a better job at</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text">representing more modifiers. It&#39;s not a perfect attempt as there are [a number</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text">of issues with</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text">it](https://sw.kovidgoyal.net/kitty/keyboard-protocol/#bugs-in-fixterms).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text">You can enable support for this encoding by setting `enable_csi_u_key_encoding</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text">= true`, however, it is not recommended as it does change the behavior of some</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text">keys in backwards incompatible ways and there isn&#39;t a way for applications to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text">detect or request this behavior.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text">See also: [enable_csi_u_key_encoding](lua/config/enable_csi_u_key_encoding.md).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text">Note that [allow_win32_input_mode](lua/config/allow_win32_input_mode.md) takes</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text">precedence over this option.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>##</a-p> <a-tt>Kitty Keyboard Protocol</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text">The Kitty terminal extended and enhanced the CSI-u based encoding scheme with</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text">its [Comprehensive keyboard handling</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text">protocol](https://sw.kovidgoyal.net/kitty/keyboard-protocol/).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text">The kitty protocol allows applications to request varying degrees of</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text">enhancement over the standard encoding scheme and also allows for more modifier</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text">keys (notably: `CMD`/`Super`/`Windows`) to be reported to the application.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text">[enable_kitty_keyboard](lua/config/enable_kitty_keyboard.md) controls whether</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text">wezterm will honor the application requests to modify the keyboard encoding.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>##</a-p> <a-tt>Windows</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text">On Windows, [allow_win32_input_mode](lua/config/allow_win32_input_mode.md)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text">defaults to `true` which causes wezterm to listen for an escape sequence</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text">generated by the ConPTY layer of Windows to enable [Win32 Input Mode](https://github.com/microsoft/terminal/blob/main/doc/specs/%234999%20-%20Improved%20keyboard%20handling%20in%20Conpty.md).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text">In this mode, key release events as well as events that can distinguish between</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text">positional (left/right) modifier keys are generated and this mode provides the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text">best compatibility with win32 console applications such as Far Manager.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text">`allow_win32_input_mode` takes precedence over</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text">[enable_csi_u_key_encoding](lua/config/enable_csi_u_key_encoding.md).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
