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 latest

Window.swap

Swap this window with another via $ tmux swap-window.

Source and package
Qualified name
libtmux.Window.swap
Module
libtmux
Declared in
Window
Package
libtmux
Source
src/libtmux/window.py
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby LuaTypeScriptRustGo Java C#C++Swift Kotlin Scala OCaml F# Clojure
swap ( self, target: str | Window, detach: bool | None = None ) → None

Examples#

>>> w1 = session.new_window(window_name='swap_a')
>>> w2 = session.new_window(window_name='swap_b')
>>> w1_idx = w1.window_index
>>> w2_idx = w2.window_index
>>> w1.swap(w2)
>>> w1.window_index == w2_idx
True
>>> w2.window_index == w1_idx
True
Parameters
  • target (str | Window) # – Target window to swap with. Can be a window ID string or Window.

  • detach (bool | None) # – Do not change the active window (-d flag).

tmux command#

The tmux commands behind swap.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Exchange two windows

Equivalents of Exchange two windows in other languages
Language Equivalent
Lua libtmux.WindowLink:swap
Erlang tmux_window_link:swap/3
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript window.Window.swapWith
Rust window.Window.swap_with
Go tmux.Window.Swap
Java no equivalent on Window
C# LibTmux.Window.SwapAsync
C++ libtmux::Window::swap_with
Swift Server.swap(_:with:)
OCaml No direct public OCaml equivalent is recorded for this operation.
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

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

Esc

Type to search.

Reference previewOpen reference