<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/WslDomain.md - fork/wezterm @ termwiz-0.23.3</title>
<meta name="description" content="docs/config/lua/WslDomain.md in fork/wezterm at termwiz-0.23.3.">
<meta property="og:title" content="docs/config/lua/WslDomain.md - fork/wezterm @ termwiz-0.23.3">
<meta property="og:description" content="docs/config/lua/WslDomain.md in fork/wezterm at termwiz-0.23.3.">
<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.3" data-tip="4bf28e253c0167102f07bfc7e7199c13eed98012">
<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>termwiz-0.23.3</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 class="current" 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.3/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.3/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termwiz-0.23.3/tree/docs/config/lua/">lua</a> / <span class="cur">WslDomain.md</span></nav>
<span class="view-stats"><span>1.7 KiB</span><span>50 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/a570e93476e0d25ed0ee064b92b73f424d469f3c/docs/config/lua/WslDomain.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>WslDomain</h1>
<p>{{since('20220319-142410-0fcdea07')}}</p>
<p>The <code>WslDomain</code> struct specifies information about an individual <code>WslDomain</code>,
which is used to tell wezterm how to interact with one of your locally
installed <a href="https://docs.microsoft.com/en-us/windows/wsl/about">WSL</a>
distributions.</p>
<p>By mapping a distribution to a multiplexing domain, wezterm is better able to
support creating new tabs and panes with the same working directory as an
existing tab/pane running in that same domain.</p>
<p>By default, wezterm creates a list of <code>WslDomain</code> objects based on parsing the
output from <code>wsl -l -v</code> and assigns that as the value of the
<a href="/fork/wezterm/ref/termwiz-0.23.3/blob/docs/config/lua/config/wsl_domains.md">wsl_domains</a> configuration option.</p>
<p>A <code>WslDomain</code> is a lua object with the following fields:</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>wsl_domains</a-v> = <a-cr>{</a-cr>
  <a-cr>{</a-cr>
    <a-c>-- The name of this specific domain.  Must be unique amonst all types</a-c>
    <a-c>-- of domain in the configuration file.</a-c>
    <a-v>name</a-v> = <a-s>&#39;WSL:Ubuntu-18.04&#39;</a-s><a-p>,</a-p>

    <a-c>-- The name of the distribution.  This identifies the WSL distribution.</a-c>
    <a-c>-- It must match a valid distribution from your `wsl -l -v` output in</a-c>
    <a-c>-- order for the domain to be useful.</a-c>
    <a-v>distribution</a-v> = <a-s>&#39;Ubuntu-18.04&#39;</a-s><a-p>,</a-p>

    <a-c>-- The username to use when spawning commands in the distribution.</a-c>
    <a-c>-- If omitted, the default user for that distribution will be used.</a-c>

    <a-c>-- username = &quot;hunter&quot;,</a-c>

    <a-c>-- The current working directory to use when spawning commands, if</a-c>
    <a-c>-- the SpawnCommand doesn&#39;t otherwise specify the directory.</a-c>

    <a-c>-- default_cwd = &quot;/tmp&quot;</a-c>

    <a-c>-- The default command to run, if the SpawnCommand doesn&#39;t otherwise</a-c>
    <a-c>-- override it.  Note that you may prefer to use `chsh` to set the</a-c>
    <a-c>-- default shell for your user inside WSL to avoid needing to</a-c>
    <a-c>-- specify it here</a-c>

    <a-c>-- default_prog = {&quot;fish&quot;}</a-c>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
</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>WslDomain</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;20220319-142410-0fcdea07&#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 `WslDomain` struct specifies information about an individual `WslDomain`,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">which is used to tell wezterm how to interact with one of your locally</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">installed [WSL](https://docs.microsoft.com/en-us/windows/wsl/about)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">distributions.</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">By mapping a distribution to a multiplexing domain, wezterm is better able to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">support creating new tabs and panes with the same working directory as an</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">existing tab/pane running in that same domain.</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">By default, wezterm creates a list of `WslDomain` objects based on parsing the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">output from `wsl -l -v` and assigns that as the value of the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">[wsl_domains](config/wsl_domains.md) configuration option.</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 `WslDomain` is a lua object with the following fields:</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"><a-p>```</a-p><a-tl>lua</a-tl></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>config.</a-p><a-v>wsl_domains</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="L22" href="#L22">22</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="L23" href="#L23">23</a><span class="code-text"><a-p>    </a-p><a-c>-- The name of this specific domain.  Must be unique amonst all types</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>-- of domain in the configuration file.</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-v>name</a-v><a-p> = </a-p><a-s>&#39;WSL:Ubuntu-18.04&#39;</a-s><a-p>,</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"></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-c>-- The name of the distribution.  This identifies the WSL distribution.</a-c></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><a-c>-- It must match a valid distribution from your `wsl -l -v` output in</a-c></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>    </a-p><a-c>-- order for the domain to be useful.</a-c></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>    </a-p><a-v>distribution</a-v><a-p> = </a-p><a-s>&#39;Ubuntu-18.04&#39;</a-s><a-p>,</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"></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>    </a-p><a-c>-- The username to use when spawning commands in the distribution.</a-c></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>    </a-p><a-c>-- If omitted, the default user for that distribution will be used.</a-c></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-c>-- username = &quot;hunter&quot;,</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></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><a-c>-- The current working directory to use when spawning commands, if</a-c></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>    </a-p><a-c>-- the SpawnCommand doesn&#39;t otherwise specify the directory.</a-c></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>    </a-p><a-c>-- default_cwd = &quot;/tmp&quot;</a-c></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>    </a-p><a-c>-- The default command to run, if the SpawnCommand doesn&#39;t otherwise</a-c></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>    </a-p><a-c>-- override it.  Note that you may prefer to use `chsh` to set the</a-c></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>    </a-p><a-c>-- default shell for your user inside WSL to avoid needing to</a-c></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>    </a-p><a-c>-- specify it here</a-c></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"><a-p>    </a-p><a-c>-- default_prog = {&quot;fish&quot;}</a-c></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>  </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="L49" href="#L49">49</a><span class="code-text"><a-p>}</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>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
