Core LibraryAPI Reference

Choose documentation 3

latest

Current version

latest
English

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

function LibTmux.jl latest

snapshot

Module LibTmux.snapshot LibTmux
Source and package
Module
LibTmux
Package
LibTmux
Source
src/acquisition.jl
Other languages
PowerShell (cmdlet) Python RubyLuaTypeScript Rust GoJavaC# C++ SwiftKotlinScalaF# (function)

Methods#

snapshot(connection::LibTmux.ControlConnection; timeout, cancel)[source]#

Acquire the captured graph over the existing terminal control connection. Two observations must agree on topology, with at most one retry within the deadline. Field values are captured observations, not an atomic transaction. The connection's two attached clients are included in client/attachment counts. Local collection and coverage semantics match snapshot(server).

snapshot(connection::ControlConnection; timeout=5.0, cancel=nothing)

snapshot(server::LibTmux.Server; timeout, cancel)[source]#

Capture sessions, physical windows/panes, contextual links and attached clients. Transient unattached command clients are outside tmux's list-clients source. Accessors and filtering use only this captured graph. New acquisitions never refresh earlier values. Retaining a selection may retain its whole snapshot.

snapshot(server; timeout=5.0, cancel=nothing)

Two observations must agree on topology and observed daemon identity. A topology race retries once within one monotonic deadline. This is a stable local observation after acquisition, not a transaction or reservation. The acquired interval contains process-relative monotonic seconds.

Subprocess generation (PID and start time) and client incarnation (PID and creation time) are best-effort observations. They do not provide strict protection against identity reuse or the check/use race during later actions.

Discussed in Captured queries · Capture a pane · Attaching to tmux

In other ports Capture the tmux hierarchy
Esc

Type to search.

Reference preview Open reference