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:set-environment

Set one raw tmux environment entry and return its COMMAND-OUTCOME. SCOPE is required: :GLOBAL rejects TARGET; :SESSION requires a captured session. NAME must match [A-Za-z_][A-Za-z0-9_]*. VALUE is literal unless FORMAT-P explicitly requests tmux format expansion. HIDDEN sets tmux's hidden flag. This mutates one raw table, not an effective merged child environment. Never retries or refreshes captured observations. See UNSET-ENVIRONMENT for deletion and REMOVE-ENVIRONMENT for an explicit tombstone.

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

Public owner: libtmux

tmux command#

The tmux commands behind set-environment.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss set-environment.

Esc

Type to search.

Reference previewOpen reference