1
1
mirror of https://github.com/wez/wezterm.git synced 2024-12-29 16:42:13 +03:00
wezterm/docs/config/lua/keyassignment/AttachDomain.md

38 lines
1.0 KiB
Markdown

# AttachDomain(domain_name)
*Since: 20220624-141144-bd1b7c5d*
Attempts to attach the named multiplexing domain. The name can be any of the
names used in you `ssh_domains`, `unix_domains` or `tls_clients`
configurations.
Attaching a domain will attempt to import the windows, tabs and panes from the
remote system into those of the local GUI.
If there are no remote panes in that domain, wezterm will spawn a default
program into it.
This action is not bound to any keys by default. The [Launcher Menu](../../launch.md#the-launcher-menu)
(default: right click on the new tab `+` button in the tab bar) will synthesize
entries with this action.
The example below shows how to bind a key to trigger attaching to an ssh domain:
```lua
local wezterm = require 'wezterm'
return {
ssh_domains = {
{
name = "devhost",
remote_address = "devhost.example.com",
}
},
keys = {
{key="U", mods="CTRL|SHIFT", action=wezterm.action.AttachDomain("devhost")},
},
}
```
See also: [DetachDomain](DetachDomain.md)