Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-ts latest

Pane.breakOut

Move this pane out into a window of its own, in the session it is in.

Source and package
Qualified name
Pane.breakOut
Module
pane
Declared in
Pane
Package
libtmux
Source
packages/libtmux/src/pane.ts
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaRustGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure

Description#

tmux places a break with no destination in whichever session is current, which is the attached one rather than this pane's.

On tmux 3.7 exactly, a break with no name crashes the server, so a breakOut() without a windowName is refused there before anything is sent.

Examples#

await pane.breakOut("extracted");
Parameters

tmux command#

The tmux commands behind breakOut.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

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.
Rust pane.Pane.break_out
Go tmux.Pane.BreakPane
Java io.github.libtmux.Pane.breakOut
C# LibTmux.Pane.BreakAsync
C++ libtmux::Pane::break_out
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#.

Esc

Type to search.

Reference previewOpen reference