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.

Go API

method libtmux-go latest

Pane.BreakPane

BreakPane moves the receiver into a new window in its exact session. Attach lets that new winlink become current in the session; it is not a global client-focus guarantee. The returned Window is freshly materialized in the receiver SessionID rather than by canonical ID-only refresh.

Source and package
Qualified name
tmux.Pane.BreakPane
Package
tmux
Declared in
Pane
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/pane_relocate.go
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustJavaC#C++Swift Kotlin Scala OCaml F# Clojure

Description#

Before tmux 3.6, the sole-pane path may print no ID and retain WindowID; this method refreshes that identity. Exact 3.7 requires an explicit name before mutation, supplies it to prevent the native crash, then renames the result to repair the multi-pane naming defect. Suffixed 3.7 releases use native naming.

After a reported ID, rename failure, or refresh failure, the partial result carries the known WindowID and receiver session with Index -1. Earlier failures return zero; no mutation is rolled back.

tmux command#

The tmux commands behind BreakPane.

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.
TypeScript pane.Pane.breakOut
Rust pane.Pane.break_out
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