wez / wezterm

A GPU-accelerated cross-platform terminal emulator and multiplexer written by @wez and implemented in Rust
https://wezfurlong.org/wezterm/
Other
16.93k stars 762 forks source link

Multiplexing mentions using Unix sockets to connect into WSL, but does not mention WslDomain #5744

Open xieve opened 3 months ago

xieve commented 3 months ago

What page or section of the docs have an issue? Multiplexing

Describe the issue Since I've started using Wezterm, I've read through all the top-level docs, but I have not inspected every config option there is. Since the multiplexing page mentioned that I could connect into WSL via Unix socket, I assumed that this would be the preferred way and (unsuccessfully) tried to circumvent the WSL2 socket interop issue via netcat. By chance I stumbled upon the default_domain page which does mention WslDomains and it seems to me that this should be the best and easiest way of multiplexing with WSL.

I think that at the very least, the default_domain option and its page should be mentioned on the Multiplexing page, and the Unix socket example with WSL should probably be amended with a note saying that this is a rather cumbersome way to do it (and perhaps outline reasons why it would be a good idea in the first place).