Python API

method libtmux latest

Window.link

Link this window to another session via $ tmux link-window.

Source and package

Qualified name: libtmux.Window.link
Module: libtmux
Declared in: Window
Package: libtmux
Source: src/libtmux/window.py
Other languages: Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp RubyLuaTypeScriptRustGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure

Examples#

>>> w = session.new_window(window_name='link_test')
>>> s2 = server.new_session(session_name='link_target')
>>> w.link(s2)

Parameters

target_session (str | Session) # – Target session to link the window to.
target_index (str | None) # – Target window index in the destination session.
kill_existing (bool | None) # – Kill target window if it exists (-k flag).
after (bool | None) # – Insert after the target window (-a flag).
before (bool | None) # – Insert before the target window (-b flag).
detach (bool | None) # – Do not make the linked window active (-d flag).

The tmux commands behind link.

The C declarations in tmux that implement these commands.

Link a window into another session

Equivalents of Link a window into another session in other languages
Language	Equivalent
Ruby	`LibTmux::Session#link_window`
Lua	`libtmux.WindowLink:link`
Erlang	`tmux_window_link:link/3`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`window.Window.link`
Rust	`window.Window.link_to`
Go	`tmux.Window.Link`
Java	`io.github.libtmux.Window.linkTo`
C#	`LibTmux.Window.LinkAsync`
C++	`libtmux::Window::link_to`
Swift	`Server.link(_:into:)`
OCaml	`Libtmux_unix.Client.link_window`
Perl	`LibTmux::Server::link_window` Explicit Server operation. Captured entities remain local observations; use a new snapshot to observe changes.

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