Python API

method libtmux stable

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: PowerShell Julia Ruby Lua TypeScript Rust GoJavaC#C++Swift Kotlin Scala F#

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).

tmux command join-pane

In other ports Move a pane into another window

PowerShell
No source-verified PowerShell equivalent is recorded for this operation.
Julia
No source-verified Julia equivalent is recorded for this operation.
Ruby
LibTmux::Pane#join
Lua
No source-verified Lua equivalent is recorded for this operation.
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:)
Kotlin
No source-verified Kotlin equivalent is recorded for this operation.
Scala
No source-verified Scala equivalent is recorded for this operation.
F#
No source-verified F# equivalent is recorded for this operation.