<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/SshDomain.md - fork/wezterm @ termwiz-0.23.3</title>
<meta name="description" content="docs/config/lua/SshDomain.md in fork/wezterm at termwiz-0.23.3.">
<meta property="og:title" content="docs/config/lua/SshDomain.md - fork/wezterm @ termwiz-0.23.3">
<meta property="og:description" content="docs/config/lua/SshDomain.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">SshDomain.md</span></nav>
<span class="view-stats"><span>4.4 KiB</span><span>134 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/aad4ce9bb643d41a8fe6ad1ab1c4ed2bf9f2caf5/docs/config/lua/SshDomain.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>SshDomain</h1>
<p>The <code>SshDomain</code> struct specifies information about an individual
<a href="/fork/wezterm/ref/termwiz-0.23.3/blob/docs/multiplexing.md#ssh-domains">SSH Domain</a>.</p>
<p>It is a lua object with the following fields:</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>ssh_domains</a-v> = <a-cr>{</a-cr>
  <a-cr>{</a-cr>
    <a-c>-- The name of this specific domain.  Must be unique amongst</a-c>
    <a-c>-- all types of domain in the configuration file.</a-c>
    <a-v>name</a-v> = <a-s>&#39;my.server&#39;</a-s><a-p>,</a-p>

    <a-c>-- identifies the host:port pair of the remote server</a-c>
    <a-c>-- Can be a DNS name or an IP address with an optional</a-c>
    <a-c>-- &quot;:port&quot; on the end.</a-c>
    <a-v>remote_address</a-v> = <a-s>&#39;192.168.1.1&#39;</a-s><a-p>,</a-p>

    <a-c>-- Whether agent auth should be disabled.</a-c>
    <a-c>-- Set to true to disable it.</a-c>
    <a-c>-- no_agent_auth = false,</a-c>

    <a-c>-- The username to use for authenticating with the remote host</a-c>
    <a-v>username</a-v> = <a-s>&#39;yourusername&#39;</a-s><a-p>,</a-p>

    <a-c>-- If true, connect to this domain automatically at startup</a-c>
    <a-c>-- connect_automatically = true,</a-c>

    <a-c>-- Specify an alternative read timeout</a-c>
    <a-c>-- timeout = 60,</a-c>

    <a-c>-- The path to the wezterm binary on the remote host.</a-c>
    <a-c>-- Primarily useful if it isn&#39;t installed in the $PATH</a-c>
    <a-c>-- that is configure for ssh.</a-c>
    <a-c>-- remote_wezterm_path = &quot;/home/yourusername/bin/wezterm&quot;</a-c>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>{{since('20220101-133340-7edc5b5a')}}</p>
<p>You may now specify a table with ssh config overrides:</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>ssh_domains</a-v> = <a-cr>{</a-cr>
  <a-cr>{</a-cr>
    <a-v>name</a-v> = <a-s>&#39;my.server&#39;</a-s><a-p>,</a-p>
    <a-v>remote_address</a-v> = <a-s>&#39;192.168.1.1&#39;</a-s><a-p>,</a-p>
    <a-v>ssh_option</a-v> = <a-cr>{</a-cr>
      <a-v>identityfile</a-v> = <a-s>&#39;/path/to/id_rsa.pub&#39;</a-s><a-p>,</a-p>
    <a-cr>}</a-cr><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>{{since('20220319-142410-0fcdea07')}}</p>
<p>You may now specify the type of <code>multiplexing</code> used by an ssh domain.
The following values are possible:</p>
<ul>
<li><code>"WezTerm"</code> - this is the default; use wezterm's multiplexing client.
Having wezterm installed on the server is required to use this mode.</li>
<li><code>"None"</code> - don't use any multiplexing. The connection is an ssh connection
using the same mechanism as is used by <code>wezterm ssh</code>; losing connectivity
will lose any panes/tabs.  This mode of operation is convenient when using
SSH to connect automatically into eg: a locally hosted WSL instance, together
with the <a href="/fork/wezterm/ref/termwiz-0.23.3/blob/docs/config/lua/config/default_domain.md">default_domain</a> option.</li>
</ul>
<p>A new <code>assume_shell</code> option, when coupled with <code>multiplexing = "None"</code>, allows
wezterm to assume that the remote host uses a specific shell command language
dialect, which in turn allows wezterm to respect the
current working directory as set by <a href="/fork/wezterm/ref/termwiz-0.23.3/blob/docs/shell-integration.md">OSC 7 / Shell
Integration</a> on the remote host when spawning new
panes and tabs.  The following values are recognized for <code>assume_shell</code>:</p>
<ul>
<li><code>"Unknown"</code> - this is the default. We can't make any assumptions about the
remote shell.</li>
<li><code>"Posix"</code> - the remote host uses a POSIX/Bourne Shell compatible environment
that allows the syntax <code>env -c DIR ENV1=VAL1 ENV2=VAL2 CMD</code> and
<code>env -c DIR ENV1=VAL1 ENV2=VAL2 $SHELL</code>.</li>
</ul>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>ssh_domains</a-v> = <a-cr>{</a-cr>
  <a-cr>{</a-cr>
    <a-v>name</a-v> = <a-s>&#39;my.server&#39;</a-s><a-p>,</a-p>
    <a-v>remote_address</a-v> = <a-s>&#39;192.168.1.1&#39;</a-s><a-p>,</a-p>
    <a-v>multiplexing</a-v> = <a-s>&#39;None&#39;</a-s><a-p>,</a-p>

    <a-c>-- When multiplexing == &quot;None&quot;, default_prog can be used</a-c>
    <a-c>-- to specify the default program to run in new tabs/panes.</a-c>
    <a-c>-- Due to the way that ssh works, you cannot specify default_cwd,</a-c>
    <a-c>-- but you could instead change your default_prog to put you</a-c>
    <a-c>-- in a specific directory.</a-c>
    <a-v>default_prog</a-v> = <a-cr>{</a-cr> <a-s>&#39;fish&#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>

    <a-c>-- assume that we can use syntax like:</a-c>
    <a-c>-- &quot;env -C /some/where $SHELL&quot;</a-c>
    <a-c>-- using whatever the default command shell is on this</a-c>
    <a-c>-- remote host, so that shell integration will respect</a-c>
    <a-c>-- the current directory on the remote host.</a-c>
    <a-v>assume_shell</a-v> = <a-s>&#39;Posix&#39;</a-s><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr>

<a-v>config</a-v><a-p>.</a-p><a-v>default_domain</a-v> = <a-s>&#39;my.server&#39;</a-s></pre>
<p>You may now specify the round-trip latency threshold for enabling predictive
local echo using <code>local_echo_threshold_ms</code>. If the measured round-trip latency
between the wezterm client and the server exceeds the specified threshold, the
client will attempt to predict the server's response to key events and echo the
result of that prediction locally without waiting, hence hiding latency to the
user. This option only applies when <code>multiplexing = "WezTerm"</code>.</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>ssh_domains</a-v> = <a-cr>{</a-cr>
  <a-cr>{</a-cr>
    <a-v>name</a-v> = <a-s>&#39;my.server&#39;</a-s><a-p>,</a-p>
    <a-v>remote_address</a-v> = <a-s>&#39;192.168.1.1&#39;</a-s><a-p>,</a-p>
    <a-v>local_echo_threshold_ms</a-v> = <a-n>10</a-n><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>{{since('20221119-145034-49b9839f')}}</p>
<p>The lag indicator now defaults to disabled. It is recommended to display
the lag information in your status bar using <a href="/fork/wezterm/ref/termwiz-0.23.3/blob/docs/config/lua/pane/get_metadata.md">this
example</a>.</p>
<p>If you prefer to have the information overlaid on the content area, then
you can set <code>overlay_lag_indicator = true</code>, but note that I'd like to
remove that functionality in the future.</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>SshDomain</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 `SshDomain` struct specifies information about an individual</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">[SSH Domain](../../multiplexing.md#ssh-domains).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">It is a lua object with the following fields:</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-tl>lua</a-tl></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>config.</a-p><a-v>ssh_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="L10" href="#L10">10</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="L11" href="#L11">11</a><span class="code-text"><a-p>    </a-p><a-c>-- The name of this specific domain.  Must be unique amongst</a-c></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-c>-- all types of domain in the configuration file.</a-c></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>name</a-v><a-p> = </a-p><a-s>&#39;my.server&#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"></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-c>-- identifies the host:port pair of the remote server</a-c></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><a-c>-- Can be a DNS name or an IP address with an optional</a-c></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><a-c>-- &quot;:port&quot; on the end.</a-c></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>    </a-p><a-v>remote_address</a-v><a-p> = </a-p><a-s>&#39;192.168.1.1&#39;</a-s><a-p>,</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"></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-c>-- Whether agent auth should be disabled.</a-c></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-c>-- Set to true to disable it.</a-c></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-c>-- no_agent_auth = false,</a-c></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><a-c>-- The username to use for authenticating with the remote host</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>username</a-v><a-p> = </a-p><a-s>&#39;yourusername&#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>-- If true, connect to this domain automatically at startup</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>-- connect_automatically = true,</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"></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-c>-- Specify an alternative read timeout</a-c></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><a-c>-- timeout = 60,</a-c></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>    </a-p><a-c>-- The path to the wezterm binary on the remote host.</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"><a-p>    </a-p><a-c>-- Primarily useful if it isn&#39;t installed in the $PATH</a-c></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>-- that is configure for ssh.</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"><a-p>    </a-p><a-c>-- remote_wezterm_path = &quot;/home/yourusername/bin/wezterm&quot;</a-c></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-cr>}</a-cr><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>{{since(&#39;20220101-133340-7edc5b5a&#39;)}}</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>You may now specify a table with ssh config overrides:</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"></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-tl>lua</a-tl></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>config.</a-p><a-v>ssh_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="L47" href="#L47">47</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="L48" href="#L48">48</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> = </a-p><a-s>&#39;my.server&#39;</a-s><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><a-v>remote_address</a-v><a-p> = </a-p><a-s>&#39;192.168.1.1&#39;</a-s><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><a-v>ssh_option</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="L51" href="#L51">51</a><span class="code-text"><a-p>      </a-p><a-v>identityfile</a-v><a-p> = </a-p><a-s>&#39;/path/to/id_rsa.pub&#39;</a-s><a-p>,</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>    </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="L53" href="#L53">53</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="L54" href="#L54">54</a><span class="code-text"><a-p>}</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>```</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"></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>{{since(&#39;20220319-142410-0fcdea07&#39;)}}</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>You may now specify the type of `multiplexing` used by an ssh domain.</a-p></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>The following values are possible:</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>* `&quot;WezTerm&quot;` - this is the default; use wezterm&#39;s multiplexing client.</a-p></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>  Having wezterm installed on the server is required to use this mode.</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"><a-p>* `&quot;None&quot;` - don&#39;t use any multiplexing. The connection is an ssh connection</a-p></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>  using the same mechanism as is used by `wezterm ssh`; losing connectivity</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>  will lose any panes/tabs.  This mode of operation is convenient when using</a-p></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>  SSH to connect automatically into eg: a locally hosted WSL instance, together</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"><a-p>  with the [default_domain](config/default_domain.md) option.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"></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>A new `assume_shell` option, when coupled with `multiplexing = &quot;None&quot;`, allows</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>wezterm to assume that the remote host uses a specific shell command language</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"><a-p>dialect, which in turn allows wezterm to respect the</a-p></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>current working directory as set by [OSC 7 / Shell</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>Integration](../../shell-integration.md) on the remote host when spawning new</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>panes and tabs.  The following values are recognized for `assume_shell`:</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>* `&quot;Unknown&quot;` - this is the default. We can&#39;t make any assumptions about 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>  remote shell.</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>* `&quot;Posix&quot;` - the remote host uses a POSIX/Bourne Shell compatible environment</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"><a-p>  that allows the syntax `env -c DIR ENV1=VAL1 ENV2=VAL2 CMD` and</a-p></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>  `env -c DIR ENV1=VAL1 ENV2=VAL2 $SHELL`.</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</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="L84" href="#L84">84</a><span class="code-text"><a-p>config.</a-p><a-v>ssh_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="L85" href="#L85">85</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="L86" href="#L86">86</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> = </a-p><a-s>&#39;my.server&#39;</a-s><a-p>,</a-p></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>    </a-p><a-v>remote_address</a-v><a-p> = </a-p><a-s>&#39;192.168.1.1&#39;</a-s><a-p>,</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>    </a-p><a-v>multiplexing</a-v><a-p> = </a-p><a-s>&#39;None&#39;</a-s><a-p>,</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"></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>    </a-p><a-c>-- When multiplexing == &quot;None&quot;, default_prog can be used</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>    </a-p><a-c>-- to specify the default program to run in new tabs/panes.</a-c></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>    </a-p><a-c>-- Due to the way that ssh works, you cannot specify default_cwd,</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>    </a-p><a-c>-- but you could instead change your default_prog to put you</a-c></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-p><a-c>-- in a specific directory.</a-c></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>    </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><a-p>,</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"></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>    </a-p><a-c>-- assume that we can use syntax like:</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>    </a-p><a-c>-- &quot;env -C /some/where $SHELL&quot;</a-c></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>    </a-p><a-c>-- using whatever the default command shell is on this</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>    </a-p><a-c>-- remote host, so that shell integration will respect</a-c></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-c>-- the current directory on the remote host.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>    </a-p><a-v>assume_shell</a-v><a-p> = </a-p><a-s>&#39;Posix&#39;</a-s><a-p>,</a-p></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>  </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="L104" href="#L104">104</a><span class="code-text"><a-p>}</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"></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>config.</a-p><a-v>default_domain</a-v><a-p> = </a-p><a-s>&#39;my.server&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"></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>You may now specify the round-trip latency threshold for enabling predictive</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"><a-p>local echo using `local_echo_threshold_ms`. If the measured round-trip latency</a-p></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>between the wezterm client and the server exceeds the specified threshold, the</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>client will attempt to predict the server&#39;s response to key events and echo the</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>result of that prediction locally without waiting, hence hiding latency to the</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"><a-p>user. This option only applies when `multiplexing = &quot;WezTerm&quot;`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"></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>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"><a-p>config.</a-p><a-v>ssh_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="L118" href="#L118">118</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="L119" href="#L119">119</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> = </a-p><a-s>&#39;my.server&#39;</a-s><a-p>,</a-p></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>    </a-p><a-v>remote_address</a-v><a-p> = </a-p><a-s>&#39;192.168.1.1&#39;</a-s><a-p>,</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"><a-p>    </a-p><a-v>local_echo_threshold_ms</a-v><a-p> = </a-p><a-n>10</a-n><a-p>,</a-p></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-p><a-cr>}</a-cr><a-p>,</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>}</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>```</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">{{since(&#39;20221119-145034-49b9839f&#39;)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text">The lag indicator now defaults to disabled. It is recommended to display</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text">the lag information in your status bar using [this</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text">example](pane/get_metadata.md).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text">If you prefer to have the information overlaid on the content area, then</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text">you can set `overlay_lag_indicator = true`, but note that I&#39;d like to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text">remove that functionality in the future.</span></span></pre></div></div>
</main>
</body>
</html>
