<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/keys.md - fork/wezterm @ termwiz-0.23.2</title>
<meta name="description" content="docs/config/keys.md in fork/wezterm at termwiz-0.23.2.">
<meta property="og:title" content="docs/config/keys.md - fork/wezterm @ termwiz-0.23.2">
<meta property="og:description" content="docs/config/keys.md in fork/wezterm at termwiz-0.23.2.">
<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="termwiz-0.23.2" data-tip="8b7ca454b5e0a65b69b1b736db54eae3c195384b">
<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="30ef02ff56477df287f99adec35a33c87ea1efb3">docs: add docs for anti_alias_custom_block_glyphs</span><span class="snapshot-sha sha" data-commit="30ef02ff56477df287f99adec35a33c87ea1efb3">30ef02ff5</span><time datetime="2023-05-28T08:44:54-07:00" title="2023-05-28 08:44:54 -0700">2023-05-28</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-0.23.2</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 class="current" 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 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/termwiz-0.23.2/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.2/tree/docs/config/">config</a> / <span class="cur">keys.md</span></nav>
<span class="view-stats"><span>7.7 KiB</span><span>190 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/7ab7d8dd0abd3cfa3ecfc3d4ffd521b6701e7c1f/docs/config/keys.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"><h2>Configuring Key Assignments</h2>
<p>The default key table assignments can be overridden or extended using the
<code>keys</code> section in your <code>~/.wezterm.lua</code> config file.  For example, you can
disable a default assignment like this:</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>keys</a-v> = <a-cr>{</a-cr>
  <a-c>-- Turn off the default CMD-m Hide action, allowing CMD-m to</a-c>
  <a-c>-- be potentially recognized and handled by the tab</a-c>
  <a-cr>{</a-cr>
    <a-v>key</a-v> = <a-s>&#39;m&#39;</a-s><a-p>,</a-p>
    <a-v>mods</a-v> = <a-s>&#39;CMD&#39;</a-s><a-p>,</a-p>
    <a-v>action</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-v>DisableDefaultAssignment</a-v><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>The <code>action</code> value can be one of the <a href="lua/keyassignment/index.md">available key
assignments</a>.  Every action has an example that shows
how to use it.</p>
<p>Possible Modifier labels are:</p>
<ul>
<li><code>SUPER</code>, <code>CMD</code>, <code>WIN</code> - these are all equivalent: on macOS the <code>Command</code> key,
on Windows the <code>Windows</code> key, on Linux this can also be the <code>Super</code> or <code>Hyper</code>
key.  Left and right are equivalent.</li>
<li><code>CTRL</code> - The control key.  Left and right are equivalent.</li>
<li><code>SHIFT</code> - The shift key.  Left and right are equivalent.</li>
<li><code>ALT</code>, <code>OPT</code>, <code>META</code> - these are all equivalent: on macOS the <code>Option</code> key,
on other systems the <code>Alt</code> or <code>Meta</code> key.  Left and right are equivalent.</li>
<li><code>LEADER</code> - a special modal modifier state managed by <code>wezterm</code>. See <a href="#leader-key">Leader Key</a> for more information.</li>
<li><code>VoidSymbol</code> - This keycode is emitted in special cases where the original
function of the key has been removed. Such as in Linux and using <code>setxkbmap</code>.
<code>setxkbmap -option caps:none</code>. The <code>CapsLock</code> will no longer function as
before in all applications, instead emitting <code>VoidSymbol</code>.</li>
</ul>
<p>You can combine modifiers using the <code>|</code> symbol (eg: <code>"CMD|CTRL"</code>).</p>
<p>The <code>key</code> value can be one of the following keycode identifiers.  Note that not
all of these are meaningful on all platforms:</p>
<p><code>Hyper</code>, <code>Super</code>, <code>Meta</code>, <code>Cancel</code>, <code>Backspace</code>, <code>Tab</code>, <code>Clear</code>, <code>Enter</code>,
<code>Shift</code>, <code>Escape</code>, <code>LeftShift</code>, <code>RightShift</code>, <code>Control</code>, <code>LeftControl</code>,
<code>RightControl</code>, <code>Alt</code>, <code>LeftAlt</code>, <code>RightAlt</code>, <code>Menu</code>, <code>LeftMenu</code>, <code>RightMenu</code>,
<code>Pause</code>, <code>CapsLock</code>, <code>VoidSymbol</code>, <code>PageUp</code>, <code>PageDown</code>, <code>End</code>, <code>Home</code>, <code>LeftArrow</code>,
<code>RightArrow</code>, <code>UpArrow</code>, <code>DownArrow</code>, <code>Select</code>, <code>Print</code>, <code>Execute</code>,
<code>PrintScreen</code>, <code>Insert</code>, <code>Delete</code>, <code>Help</code>, <code>LeftWindows</code>, <code>RightWindows</code>,
<code>Applications</code>, <code>Sleep</code>, <code>Numpad0</code>, <code>Numpad1</code>, <code>Numpad2</code>, <code>Numpad3</code>,
<code>Numpad4</code>, <code>Numpad5</code>, <code>Numpad6</code>, <code>Numpad7</code>, <code>Numpad8</code>, <code>Numpad9</code>, <code>Multiply</code>,
<code>Add</code>, <code>Separator</code>, <code>Subtract</code>, <code>Decimal</code>, <code>Divide</code>, <code>NumLock</code>, <code>ScrollLock</code>,
<code>BrowserBack</code>, <code>BrowserForward</code>, <code>BrowserRefresh</code>, <code>BrowserStop</code>,
<code>BrowserSearch</code>, <code>BrowserFavorites</code>, <code>BrowserHome</code>, <code>VolumeMute</code>,
<code>VolumeDown</code>, <code>VolumeUp</code>, <code>MediaNextTrack</code>, <code>MediaPrevTrack</code>, <code>MediaStop</code>,
<code>MediaPlayPause</code>, <code>ApplicationLeftArrow</code>, <code>ApplicationRightArrow</code>,
<code>ApplicationUpArrow</code>, <code>ApplicationDownArrow</code>, <code>F1</code>, <code>F2</code>, <code>F3</code>, <code>F4</code>,
<code>F5</code>, <code>F6</code>, <code>F7</code>, <code>F8</code>, <code>F9</code>, <code>F10</code>, <code>F11</code>, <code>F12</code>, <code>F13</code>, <code>F14</code>, <code>F15</code>,
<code>F16</code>, <code>F17</code>, <code>F18</code>, <code>F19</code>, <code>F20</code>, <code>F21</code>, <code>F22</code>, <code>F23</code>, <code>F24</code>.</p>
<p>Alternatively, a single unicode character can be specified to indicate
pressing the corresponding key.</p>
<p>Pay attention to the case of the text that you use and the state of the <code>SHIFT</code> modifier, as <code>key="A"</code> will match</p>
<h3>Physical vs Mapped Key Assignments</h3>
<p>{{since('20220319-142410-0fcdea07')}}</p>
<p>The <code>key</code> value can refer either to the physical position of a key on an ANSI
US keyboard or to the post-keyboard-layout-mapped value produced by a key
press.</p>
<p>You can explicitly assign using the physical position by adding a <code>phys:</code> prefix
to the value, for example: <code>key="phys:A"</code>.  This will match key presses for
the key that would be in the position of the <code>A</code> key on an ANSI US keyboard.</p>
<p>You can explicitly assign the mapped key by adding a <code>mapped:</code> prefix to the
value, for example: <code>key="mapped:a"</code> will match a key press where the OS
keyboard layout produces <code>a</code>, regardless of its physical position.</p>
<p>If you omit an explicit prefix, wezterm will assume <code>phys:</code> and use the
physical position of the specified key.</p>
<p>The default key assignments listed above use <code>phys:</code>.  In previous releases
there was no physical position support and those assignments were all <code>mapped:</code>.</p>
<p>When upgrading from earlier releases, if you had <code>{key="N", mods="CMD", ..}</code> in
your config, you will need to change it to either
<code>{key="N", mods="CMD|SHIFT", ..}</code> or <code>{key="mapped:N", mods="CMD", ..}</code>
in order to continue to respect the <code>SHIFT</code> modifier.</p>
<p>{{since('20220408-101518-b908e2dd')}}</p>
<p>A new <code>key_map_preference</code> option controls how keys without an explicit <code>phys:</code>
or <code>mapped:</code> prefix are treated. If <code>key_map_preference = "Mapped"</code> (the
default), then <code>mapped:</code> is assumed. If <code>key_map_preference = "Physical"</code> then
<code>phys:</code> is assumed.</p>
<p>The default key assignments will respect <code>key_map_preference</code>.</p>
<h3>Raw Key Assignments</h3>
<p>In some cases, <code>wezterm</code> may not know how to represent a key event in either
its <code>phys:</code> or <code>mapped:</code> forms.  In that case, you may wish to define an
assignment in terms of the underlying operating system key code, using a <code>raw:</code>
prefix.</p>
<p>Similar in concept to the <code>phys:</code> mapping described above, the <code>raw:</code> mapping
is independent of the OS keyboard layout.  Raw codes are hardware and windowing system dependent, so there is no portable way to list which key does what.</p>
<p>To discover these values, you can set <a href="/fork/wezterm/ref/termwiz-0.23.2/blob/docs/config/lua/config/debug_key_events.md">debug_key_events =
true</a> and press the keys of
interest.</p>
<p>You can specify a raw key value of 123 by using <code>key="raw:123"</code> in your config
rather than one of the other key values.</p>
<h3>Leader Key</h3>
<p>{{since('20201031-154415-9614e117')}}</p>
<p>A <em>leader</em> key is a a modal modifier key.  If leader is specified in the
configuration then pressing that key combination will enable a virtual <code>LEADER</code>
modifier.</p>
<p>While <code>LEADER</code> is active, only defined key assignments that include
<code>LEADER</code> in the <code>mods</code> mask will be recognized.  Other keypresses
will be swallowed and NOT passed through to the terminal.</p>
<p><code>LEADER</code> stays active until a keypress is registered (whether it
matches a key binding or not), or until it has been active for
the duration specified by <code>timeout_milliseconds</code>, at which point
it will automatically cancel itself.</p>
<p>Here's an example configuration using <code>LEADER</code>.  In this configuration,
pressing <code>CTRL-A</code> activates the leader key for up to 1 second (1000
milliseconds).  While <code>LEADER</code> is active, the <code>|</code> key (with no other modifiers)
will trigger the current pane to be split.</p>
<pre class="language-lua"><a-c>-- timeout_milliseconds defaults to 1000 and can be omitted</a-c>
<a-v>config</a-v><a-p>.</a-p><a-v>leader</a-v> = <a-cr>{</a-cr> <a-v>key</a-v> = <a-s>&#39;a&#39;</a-s><a-p>,</a-p> <a-v>mods</a-v> = <a-s>&#39;CTRL&#39;</a-s><a-p>,</a-p> <a-v>timeout_milliseconds</a-v> = <a-n>1000</a-n> <a-cr>}</a-cr>
<a-v>config</a-v><a-p>.</a-p><a-v>keys</a-v> = <a-cr>{</a-cr>
  <a-cr>{</a-cr>
    <a-v>key</a-v> = <a-s>&#39;|&#39;</a-s><a-p>,</a-p>
    <a-v>mods</a-v> = <a-s>&#39;LEADER|SHIFT&#39;</a-s><a-p>,</a-p>
    <a-v>action</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>SplitHorizontal</a-f> <a-cr>{</a-cr> <a-v>domain</a-v> = <a-s>&#39;CurrentPaneDomain&#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
  <a-c>-- Send &quot;CTRL-A&quot; to the terminal when pressing CTRL-A, CTRL-A</a-c>
  <a-cr>{</a-cr>
    <a-v>key</a-v> = <a-s>&#39;a&#39;</a-s><a-p>,</a-p>
    <a-v>mods</a-v> = <a-s>&#39;LEADER|CTRL&#39;</a-s><a-p>,</a-p>
    <a-v>action</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>SendKey</a-f> <a-cr>{</a-cr> <a-v>key</a-v> = <a-s>&#39;a&#39;</a-s><a-p>,</a-p> <a-v>mods</a-v> = <a-s>&#39;CTRL&#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<h3>VoidSymbol</h3>
<p>{{since('20210814-124438-54e29167')}}</p>
<p>On X11 systems, If you decide to change certain keys on the keyboard to
<code>VoidSymbol</code> (like <code>CapsLock</code>), then you can utilize it as a <code>LEADER</code> or any
other part of key bindings. The following example now uses <code>VoidSymbol</code> and
uses <code>CapsLock</code> as a <code>LEADER</code> without it affecting the shift / capital state as
long as you have <code>setxkbmap -option caps:none</code> configured.</p>
<pre class="language-lua"><a-c>-- timeout_milliseconds defaults to 1000 and can be omitted</a-c>
<a-c>-- for this example use `setxkbmap -option caps:none` in your terminal.</a-c>
<a-v>config</a-v><a-p>.</a-p><a-v>leader</a-v> = <a-cr>{</a-cr> <a-v>key</a-v> = <a-s>&#39;VoidSymbol&#39;</a-s><a-p>,</a-p> <a-v>mods</a-v> = <a-s>&#39;&#39;</a-s><a-p>,</a-p> <a-v>timeout_milliseconds</a-v> = <a-n>1000</a-n> <a-cr>}</a-cr>
<a-v>config</a-v><a-p>.</a-p><a-v>keys</a-v> = <a-cr>{</a-cr>
  <a-cr>{</a-cr>
    <a-v>key</a-v> = <a-s>&#39;|&#39;</a-s><a-p>,</a-p>
    <a-v>mods</a-v> = <a-s>&#39;LEADER|SHIFT&#39;</a-s><a-p>,</a-p>
    <a-v>action</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>SplitHorizontal</a-f> <a-cr>{</a-cr> <a-v>domain</a-v> = <a-s>&#39;CurrentPaneDomain&#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
  <a-cr>{</a-cr>
    <a-v>key</a-v> = <a-s>&#39;-&#39;</a-s><a-p>,</a-p>
    <a-v>mods</a-v> = <a-s>&#39;LEADER&#39;</a-s><a-p>,</a-p>
    <a-v>action</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>SplitVertical</a-f> <a-cr>{</a-cr> <a-v>domain</a-v> = <a-s>&#39;CurrentPaneDomain&#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<h1>Available Actions</h1>
<p>See the <a href="lua/keyassignment/index.md"><code>KeyAssignment</code> reference</a> for information
on available actions.</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>Configuring Key Assignments</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">The default key table assignments can be overridden or extended using the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">`keys` section in your `~/.wezterm.lua` config file.  For example, you can</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">disable a default assignment like this:</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"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>config.</a-p><a-v>keys</a-v><a-p> = </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>  </a-p><a-c>-- Turn off the default CMD-m Hide action, allowing CMD-m to</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>  </a-p><a-c>-- be potentially recognized and handled by the tab</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>    </a-p><a-v>key</a-v><a-p> = </a-p><a-s>&#39;m&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>    </a-p><a-v>mods</a-v><a-p> = </a-p><a-s>&#39;CMD&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>    </a-p><a-v>action</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-v>DisableDefaultAssignment</a-v><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>The `action` value can be one of the [available key</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>assignments](lua/keyassignment/index.md).  Every action has an example that shows</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>how to use it.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>Possible Modifier labels are:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p> * `SUPER`, `CMD`, `WIN` - these are all equivalent: on macOS the `Command` key,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>   on Windows the `Windows` key, on Linux this can also be the `Super` or `Hyper`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>   key.  Left and right are equivalent.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p> * `CTRL` - The control key.  Left and right are equivalent.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p> * `SHIFT` - The shift key.  Left and right are equivalent.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p> * `ALT`, `OPT`, `META` - these are all equivalent: on macOS the `Option` key,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>   on other systems the `Alt` or `Meta` key.  Left and right are equivalent.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p> * `LEADER` - a special modal modifier state managed by `wezterm`. See [Leader Key](#leader-key) for more information.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p> * `VoidSymbol` - This keycode is emitted in special cases where the original</a-p></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>   function of the key has been removed. Such as in Linux and using `setxkbmap`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>   `setxkbmap -option caps:none`. The `CapsLock` will no longer function as</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>   before in all applications, instead emitting `VoidSymbol`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>You can combine modifiers using the `|` symbol (eg: `&quot;CMD|CTRL&quot;`).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>The `key` value can be one of the following keycode identifiers.  Note that not</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>all of these are meaningful on all platforms:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>`Hyper`, `Super`, `Meta`, `Cancel`, `Backspace`, `Tab`, `Clear`, `Enter`,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>`Shift`, `Escape`, `LeftShift`, `RightShift`, `Control`, `LeftControl`,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>`RightControl`, `Alt`, `LeftAlt`, `RightAlt`, `Menu`, `LeftMenu`, `RightMenu`,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>`Pause`, `CapsLock`, `VoidSymbol`, `PageUp`, `PageDown`, `End`, `Home`, `LeftArrow`,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>`RightArrow`, `UpArrow`, `DownArrow`, `Select`, `Print`, `Execute`,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>`PrintScreen`, `Insert`, `Delete`, `Help`, `LeftWindows`, `RightWindows`,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>`Applications`, `Sleep`, `Numpad0`, `Numpad1`, `Numpad2`, `Numpad3`,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>`Numpad4`, `Numpad5`, `Numpad6`, `Numpad7`, `Numpad8`, `Numpad9`, `Multiply`,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>`Add`, `Separator`, `Subtract`, `Decimal`, `Divide`, `NumLock`, `ScrollLock`,</a-p></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>`BrowserBack`, `BrowserForward`, `BrowserRefresh`, `BrowserStop`,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>`BrowserSearch`, `BrowserFavorites`, `BrowserHome`, `VolumeMute`,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>`VolumeDown`, `VolumeUp`, `MediaNextTrack`, `MediaPrevTrack`, `MediaStop`,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>`MediaPlayPause`, `ApplicationLeftArrow`, `ApplicationRightArrow`,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>`ApplicationUpArrow`, `ApplicationDownArrow`, `F1`, `F2`, `F3`, `F4`,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>`F5`, `F6`, `F7`, `F8`, `F9`, `F10`, `F11`, `F12`, `F13`, `F14`, `F15`,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>`F16`, `F17`, `F18`, `F19`, `F20`, `F21`, `F22`, `F23`, `F24`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>Alternatively, a single unicode character can be specified to indicate</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>pressing the corresponding key.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>Pay attention to the case of the text that you use and the state of the `SHIFT` modifier, as `key=&quot;A&quot;` will match </a-p></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>Physical vs Mapped Key Assignments</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"><a-p>{{since(&#39;20220319-142410-0fcdea07&#39;)}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>The `key` value can refer either to the physical position of a key on an ANSI</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>US keyboard or to the post-keyboard-layout-mapped value produced by a key</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>press.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>You can explicitly assign using the physical position by adding a `phys:` prefix</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>to the value, for example: `key=&quot;phys:A&quot;`.  This will match key presses for</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>the key that would be in the position of the `A` key on an ANSI US keyboard.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>You can explicitly assign the mapped key by adding a `mapped:` prefix to the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>value, for example: `key=&quot;mapped:a&quot;` will match a key press where the OS</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>keyboard layout produces `a`, regardless of its physical position.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>If you omit an explicit prefix, wezterm will assume `phys:` and use the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>physical position of the specified key.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>The default key assignments listed above use `phys:`.  In previous releases</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>there was no physical position support and those assignments were all `mapped:`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>When upgrading from earlier releases, if you had `{key=&quot;N&quot;, mods=&quot;CMD&quot;, ..}` in</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>your config, you will need to change it to either</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>`{key=&quot;N&quot;, mods=&quot;CMD|SHIFT&quot;, ..}` or `{key=&quot;mapped:N&quot;, mods=&quot;CMD&quot;, ..}`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>in order to continue to respect the `SHIFT` modifier.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>{{since(&#39;20220408-101518-b908e2dd&#39;)}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>A new `key_map_preference` option controls how keys without an explicit `phys:`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>or `mapped:` prefix are treated. If `key_map_preference = &quot;Mapped&quot;` (the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"><a-p>default), then `mapped:` is assumed. If `key_map_preference = &quot;Physical&quot;` then</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>`phys:` is assumed.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>The default key assignments will respect `key_map_preference`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p>### </a-p><a-tt>Raw Key Assignments</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>In some cases, `wezterm` may not know how to represent a key event in either</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p>its `phys:` or `mapped:` forms.  In that case, you may wish to define an</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>assignment in terms of the underlying operating system key code, using a `raw:`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>prefix.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>Similar in concept to the `phys:` mapping described above, the `raw:` mapping</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>is independent of the OS keyboard layout.  Raw codes are hardware and windowing system dependent, so there is no portable way to list which key does what.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>To discover these values, you can set [debug_key_events =</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>true](lua/config/debug_key_events.md) and press the keys of</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"><a-p>interest.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"><a-p>You can specify a raw key value of 123 by using `key=&quot;raw:123&quot;` in your config</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"><a-p>rather than one of the other key values.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>### </a-p><a-tt>Leader Key</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>{{since(&#39;20201031-154415-9614e117&#39;)}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"><a-p>A *leader* key is a a modal modifier key.  If leader is specified in the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"><a-p>configuration then pressing that key combination will enable a virtual `LEADER`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p>modifier.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"><a-p>While `LEADER` is active, only defined key assignments that include</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"><a-p>`LEADER` in the `mods` mask will be recognized.  Other keypresses</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"><a-p>will be swallowed and NOT passed through to the terminal.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"><a-p>`LEADER` stays active until a keypress is registered (whether it</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"><a-p>matches a key binding or not), or until it has been active for</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text"><a-p>the duration specified by `timeout_milliseconds`, at which point</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"><a-p>it will automatically cancel itself.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"><a-p>Here&#39;s an example configuration using `LEADER`.  In this configuration,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"><a-p>pressing `CTRL-A` activates the leader key for up to 1 second (1000</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"><a-p>milliseconds).  While `LEADER` is active, the `|` key (with no other modifiers)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"><a-p>will trigger the current pane to be split.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"><a-p>-- timeout_milliseconds defaults to 1000 and can be omitted</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text"><a-p>config.</a-p><a-v>leader</a-v><a-p> = </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>key</a-v><a-p> = </a-p><a-s>&#39;a&#39;</a-s><a-p>, </a-p><a-v>mods</a-v><a-p> = </a-p><a-s>&#39;CTRL&#39;</a-s><a-p>, </a-p><a-v>timeout_milliseconds</a-v><a-p> = </a-p><a-n>1000</a-n><a-p> </a-p><a-cr>}</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text"><a-p>config.</a-p><a-v>keys</a-v><a-p> = </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text"><a-p>    </a-p><a-v>key</a-v><a-p> = </a-p><a-s>&#39;|&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text"><a-p>    </a-p><a-v>mods</a-v><a-p> = </a-p><a-s>&#39;LEADER|SHIFT&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text"><a-p>    </a-p><a-v>action</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>SplitHorizontal</a-f><a-p> </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>domain</a-v><a-p> = </a-p><a-s>&#39;CurrentPaneDomain&#39;</a-s><a-p> </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text"><a-p>  </a-p><a-c>-- Send &quot;CTRL-A&quot; to the terminal when pressing CTRL-A, CTRL-A</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text"><a-p>    </a-p><a-v>key</a-v><a-p> = </a-p><a-s>&#39;a&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text"><a-p>    </a-p><a-v>mods</a-v><a-p> = </a-p><a-s>&#39;LEADER|CTRL&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text"><a-p>    </a-p><a-v>action</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>SendKey</a-f><a-p> </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>key</a-v><a-p> = </a-p><a-s>&#39;a&#39;</a-s><a-p>, </a-p><a-v>mods</a-v><a-p> = </a-p><a-s>&#39;CTRL&#39;</a-s><a-p> </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L156" href="#L156">156</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L157" href="#L157">157</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L158" href="#L158">158</a><span class="code-text"><a-p>### </a-p><a-tt>VoidSymbol</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text"><a-p>{{since(&#39;20210814-124438-54e29167&#39;)}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text"><a-p>On X11 systems, If you decide to change certain keys on the keyboard to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L163" href="#L163">163</a><span class="code-text"><a-p>`VoidSymbol` (like `CapsLock`), then you can utilize it as a `LEADER` or any</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text"><a-p>other part of key bindings. The following example now uses `VoidSymbol` and</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text"><a-p>uses `CapsLock` as a `LEADER` without it affecting the shift / capital state as</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text"><a-p>long as you have `setxkbmap -option caps:none` configured.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text"><a-p>-- timeout_milliseconds defaults to 1000 and can be omitted</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text"><a-p>-- for this example use `setxkbmap -option caps:none` in your terminal.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L171" href="#L171">171</a><span class="code-text"><a-p>config.</a-p><a-v>leader</a-v><a-p> = </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>key</a-v><a-p> = </a-p><a-s>&#39;VoidSymbol&#39;</a-s><a-p>, </a-p><a-v>mods</a-v><a-p> = </a-p><a-s>&#39;&#39;</a-s><a-p>, </a-p><a-v>timeout_milliseconds</a-v><a-p> = </a-p><a-n>1000</a-n><a-p> </a-p><a-cr>}</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"><a-p>config.</a-p><a-v>keys</a-v><a-p> = </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text"><a-p>    </a-p><a-v>key</a-v><a-p> = </a-p><a-s>&#39;|&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text"><a-p>    </a-p><a-v>mods</a-v><a-p> = </a-p><a-s>&#39;LEADER|SHIFT&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L176" href="#L176">176</a><span class="code-text"><a-p>    </a-p><a-v>action</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>SplitHorizontal</a-f><a-p> </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>domain</a-v><a-p> = </a-p><a-s>&#39;CurrentPaneDomain&#39;</a-s><a-p> </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</a><span class="code-text"><a-p>    </a-p><a-v>key</a-v><a-p> = </a-p><a-s>&#39;-&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L180" href="#L180">180</a><span class="code-text"><a-p>    </a-p><a-v>mods</a-v><a-p> = </a-p><a-s>&#39;LEADER&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L181" href="#L181">181</a><span class="code-text"><a-p>    </a-p><a-v>action</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>SplitVertical</a-f><a-p> </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>domain</a-v><a-p> = </a-p><a-s>&#39;CurrentPaneDomain&#39;</a-s><a-p> </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L182" href="#L182">182</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L183" href="#L183">183</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L184" href="#L184">184</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L185" href="#L185">185</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L186" href="#L186">186</a><span class="code-text"><a-p># </a-p><a-tt>Available Actions</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L187" href="#L187">187</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L188" href="#L188">188</a><span class="code-text">See the [`KeyAssignment` reference](lua/keyassignment/index.md) for information</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L189" href="#L189">189</a><span class="code-text">on available actions.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L190" href="#L190">190</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
