Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased libtmux has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-lisp latest

libtmux:break-pane

Break PANE from SOURCE-LINK into SESSION's free INDEX; return an outcome. SOURCE-LINK fixes the session context when breaking the window's only pane; tmux moves that link instead of creating another physical window. NAME is literal. DETACHED defaults true. OBSERVE supplies the destination window link. On tmux 3.7, a new named window requires a following RENAME-WINDOW in the same guarded request; its configured hooks can run. Failure can leave the pane moved. The pane keeps its identity. Signals INVALID-ARGUMENT, STALE-TARGET or an operational condition. Occupied indexes are never overwritten.

Source and package
Qualified name
libtmux:break-pane
Declared in
libtmux
Package
libtmux
Source
src/placement.lisp
(break-pane client pane source-link session index &key name (detached t) (observe t) cancel-token timeout output-limit)

Public owner: libtmux

tmux command#

The tmux commands behind break-pane.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss break-pane.

Esc

Type to search.

Reference previewOpen reference