tmux_pane:break/4
Break a physical pane through its explicit source membership into a destination session/index. Source, link and session must have the same registered owner. The source link's expected window and the pane's observed parent are checked before dispatch. The source selector also includes the stable pane ID, never its positional index. Preflight and action are not atomic.
Source and package
- Qualified name
-
tmux_pane: break/4 - Declared in
tmux_pane- Package
- libtmux_erlang
- Source
- apps/libtmux_erlang/src/tmux_pane.erl
- Other languages
- Perl PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure
- break(Pane, SourceLink, Session, Options) -spec break(tmux
_model: (), tmuxpane _model: (), tmuxwindow _link _model: (), breaksession _options ()) -> {ok, tmux_operation: ()} | {error, map()}.completed -
Description#
With multiple panes, tmux creates a new physical window. With only one pane, it moves the selected source membership, preserving the existing window and its other links. Moving the final membership out can remove the source session. Pane IDs and processes remain; indexes and option inheritance can change. name is a literal UTF-8 argument, subject to native name cleaning. An occupied destination index is refused. detach defaults true; false selects the destination membership. Session groups retain native synchronization.
Returns the command result consistently for both cases. Use
get/2ortmux_window_link:get/3for fresh observations. Even an eventual native error can unzoom a window; this is not a transaction and is never retried.- Parameters
-
-
Pane(tmux_model: ()) #pane -
Options(break_options ()) #
-
tmux command#
The tmux commands behind break/4.
tmux C API#
The C declarations in tmux that implement these commands.
Guides#
Pages that discuss break/4.
In other ports#
Move a pane out into a window of its own
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Ruby | Lib |
| Lua | libtmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | pane |
| Rust | pane |
| Go | tmux |
| Java | io |
| C# | Lib |
| C++ | libtmux:: |
| Swift | Server |
| OCaml | Libtmux |
| 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#.