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

get_environment

Module LibTmux.get_environment LibTmux
Source and package
Module
LibTmux
Package
LibTmux
Source
src/configuration.jl

Methods#

get_environment( connection::LibTmux.ControlConnection, scope, name::AbstractString; inherit, kwargs... )[source]#

Refuse an environment read that cannot preserve EnvironmentValue metadata under the admitted control grammar. tmux 3.2a through the researched 3.7 dialect print literal environment newlines; format lookup cannot distinguish absent, hidden and removal entries or their local/global origin. Use an explicit Server read when that best-effort transport is acceptable. This method never falls back or returns an empty value as invented metadata.

get_environment(connection::ControlConnection, scope, name; inherit=false, kwargs...)

get_environment(server::LibTmux.Server, scope, name::AbstractString; inherit, kwargs...)[source]#

Read a global (:global) or session ( SessionRef ) environment entry. Return nothing when absent, or EnvironmentValue(value, hidden, inherited). value=nothing is a removal marker for new processes; value="" is empty. Hidden entries are returned with hidden=true. inherit=true falls back to global only for an absent session entry, never for a removal marker. This explicit multi-command observation is not an atomic child-process environment. Values retain literal control bytes, quotes and backslashes; tmux's shell-style reply is decoded as data, never executed. Variable names use [A-Za-z_][A-Za-z0-9_]*.

get_environment(server, scope, name; inherit=false, kwargs...)

Discussed in Ownership and I/O

Esc

Type to search.

Reference preview Open reference