Python API

libtmux.Pane.break_pane

Python

Module: libtmux
Declared in: Pane
Package: libtmux
Source: src/libtmux/pane.py
Other languages: Ruby Lua TypeScript Rust Go Java .NET C++Swift

break_pane ( self , detach : bool = True , window_name : str | None = None ) → Window method [source] ¶ method [source] ¶ break_pane

Break this pane out into a new window via $ tmux break-pane.

Parameters

detach ( bool ) – Do not switch to the new window (-d flag), default True.
window_name ( str | None ) – Name for the new window (-n flag).

Returns

Window The newly created window containing the pane.

In other ports Move a pane out into a window of its own

Ruby LibTmux::Pane#break_out
Lua libtmux.Pane:break_out
TypeScript pane.Pane.breakOut
Rust pane.Pane.break_out
Go tmux.Pane.BreakPane
Java io.github.libtmux.Pane.Pane.breakOut
.NET LibTmux.Pane.BreakAsync
C++ libtmux::Pane::break_out
Swift Server.breakPane(_:from:named:)

Examples

Python TypeScript Rust

>>> pane_to_break = window.split(shell='sleep 1m')
>>> new_window = pane_to_break.break_pane(window_name='broken')
>>> new_window.window_name
'broken'

await pane.breakOut("extracted");

use libtmux::{SplitDirection, SplitOptions};

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("broken-out").await?;
let pane = session.panes().await?.remove(0);
let stays = pane.window_id().clone();

let moved = pane.split(SplitOptions::new(SplitDirection::Below)).await?;
let moved = moved.break_out().await?;

// The window it landed in, without listing the server to find it.
assert_ne!(moved.window_id(), &stays);

0 declared, 0 inherited