mirror of
https://github.com/wez/wezterm.git
synced 2024-12-29 00:21:57 +03:00
f37c3ae5da
* 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
30 lines
1013 B
Markdown
30 lines
1013 B
Markdown
# `wezterm.mux` module
|
|
|
|
{{since('20220624-141144-bd1b7c5d')}}
|
|
|
|
The `wezterm.mux` module exposes functions that operate on the multiplexer layer.
|
|
|
|
The multiplexer manages the set of running programs into panes, tabs, windows
|
|
and workspaces.
|
|
|
|
The multiplexer may not be connected to a GUI so certain operations that require
|
|
a running Window management system are not present in the interface exposed
|
|
by this module.
|
|
|
|
You will typically use something like:
|
|
|
|
```lua
|
|
local wezterm = require 'wezterm'
|
|
local mux = wezterm.mux
|
|
```
|
|
|
|
at the top of your configuration file to access it.
|
|
|
|
## Important Note!
|
|
|
|
*You should **avoid using, at the file scope in your config**, mux functions that cause new splits, tabs or windows to be created. The configuration file can be evaluated multiple times in various contexts. If you want to spawn new programs when wezterm starts up, look at the [gui-startup](../gui-events/gui-startup.md) and [mux-startup](../mux-events/mux-startup.md) events.*
|
|
|
|
## Available functions, constants
|
|
|
|
|