tmux_window_link
Act on a physical window's observed membership in a particular session.
Source and package
- Qualified name
-
tmux_window _link - Package
- libtmux_erlang
- Source
- apps/libtmux_erlang/src/tmux_window_link.erl
- tmux_window_link
-
Description#
A window link is identified by session ID, window index and expected physical window ID. It has no stable tmux link ID. These calls check that the observed membership still names the expected window before dispatching an action. Missing or replaced membership returns stale_link. A link that moves away and back to the same coordinates and physical window cannot be distinguished.
The preflight and action use separate one-shot commands. Concurrent changes after preflight can still affect the action; this is not atomic compare-and-act. All input rows must belong to the same registered owner. Re-read or explicitly bind rows when using another owner. Closed owners and known restarts invalidate their rows. Every call performs explicit I/O after validating its arguments.
Use
tmux_window:kill/1to destroy a physical window across all memberships. Useunlink/2to remove one membership. Existing rows and snapshots are never refreshed by actions; useget/3or a new snapshot for current memberships.
Members10#
Common operations6#
- link/3 function Add another membership of this link's physical window to the destination session and explicit index. Defaults to detached and refuses an occupied index. replace = true maps to tmux -k and can destroy the occupied window. Returns the command result; use
get/3to observe the new membership. The source membership remains. Session groups and renumber-windows retain their tmux semantics. Performs I/O after owner and membership checks. - unlink/2 function Remove one checked membership. force defaults false, retaining tmux's protection for windows linked to only one session. force = true permits removing the last link, destroying that physical window and possibly its session. Duplicate links within one session retain tmux's native protection rules. Performs I/O and returns the command result without refreshing rows.
- select/1 function Select this membership as its session's current window after checking the expected physical window. Performs I/O and returns the command result.
- move/3 function Move this membership to the destination session and explicit index, leaving its physical window's other links intact. Placement options follow
link/3. Moving the final window out of a session can destroy that session; automatic renumbering and session groups can change other memberships. Captured rows remain unchanged. Returns the command result after observed preflight. - swap/3 function Swap the physical windows at two checked memberships. Other links to either window remain intact. detach maps to tmux -d and defaults true. tmux applies its session-selection and group-synchronization rules. Returns the command result; old rows still name their original expected windows and can become stale. Performs I/O, with the documented gap between preflight and action.
- get/3 function Read a current membership at the explicit session ID and index. The returned native row carries its registered owner and a new observation identity. Returns target_gone if the session or index is absent. This read does not make later actions atomic and does not refresh previously captured links.
Other members4#
- index/0 typealias An explicit tmux window index; relative and next-free selectors are not accepted.
- placement_options/0 typealias Destination index is required. Defaults: detach true, replace false. Replacement may destroy the destination window.
- swap_options/0 typealias Maps detach to tmux's -d flag, default true.
- unlink_options/0 typealias Force defaults false. Force permits unlinking the last membership and destroying its physical window.
Guides#
Pages that discuss tmux_window_link.
- Concepts
- Guides