<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/wezterm/default_wsl_domains.md - fork/wezterm @ termiz-0.23.2</title>
<meta name="description" content="docs/config/lua/wezterm/default_wsl_domains.md in fork/wezterm at termiz-0.23.2.">
<meta property="og:title" content="docs/config/lua/wezterm/default_wsl_domains.md - fork/wezterm @ termiz-0.23.2">
<meta property="og:description" content="docs/config/lua/wezterm/default_wsl_domains.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">Wez Furlong</span><span class="commit-message" data-commit="84f7fb9f3b0deb192d45ee36257e5f329584b1fc">docs: add tags to a number of pages</span><span class="snapshot-sha sha" data-commit="84f7fb9f3b0deb192d45ee36257e5f329584b1fc">84f7fb9f3</span><time datetime="2023-04-08T07:48:40-07:00" title="2023-04-08 07:48:40 -0700">2023-04-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/wezterm/">wezterm</a> / <span class="cur">default_wsl_domains.md</span></nav>
<span class="view-stats"><span>1.6 KiB</span><span>67 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/a279699b9de3c45ccb40c718dccde28a6c177c21/docs/config/lua/wezterm/default_wsl_domains.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"><hr />
<p>title: wezterm.default_wsl_domains
tags:</p>
<ul>
<li>wsl</li>
<li>multiplexing</li>
</ul>
<hr />
<h1>wezterm.default_wsl_domains()</h1>
<p>{{since('20220319-142410-0fcdea07')}}</p>
<p>Computes a list of <a href="/fork/wezterm/ref/termiz-0.23.2/blob/docs/config/lua/WslDomain.md">WslDomain</a> objects, each one
representing an installed
<a href="https://docs.microsoft.com/en-us/windows/wsl/about">WSL</a> distribution
on your system.</p>
<p>This list is the same as the default value for the
<a href="/fork/wezterm/ref/termiz-0.23.2/blob/docs/config/lua/config/wsl_domains.md">wsl_domains</a> configuration option, which is to make
a <code>WslDomain</code> with the <code>distribution</code> field set to the name of WSL distro and the
<code>name</code> field set to name of the distro but with <code>"WSL:"</code> prefixed to it.</p>
<p>For example, if:</p>
<pre>; wsl -l -v
  NAME            STATE           VERSION
* Ubuntu-18.04    Running         1
</pre>
<p>then this function will return:</p>
<pre>{
  {
    name: &quot;WSL:Ubuntu-18.04&quot;,
    distribution: &quot;Ubuntu-18.04&quot;,
  },
}
</pre>
<p>The purpose of this function is to aid in situations where you might want set
<code>default_prog</code> for the WSL distributions:</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-k>local</a-k> <a-v>wsl_domains</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-f>default_wsl_domains</a-f><a-p>()</a-p>

<a-k>for</a-k> <a-v>idx</a-v><a-p>,</a-p> <a-v>dom</a-v> <a-k>in</a-k> <a-f>ipairs</a-f><a-p>(</a-p><a-v>wsl_domains</a-v><a-p>)</a-p> <a-k>do</a-k>
  <a-k>if</a-k> <a-v>dom</a-v><a-p>.</a-p><a-v>name</a-v> <a-o>==</a-o> <a-s>&#39;WSL:Ubuntu-18.04&#39;</a-s> <a-k>then</a-k>
    <a-v>dom</a-v><a-p>.</a-p><a-v>default_prog</a-v> = <a-cr>{</a-cr> <a-s>&#39;fish&#39;</a-s> <a-cr>}</a-cr>
  <a-k>end</a-k>
<a-k>end</a-k>

<a-k>return</a-k> <a-cr>{</a-cr>
  <a-v>wsl_domains</a-v> = <a-v>wsl_domains</a-v><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>However, wez strongly recommends that you use <code>chsh</code> inside the WSL domain to make
that the default shell if possible, so that you can avoid this additional configuration!</p>
<p>{{since('20230320-124340-559cb7b0')}}</p>
<p>The <code>default_cwd</code> field is now automatically set to <code>"~"</code> to make it more
convenient to launch a WSL instance in the home directory of the configured
distribution.</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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-pr>title</a-pr><a-p>:</a-p> <a-s>wezterm.default_wsl_domains</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-pr>tags</a-pr><a-p>:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"> <a-p>-</a-p> <a-s>wsl</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"> <a-p>-</a-p> <a-s>multiplexing</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>---</a-p></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"><a-p>#</a-p> <a-tt>wezterm.default_wsl_domains()</a-tt></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">{{since(&#39;20220319-142410-0fcdea07&#39;)}}</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">Computes a list of [WslDomain](../WslDomain.md) objects, each one</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">representing an installed</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">[WSL](https://docs.microsoft.com/en-us/windows/wsl/about) distribution</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">on your system.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">This list is the same as the default value for the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">[wsl_domains](../config/wsl_domains.md) configuration option, which is to make</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 `WslDomain` with the `distribution` field set to the name of WSL distro and the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">`name` field set to name of the distro but with `&quot;WSL:&quot;` prefixed to it.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">For example, if:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></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></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>; wsl -l -v</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>  NAME            STATE           VERSION</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>* Ubuntu-18.04    Running         1</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>```</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>then this function will return:</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></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>  {</a-p></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>    name: &quot;WSL:Ubuntu-18.04&quot;,</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>    distribution: &quot;Ubuntu-18.04&quot;,</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"><a-p>}</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"><a-p>```</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"></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>The purpose of this function is to aid in situations where you might want set</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"><a-p>`default_prog` for the WSL distributions:</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"></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-tl>lua</a-tl></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>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="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>local </a-p><a-v>wsl_domains</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-f>default_wsl_domains</a-f><a-p>()</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"></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>for </a-p><a-v>idx</a-v><a-p>, </a-p><a-v>dom</a-v><a-p> </a-p><a-k>in</a-k><a-p> </a-p><a-f>ipairs</a-f><a-p>(</a-p><a-v>wsl_domains</a-v><a-p>) </a-p><a-k>do</a-k></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><a-k>if</a-k><a-p> </a-p><a-v>dom</a-v><a-p>.</a-p><a-v>name</a-v><a-p> </a-p><a-o>==</a-o><a-p> </a-p><a-s>&#39;WSL:Ubuntu-18.04&#39;</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="L51" href="#L51">51</a><span class="code-text"><a-p>    </a-p><a-v>dom</a-v><a-p>.</a-p><a-v>default_prog</a-v><a-p> = </a-p><a-cr>{</a-cr><a-p> </a-p><a-s>&#39;fish&#39;</a-s><a-p> </a-p><a-cr>}</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>  </a-p><a-k>end</a-k></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>end</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"></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>return </a-p><a-cr>{</a-cr></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>  </a-p><a-v>wsl_domains</a-v><a-p> = </a-p><a-v>wsl_domains</a-v><a-p>,</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>}</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>```</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">However, wez strongly recommends that you use `chsh` inside the WSL domain to make</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text">that the default shell if possible, so that you can avoid this additional configuration!</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">{{since(&#39;20230320-124340-559cb7b0&#39;)}}</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">The `default_cwd` field is now automatically set to `&quot;~&quot;` to make it more</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text">convenient to launch a WSL instance in the home directory of the configured</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text">distribution.</span></span></pre></div></div>
</main>
</body>
</html>
