Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

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

function libtmux-erlang latest

tmux_option:set/4

Set a literal binary value, after scope/version/owner validation. Array writes require {Name, Index}; this avoids tmux's whole-array separator grammar. append uses tmux's type-specific -a semantics. only_if_unset checks the local table; already-set is a backend error, with no suppressed errors or compare-and-swap guarantee. Values must be supplied explicitly; an empty flag value retains tmux's native toggle behavior. A successful result proves command completion, not later effects of a stored command or format. Performs I/O; never retries.

Source and package
Qualified name
tmux_option:set/4
Declared in
tmux_option
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_option.erl
set(Scope, Key, Value, Options) -spec set(scope(), key(), binary(), write_options()) -> {ok, tmux_operation:completed()} | {error, tmux_operation:failure()}.
Parameters

tmux command#

The tmux commands behind set/4.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference