get_option
Source and package
- Module
- LibTmux
- Package
- LibTmux
- Source
- src/configuration.jl
- get_option( connection::Lib
Tmux , scope, name::Abstract.Control Connection String ; index, inherit, kwargs... ) get_option( server::LibTmux , scope, name::Abstract.Server String ; index, inherit, kwargs... ) -
Methods#
get_option( connection::Lib
Tmux , scope, name::Abstract.Control Connection String ; index, inherit, kwargs... )[source]#Read an exact option through named, escaped replies on the pinned daemon. Scope and returned strings follow
get_option(server, ...). Missing values returnnothing; empty strings and explicitly empty arrays mask inheritance. Array reads requireindexand inspect complete local membership before any parent lookup, so a missing sparse entry is never mistaken for an empty value.get_option(connection::ControlConnection, scope, name; index=nothing, inherit=false, kwargs...)Built-in names and scopes use pinned release metadata; the named command still checks runtime availability. Seven names whose metadata changed require an encoded version observation. Ambiguous unknown version profiles are refused. Unrestricted string values are decoded as literal VIS data, never evaluated. These observations are not atomic, and no subprocess fallback occurs.
get_option( server::Lib
Tmux , scope, name::Abstract.Server String ; index, inherit, kwargs... )[source]#Read one scalar or indexed value as a string.
nothingmeans no value in the requested scope;""is an explicit empty value.inherit=truefollows tmux's parent options. Arrays require a numericindex; missing sparse entries returnnothing. String options preserve literal control bytes and backslashes. Useget_hookto read an entire command array.get_option(server, scope, name; index=nothing, inherit=false, kwargs...)Scopes are
:server,:global_session,:global_window,SessionRef,WindowRefandPaneRef. Names are exact built-in names or user names matching@[A-Za-z0-9_.-]+; abbreviations are rejected. Reads use explicit subprocess I/O and may span several observations, not a transaction. Deadline, cancellation and best-effort identity checks follownew_session.