Python API

method libtmux latest

Pane.join

Join this pane into another window/pane via $ tmux join-pane.

Source and package

Qualified name: libtmux.Pane.join
Module: libtmux
Declared in: Pane
Package: libtmux
Source: src/libtmux/pane.py
Other languages: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScript Rust GoJavaC#C++Swift Kotlin Scala OCaml F# Clojure

Description#

This is the inverse of break_pane().

>>> pane_to_join = window.split(shell='sleep 1m')
>>> new_window = pane_to_join.break_pane()
>>> pane_to_join.join(window)

Parameters

target (str | Pane | Window) # – Target pane or window to join into.
vertical (bool) # – Join vertically (-v flag), default True. Set to False for horizontal (-h).
detach (bool) # – Do not switch to the target window (-d flag), default True.
full_window (bool | None) # – Join spanning the full window width/height (-f flag).
size (str | int | None) # – Size for the joined pane (-l flag).
before (bool | None) # – Place the pane before the target (-b flag).

The tmux commands behind join.

The C declarations in tmux that implement these commands.

Move a pane into another window

Equivalents of Move a pane into another window in other languages
Language	Equivalent
Ruby	`LibTmux::Pane#join`
Erlang	`tmux_pane:join/3`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`pane.Pane.joinTo`
Rust	no equivalent on `Pane`
Go	`tmux.Pane.Join`
Java	`io.github.libtmux.Pane.joinTo`
C#	`LibTmux.Pane.JoinAsync`
C++	`libtmux::Pane::join`
Swift	`Server.join(_:into:direction:size:)`
OCaml	`Libtmux_unix.Client.move_pane`
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#.