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.

constant libtmux stable

SCOPES_BY_LIST_CMD

Format-token scopes a given tmux list-* subcommand can resolve.

Source and package
Qualified name
libtmux.neo.SCOPES_BY_LIST_CMD
Module
libtmux.neo
Package
libtmux
Source
src/libtmux/neo.py
SCOPES_BY_LIST_CMD : dict[str, frozenset[str]] = { "list-sessions": frozenset({"universal", "session", "window", "pane"}), "list-windows": frozenset({"universal", "session", "window", "pane"}), "list-panes": frozenset({"universal", "session", "window", "pane"}), "list-clients": frozenset({"universal", "session", "window", "pane", "client"}), }

Description#

A token whose scope is in the set is safe to include in that subcommand's -F template. A token whose scope is outside the set may be unavailable for that command, so libtmux leaves it out.

The relationship is asymmetric: when tmux lists a parent object, it can also report fields for that parent's active child. A session row can include its current window and active pane fields, and a client row can include the attached session, current window, and active pane. client scope is the exception in the other direction: it appears only in list-clients because session/window/pane listings do not have a client attachment to report.

Esc

Type to search.

Reference preview Open reference