Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Python API

Python documentation

libtmux.Pane.join

View as Markdown

Module
libtmux
Declared in
Pane
Package
libtmux
Source
src/libtmux/pane.py
Other languages
Ruby Lua TypeScript Rust GoJava.NETC++Swift
join ( self , target : str | Pane | Window , vertical : bool = True , detach : bool = True , full_window : bool | None = None , size : str | int | None = None , before : bool | None = None ) → None
method [source]
method [source]
join

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

This is the inverse of break_pane .

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

In other ports Move a pane into another window

Examples

>>> pane_to_join = window.split(shell='sleep 1m')
>>> new_window = pane_to_join.break_pane()
>>> pane_to_join.join(window)
import { PaneDirection } from "libtmux";
await pane.joinTo(window.id, { direction: PaneDirection.Below });

0 declared, 0 inherited

Esc

Type to search.