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

subscribe_format

Module LibTmux.subscribe_format LibTmux
Source and package
Module
LibTmux
Package
LibTmux
Source
src/observation.jl

Methods#

subscribe_format(f, connection::LibTmux.ControlConnection, args...; kwargs...)[source]#

subscribe_format( connection::LibTmux.ControlConnection, target::Union{LibTmux.SessionRef, LibTmux.WindowRef, LibTmux.PaneRef}, field::AbstractString; timeout, cancel, after, kwargs... )[source]#

Subscribe to one admitted format field for the attached session, a window, or a pane. Updates retain escaped bytes from the field codec. tmux checks subscriptions at most once per second; these updates cannot establish prompt readiness or output quiescence. Closing removes only this generated name. Pane subscriptions use a window pane-loop with an exact pane ID so retained dead panes still update on tmux versions that skip direct dead-pane watches. Updates retain their session/window-link context. Removal or movement requires a new baseline; subscriptions do not silently follow another window.

subscribe_format(connection, target, field; timeout=5.0, cancel=nothing, kwargs...)

Discussed in Observing output

Esc

Type to search.

Reference preview Open reference