Core LibraryalphaAPI 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-cxx latest

Pane.join

Move this pane into another window, splitting it.

Source and package
Qualified name
libtmux::Pane::join
Namespace
libtmux
Declared in
Pane
Package
libtmux-cxx
Source
include/libtmux/entities.hpp
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua TypeScript Rust GoJavaC#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<void, CommandFailure> join(const Window& target) const;

Description#

The other half of break_out(): that takes the tree apart, this puts it back.

The pane keeps its id, so a value held across the move still names it. The window it came from disappears if it held nothing else, which is why the target is named rather than inferred from where this pane is.

Parameters

tmux command#

The tmux commands behind join.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Move a pane into another window

Equivalents of Move a pane into another window in other languages
Language Equivalent
Python libtmux.Pane.join
Ruby LibTmux::Pane#join
Erlang tmux_pane:join/3
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript pane.Pane.joinTo
Rust no equivalent on Pane
Go tmux.Pane.Join
Java io.github.libtmux.Pane.joinTo
C# LibTmux.Pane.JoinAsync
Swift Server.join(_:into:direction:size:)
OCaml Libtmux_unix.Client.move_pane
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

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

Esc

Type to search.

Reference previewOpen reference