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
Benoit de Chezelles f37c3ae5da
Fix some documentation pages (#3321)
* Update ssh_backend.md

* Update normalize_output_to_unicode_nfc.md

* Update strikethrough_position.md

* Update underline_position.md

* Update underline_thickness.md

* Fix lua config docs titles to be formatted as inline code

* Mention how suggested alphabet for quick select is choosen

* Mention update-status and update-right-status for status_update_interval

* Fix docs for all keyassignments to be formatted as inline code

* Fix Lua object index titles

* Fix titles of `wezterm.*` module index pages

* Fix title of `Color` object & `wezterm.color` functions

We reduce titles from h2 to h1 because mkdocs defaults the page title to
the page file name if no h1 header is found.

* Unify title of all object methods

* Add index page for Gui events
2023-03-22 06:36:03 -07:00

1011 B

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 (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:

config.ssh_domains = {
  {
    name = 'devhost',
    remote_address = 'devhost.example.com',
  },
}
config.keys = {
  {
    key = 'U',
    mods = 'CTRL|SHIFT',
    action = wezterm.action.AttachDomain 'devhost',
  },
}

See also: DetachDomain