C++ API

method libtmux-cxx latest

Pane.break_out

Take this pane out into a window of its own, which is returned.

Source and package

Qualified name: libtmux::Pane::break_out
Namespace: libtmux
Declared in: Pane
Package: libtmux-cxx
Source: include/libtmux/entities.hpp
Other languages: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGoJavaC#Swift Kotlin Scala OCaml F# Clojure

[[C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.Language documentation]] expected<Window, CommandFailure> break_out(std::string_view name = {}) const; method readonly [source] ¶

Description#

If it is already the window's only pane, return that window without moving it. An empty name leaves tmux to name the window after what is running.

Parameters

The tmux commands behind break_out.

break-pane (the window has several panes) display-message (the window has one pane) if-shell rename-window (named, and the window has one pane)

The C declarations in tmux that implement these commands.

Move a pane out into a window of its own

Equivalents of Move a pane out into a window of its own in other languages
Language	Equivalent
Python	`libtmux.Pane.break_pane`
Ruby	`LibTmux::Pane#break_out`
Lua	`libtmux.Pane:break_out`
Erlang	`tmux_pane:break/4`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`pane.Pane.breakOut`
Rust	`pane.Pane.break_out`
Go	`tmux.Pane.BreakPane`
Java	`io.github.libtmux.Pane.breakOut`
C#	`LibTmux.Pane.BreakAsync`
Swift	`Server.breakPane(_:from:named:)`
OCaml	`Libtmux_unix.Client.break_pane`
Perl	No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in PowerShell, Julia, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.