<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/window-events/user-var-changed.md - fork/wezterm @ termiz-0.23.2</title>
<meta name="description" content="docs/config/lua/window-events/user-var-changed.md in fork/wezterm at termiz-0.23.2.">
<meta property="og:title" content="docs/config/lua/window-events/user-var-changed.md - fork/wezterm @ termiz-0.23.2">
<meta property="og:description" content="docs/config/lua/window-events/user-var-changed.md in fork/wezterm at termiz-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="termiz-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">Max von Webel</span><span class="commit-message" data-commit="cdfa86aebd6fafb66054461ece3276472ffc822d">Update user-var-changed.md (#6368)</span><span class="snapshot-sha sha" data-commit="cdfa86aebd6fafb66054461ece3276472ffc822d">cdfa86aeb</span><time datetime="2025-02-08T15:20:00+01:00" title="2025-02-08 15:20:00 +0100">2025-02-08</time></p>
<header class="topbar"><details class="switcher"><summary>termiz-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 class="current" 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 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/termiz-0.23.2/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/lua/window-events/">window-events</a> / <span class="cur">user-var-changed.md</span></nav>
<span class="view-stats"><span>934 B</span><span>35 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/bd8e4d3bc5840a534d2414c7aefc1f8dddc45ad7/docs/config/lua/window-events/user-var-changed.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><code>user-var-changed</code></h1>
<p>{{since('20220903-194523-3bb1ed61')}}</p>
<p>The <code>user-var-changed</code> event is emitted when a <em>user var</em> escape sequence is
used to set a user var.</p>
<p>You can use something like the following from your shell:</p>
<pre class="language-bash"><a-f>printf</a-f> <a-s>&quot;\033]1337;SetUserVar=%s=%s\007&quot;</a-s> foo <a-eb>`</a-eb><a-f>echo</a-f><a-eb> </a-eb><a-co>-n</a-co><a-eb> bar </a-eb><a-o>|</a-o><a-eb> </a-eb><a-f>base64</a-f><a-eb>`</a-eb></pre>
<p>to set the user var named <code>foo</code> to the value <code>bar</code>.</p>
<p>!!! note
On some systems the <code>base64</code> command wraps the output by default after some
amount of characters limiting the maximum length of the value. If this is
the case an argument like <code>-w 0</code> might help to avoid wrapping.</p>
<p>Then, if you have this in your config:</p>
<pre class="language-lua"><a-k>local</a-k> <a-v>wezterm</a-v> = <a-f>require</a-f> <a-s>&#39;wezterm&#39;</a-s>

<a-v>wezterm</a-v><a-p>.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;user-var-changed&#39;</a-s><a-p>,</a-p> <a-k>function</a-k><a-p>(</a-p><a-v>window</a-v><a-p>,</a-p> <a-v>pane</a-v><a-p>,</a-p> <a-v>name</a-v><a-p>,</a-p> <a-v>value</a-v><a-p>)</a-p>
  <a-v>wezterm</a-v><a-p>.</a-p><a-f>log_info</a-f><a-p>(</a-p><a-s>&#39;var&#39;</a-s><a-p>,</a-p> <a-v>name</a-v><a-p>,</a-p> <a-v>value</a-v><a-p>)</a-p>
<a-k>end</a-k><a-p>)</a-p>

<a-k>return</a-k> <a-cr>{}</a-cr></pre>
<p>your event handler will be called with <code>name = 'foo'</code> and <code>value = 'bar'</code>.</p>
<p>See also <a href="/fork/wezterm/ref/termiz-0.23.2/blob/docs/config/lua/pane/get_user_vars.md">pane:get_user_vars()</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>`user-var-changed`</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">{{since(&#39;20220903-194523-3bb1ed61&#39;)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">The `user-var-changed` event is emitted when a *user var* escape sequence is</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">used to set a user var.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">You can use something like the following from your shell:</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"><a-p>```</a-p><a-tl>bash</a-tl></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>printf </a-p><a-s>&quot;\033]1337;SetUserVar=%s=%s\007&quot;</a-s><a-p> foo </a-p><a-eb>`</a-eb><a-f>echo</a-f><a-eb> </a-eb><a-co>-n</a-co><a-eb> bar </a-eb><a-o>|</a-o><a-eb> </a-eb><a-f>base64</a-f><a-eb>`</a-eb></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></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"><a-p>to set the user var named `foo` to the value `bar`.</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"></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>!!! note</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>    On some systems the `base64` command wraps the output by default after some</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"><a-p>    amount of characters limiting the maximum length of the value. If this is</a-p></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 case an argument like `-w 0` might help to avoid wrapping.</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"></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>Then, if you have this in your config:</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>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>local </a-p><a-v>wezterm</a-v><a-p> = </a-p><a-f>require</a-f><a-p> </a-p><a-s>&#39;wezterm&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></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>wezterm.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;user-var-changed&#39;</a-s><a-p>, </a-p><a-k>function</a-k><a-p>(</a-p><a-v>window</a-v><a-p>, </a-p><a-v>pane</a-v><a-p>, </a-p><a-v>name</a-v><a-p>, </a-p><a-v>value</a-v><a-p>)</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>  </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-f>log_info</a-f><a-p>(</a-p><a-s>&#39;var&#39;</a-s><a-p>, </a-p><a-v>name</a-v><a-p>, </a-p><a-v>value</a-v><a-p>)</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>end)</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"></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>return </a-p><a-cr>{}</a-cr></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>```</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">your event handler will be called with `name = &#39;foo&#39;` and `value = &#39;bar&#39;`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text">See also [pane:get_user_vars()](../pane/get_user_vars.md).</span></span></pre></div></div>
</main>
</body>
</html>
