<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/pane/get_user_vars.md - fork/wezterm @ vtparse-0.7.0</title>
<meta name="description" content="docs/config/lua/pane/get_user_vars.md in fork/wezterm at vtparse-0.7.0.">
<meta property="og:title" content="docs/config/lua/pane/get_user_vars.md - fork/wezterm @ vtparse-0.7.0">
<meta property="og:description" content="docs/config/lua/pane/get_user_vars.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> / <a href="/fork/wezterm/ref/vtparse-0.7.0/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/vtparse-0.7.0/tree/docs/config/lua/pane/">pane</a> / <span class="cur">get_user_vars.md</span></nav>
<span class="view-stats"><span>1.7 KiB</span><span>48 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/88decfd6325fbbc6d4b1f97c4456de895bb546fb/docs/config/lua/pane/get_user_vars.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>pane:get_user_vars()</code></h1>
<p>{{since('20210502-130208-bff6815d')}}</p>
<p>Returns a table holding the user variables that have been assigned
to this pane.</p>
<p>User variables are set using an escape sequence defined by iterm2, but
also recognized by wezterm; this example sets the <code>foo</code> user variable
to the value <code>bar</code>:</p>
<pre class="language-bash"><a-c># This function emits an OSC 1337 sequence to set a user var</a-c>
<a-c># associated with the current terminal pane.</a-c>
<a-c># It requires the `base64` utility to be available in the path.</a-c>
<a-c># This function is included in the wezterm shell integration script, but</a-c>
<a-c># is reproduced here for clarity</a-c>
<a-f>__wezterm_set_user_var</a-f>() {
  <a-k>if</a-k> <a-f>hash</a-f> base64 <a-n>2</a-n><a-o>&gt;</a-o>/dev/null ; <a-k>then</a-k>
    <a-k>if</a-k> [[ -z <a-s>&quot;</a-s><a-eb>${</a-eb><a-pr>TMUX</a-pr><a-eb>}</a-eb><a-s>&quot;</a-s> ]] ; <a-k>then</a-k>
      <a-f>printf</a-f> <a-s>&quot;\033]1337;SetUserVar=%s=%s\007&quot;</a-s> <a-s>&quot;</a-s><a-o>$</a-o><a-pr>1</a-pr><a-s>&quot;</a-s> <a-eb>`</a-eb><a-f>echo</a-f><a-eb> </a-eb><a-co>-n</a-co><a-eb> </a-eb><a-s>&quot;</a-s><a-o>$</a-o><a-pr>2</a-pr><a-s>&quot;</a-s><a-eb> </a-eb><a-o>|</a-o><a-eb> </a-eb><a-f>base64</a-f><a-eb>`</a-eb>
    <a-k>else</a-k>
      <a-c># &lt;https://github.com/tmux/tmux/wiki/FAQ#what-is-the-passthrough-escape-sequence-and-how-do-i-use-it&gt;</a-c>
      <a-c># Note that you ALSO need to add &quot;set -g allow-passthrough on&quot; to your tmux.conf</a-c>
      <a-f>printf</a-f> <a-s>&quot;\033Ptmux;\033\033]1337;SetUserVar=%s=%s\007\033\\&quot;</a-s> <a-s>&quot;</a-s><a-o>$</a-o><a-pr>1</a-pr><a-s>&quot;</a-s> <a-eb>`</a-eb><a-f>echo</a-f><a-eb> </a-eb><a-co>-n</a-co><a-eb> </a-eb><a-s>&quot;</a-s><a-o>$</a-o><a-pr>2</a-pr><a-s>&quot;</a-s><a-eb> </a-eb><a-o>|</a-o><a-eb> </a-eb><a-f>base64</a-f><a-eb>`</a-eb>
    <a-k>fi</a-k>
  <a-k>fi</a-k>
}

<a-f>__wezterm_set_user_var</a-f> <a-s>&quot;foo&quot;</a-s> <a-s>&quot;bar&quot;</a-s></pre>
<p>you're then able to access this in your wezterm config:</p>
<pre class="language-lua"><a-v>wezterm</a-v><a-p>.</a-p><a-f>log_info</a-f><a-p>(</a-p><a-s>&#39;foo var is &#39;</a-s> <a-o>..</a-o> <a-v>pane</a-v><a-p>:</a-p><a-f>get_user_vars</a-f><a-p>().</a-p><a-v>foo</a-v><a-p>)</a-p></pre>
<p>Setting a user var will generate events in the window that contains
the corresponding pane:</p>
<ul>
<li><a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/window-events/user-var-changed.md">user-var-changed</a>, which
allows you to directly take action when a var is set/changed.</li>
<li><a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/window-events/update-status.md">update-status</a> which allows you to update left/right status items</li>
<li>the title and tab bar area will then update and trigger any associated events as part of that update</li>
</ul>
<p>The user var change event will propagate to all connected multiplexer clients.</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>`pane:get_user_vars()`</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;20210502-130208-bff6815d&#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">Returns a table holding the user variables that have been assigned</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">to this pane.</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">User variables are set using an escape sequence defined by iterm2, but</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">also recognized by wezterm; this example sets the `foo` user variable</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">to the value `bar`:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></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-tl>bash</a-tl></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># This function emits an OSC 1337 sequence to set a user var</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># associated with the current terminal pane.</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># It requires the `base64` utility to be available in the path.</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># This function is included in the wezterm shell integration script, but</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># is reproduced here for clarity</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>__wezterm_set_user_var() {</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>  </a-p><a-k>if</a-k><a-p> </a-p><a-f>hash</a-f><a-p> base64 </a-p><a-n>2</a-n><a-o>&gt;</a-o><a-p>/dev/null ; </a-p><a-k>then</a-k></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>    </a-p><a-k>if</a-k><a-p> [[ -z </a-p><a-s>&quot;</a-s><a-eb>${</a-eb><a-pr>TMUX</a-pr><a-eb>}</a-eb><a-s>&quot;</a-s><a-p> ]] ; </a-p><a-k>then</a-k></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>      </a-p><a-f>printf</a-f><a-p> </a-p><a-s>&quot;\033]1337;SetUserVar=%s=%s\007&quot;</a-s><a-p> </a-p><a-s>&quot;</a-s><a-o>$</a-o><a-pr>1</a-pr><a-s>&quot;</a-s><a-p> </a-p><a-eb>`</a-eb><a-f>echo</a-f><a-eb> </a-eb><a-co>-n</a-co><a-eb> </a-eb><a-s>&quot;</a-s><a-o>$</a-o><a-pr>2</a-pr><a-s>&quot;</a-s><a-eb> </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="L22" href="#L22">22</a><span class="code-text"><a-p>    </a-p><a-k>else</a-k></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-c># &lt;https://github.com/tmux/tmux/wiki/FAQ#what-is-the-passthrough-escape-sequence-and-how-do-i-use-it&gt;</a-c></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>      </a-p><a-c># Note that you ALSO need to add &quot;set -g allow-passthrough on&quot; to your tmux.conf</a-c></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>      </a-p><a-f>printf</a-f><a-p> </a-p><a-s>&quot;\033Ptmux;\033\033]1337;SetUserVar=%s=%s\007\033\\&quot;</a-s><a-p> </a-p><a-s>&quot;</a-s><a-o>$</a-o><a-pr>1</a-pr><a-s>&quot;</a-s><a-p> </a-p><a-eb>`</a-eb><a-f>echo</a-f><a-eb> </a-eb><a-co>-n</a-co><a-eb> </a-eb><a-s>&quot;</a-s><a-o>$</a-o><a-pr>2</a-pr><a-s>&quot;</a-s><a-eb> </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="L26" href="#L26">26</a><span class="code-text"><a-p>    </a-p><a-k>fi</a-k></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-k>fi</a-k></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>}</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>__wezterm_set_user_var </a-p><a-s>&quot;foo&quot;</a-s><a-p> </a-p><a-s>&quot;bar&quot;</a-s></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"><a-p>you&#39;re then able to access this in your wezterm config:</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"></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>```</a-p><a-tl>lua</a-tl></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>wezterm.</a-p><a-f>log_info</a-f><a-p>(</a-p><a-s>&#39;foo var is &#39;</a-s><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-v>pane</a-v><a-p>:</a-p><a-f>get_user_vars</a-f><a-p>().</a-p><a-v>foo</a-v><a-p>)</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"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>Setting a user var will generate events in the window that contains</a-p></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 corresponding pane:</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>* [user-var-changed](../window-events/user-var-changed.md), which</a-p></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>  allows you to directly take action when a var is set/changed.</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>* [update-status](../window-events/update-status.md) which allows you to update left/right status items</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>* the title and tab bar area will then update and trigger any associated events as part of that update</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text">The user var change event will propagate to all connected multiplexer clients.</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></pre></div></div>
</main>
</body>
</html>
