<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/keyassignment/AttachDomain.md - fork/wezterm @ termiz-0.23.1</title>
<meta name="description" content="docs/config/lua/keyassignment/AttachDomain.md in fork/wezterm at termiz-0.23.1.">
<meta property="og:title" content="docs/config/lua/keyassignment/AttachDomain.md - fork/wezterm @ termiz-0.23.1">
<meta property="og:description" content="docs/config/lua/keyassignment/AttachDomain.md in fork/wezterm at termiz-0.23.1.">
<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.1" data-tip="7053748e4d899e7fc5e202d6f903b052fc78e759">
<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">Andrii</span><span class="commit-message" data-commit="925568a21505a8b7299663a7b2db962fa0baa9f8">Update AttachDomain.md</span><span class="snapshot-sha sha" data-commit="925568a21505a8b7299663a7b2db962fa0baa9f8">925568a21</span><time datetime="2024-01-24T22:52:46+01:00" title="2024-01-24 22:52:46 +0100">2024-01-24</time></p>
<header class="topbar"><details class="switcher"><summary>termiz-0.23.1</summary><div class="menu"><strong>branches</strong><a href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a class="current" 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 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.1/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termiz-0.23.1/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termiz-0.23.1/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termiz-0.23.1/tree/docs/config/lua/keyassignment/">keyassignment</a> / <span class="cur">AttachDomain.md</span></nav>
<span class="view-stats"><span>1012 B</span><span>37 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/034f8bd33f6d1d536b1a418a78bc5d5de1f00b18/docs/config/lua/keyassignment/AttachDomain.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>AttachDomain(domain_name)</code></h1>
<p>{{since('20220624-141144-bd1b7c5d')}}</p>
<p>Attempts to attach the named multiplexing domain.  The name can be any of the
names used in your <code>ssh_domains</code>, <code>unix_domains</code> or <code>tls_clients</code>
configurations.</p>
<p>Attaching a domain will attempt to import the windows, tabs and panes from the
remote system into those of the local GUI.</p>
<p>If there are no remote panes in that domain, wezterm will spawn a default
program into it.</p>
<p>This action is not bound to any keys by default. The <a href="/fork/wezterm/ref/termiz-0.23.1/blob/docs/config/launch.md#the-launcher-menu">Launcher Menu</a>
(default: right click on the new tab <code>+</code> button in the tab bar) will synthesize
entries with this action.</p>
<p>The example below shows how to bind a key to trigger attaching to an ssh domain:</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;devhost&#39;</a-s><a-p>,</a-p>
    <a-v>remote_address</a-v> = <a-s>&#39;devhost.example.com&#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>keys</a-v> = <a-cr>{</a-cr>
  <a-cr>{</a-cr>
    <a-v>key</a-v> = <a-s>&#39;U&#39;</a-s><a-p>,</a-p>
    <a-v>mods</a-v> = <a-s>&#39;CTRL|SHIFT&#39;</a-s><a-p>,</a-p>
    <a-v>action</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>AttachDomain</a-f> <a-s>&#39;devhost&#39;</a-s><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>See also: <a href="/fork/wezterm/ref/termiz-0.23.1/blob/docs/config/lua/keyassignment/DetachDomain.md">DetachDomain</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>`AttachDomain(domain_name)`</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;20220624-141144-bd1b7c5d&#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">Attempts to attach the named multiplexing domain.  The name can be any of the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">names used in your `ssh_domains`, `unix_domains` or `tls_clients`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">configurations.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">Attaching a domain will attempt to import the windows, tabs and panes from the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">remote system into those of the local GUI.</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">If there are no remote panes in that domain, wezterm will spawn a default</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">program into it.</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">This action is not bound to any keys by default. The [Launcher Menu](../../launch.md#the-launcher-menu)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">(default: right click on the new tab `+` button in the tab bar) will synthesize</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">entries with this action.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">The example below shows how to bind a key to trigger attaching to an ssh domain:</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>```</a-p><a-tl>lua</a-tl></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>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="L23" href="#L23">23</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="L24" href="#L24">24</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> = </a-p><a-s>&#39;devhost&#39;</a-s><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>    </a-p><a-v>remote_address</a-v><a-p> = </a-p><a-s>&#39;devhost.example.com&#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"><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="L27" href="#L27">27</a><span class="code-text"><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>config.</a-p><a-v>keys</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="L29" href="#L29">29</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="L30" href="#L30">30</a><span class="code-text"><a-p>    </a-p><a-v>key</a-v><a-p> = </a-p><a-s>&#39;U&#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"><a-p>    </a-p><a-v>mods</a-v><a-p> = </a-p><a-s>&#39;CTRL|SHIFT&#39;</a-s><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"><a-p>    </a-p><a-v>action</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>AttachDomain</a-f><a-p> </a-p><a-s>&#39;devhost&#39;</a-s><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><a-cr>}</a-cr><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>```</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text">See also: [DetachDomain](DetachDomain.md)</span></span></pre></div></div>
</main>
</body>
</html>
