tmux_pane:join/3
Move a source pane into a split beside the destination pane. Both physical IDs must belong to the same registered owner and must differ. Geometry follows join_options/0. Existing processes and pane IDs survive; dimensions, indexes and inherited window options can change. Removing a window's last pane destroys that physical window and its links, and can remove sessions.
Source and package
- Qualified name
-
tmux_pane: join/3 - Declared in
tmux_pane- Package
- libtmux_erlang
- Source
- apps/libtmux_erlang/src/tmux_pane.erl
- Other languages
- Perl PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua TypeScript Rust GoJavaC#C++Swift Kotlin Scala OCaml F# Clojure
- join(Source, Destination, Options) -spec join(tmux
_model: (), tmuxpane _model: (), joinpane _options ()) -> {ok, tmux_operation: ()} | {error, map()}.completed -
Description#
Default detach true avoids selecting the resolved destination session; false uses tmux's resolved session context for the destination pane. Shared physical windows affect all their memberships. Returns the command result without refreshing either row. Use
get/2for current fields. No retry is performed.- Parameters
-
-
Source(tmux_model: ()) #pane -
Options(join_options ()) #
-
tmux command#
The tmux commands behind join/3.
tmux C API#
The C declarations in tmux that implement these commands.
Guides#
Pages that discuss join/3.
In other ports#
Move a pane into another window
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Ruby | Lib |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | pane |
| Rust | no equivalent on Pane |
| Go | tmux |
| Java | io |
| C# | Lib |
| C++ | libtmux:: |
| Swift | Server |
| OCaml | Libtmux |
| Perl | No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands. |
No equivalent is recorded in Lua, PowerShell, Julia, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.