Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased libtmux has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-lisp latest

libtmux:show-environment-text

Inspect a raw environment table; return owned UTF-8 text and a COMMAND-OUTCOME. Required SCOPE is :GLOBAL or :SESSION; a session needs a captured TARGET. NAME is literal nonempty text without NUL or =, including names outside the mutation identifier grammar. Omission lists the table. HIDDEN selects hidden entries; NIL selects ordinary entries. A visibility mismatch can return empty text, which does not prove absence. Empty values, removal markers and native escaping remain printer syntax. Session output is not a merged child environment.

Source and package
Qualified name
libtmux:show-environment-text
Declared in
libtmux
Package
libtmux
Source
src/configuration-operations.lisp
(show-environment-text client &key scope target name hidden shell-format cancel-token timeout output-limit)

Public owner: libtmux

Description#

SHELL-FORMAT selects native shell-looking presentation (-s); returned text is never evaluated or executed. Ordinary hook output is preserved. This is not a decoded environment mapping. Blocks under shared preflight/dispatch limits, starts no daemon and never retries. Missing names remain errors; operational, resource and UTF-8 failures retain client/outcome diagnostics.

See also: libtmux:error-outcome, libtmux:remove-environment, libtmux:set-environment, libtmux:show-options-text.

Guides#

Pages that discuss show-environment-text.

Esc

Type to search.

Reference previewOpen reference