Core LibrarystableAPI Reference

Choose documentation 3

stable

Current version

stable
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Python API

property libtmux stable

Window.linked_sessions

Every session this window is reachable from.

Source and package
Qualified name
libtmux.Window.linked_sessions
Module
libtmux
Declared in
Window
Package
libtmux
Source
src/libtmux/window.py
Other languages
PowerShell Julia Ruby Lua TypeScriptRustGo Java C# C++ Swift Kotlin Scala F#
linked_sessions (self) → QueryList[Session]

Description#

Usually one, and then this is just Window.session in a list. link-window and grouped sessions (tmux new-session -t existing) make it more: the window is genuinely in each of them at once, and Window.session returns the session recorded on this Window instance.

Each session is listed once, however many indexes it links the window at, and they come back in the order tmux lists them. Fetching the holders takes two list commands total, independent of how many there are. If either listing fails, the result is empty.

Examples#

A window you just made belongs to the session you made it in:

>>> window = session.new_window(window_name="solo", attach=False)
>>> [s.session_name for s in window.linked_sessions] == [session.session_name]
True

Link it into a second session and it belongs to both:

>>> guest = server.new_session(session_name="guest")
>>> target = f"{guest.session_id}:"
>>> _ = server.cmd("link-window", "-d", "-s", window.window_id, "-t", target)
>>> sorted(s.session_name for s in window.linked_sessions) == sorted(
... [session.session_name, "guest"]
... )
True

Discussed in Filtering and queries

In other ports Every session a window is linked into
  • PowerShell
    No source-verified PowerShell equivalent is recorded for this operation.
  • Julia
    No source-verified Julia equivalent is recorded for this operation.
  • Ruby
    No source-verified Ruby equivalent is recorded for this operation.
  • Lua
    No source-verified Lua equivalent is recorded for this operation.
  • TypeScript
  • Rust
  • Go
  • Java
    no equivalent on Window
  • C#
  • C++
    Window::linked_sessions counts them rather than listing them
  • Swift
    no equivalent on Window
  • Kotlin
    No source-verified Kotlin equivalent is recorded for this operation.
  • Scala
    No source-verified Scala equivalent is recorded for this operation.
  • F#
    No source-verified F# equivalent is recorded for this operation.
Esc

Type to search.

Reference preview Open reference