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:get/3

Read one option or array, performing I/O after validation. Missing local values and array entries return none; known empty strings and arrays return {ok, Value}. inherit = true reads through tmux's parent tables. Unknown fields are rejected. Errors retain backend diagnostics; a missing target never becomes absence. Use set/4 to write a value and unset/2 to restore inheritance.

Source and package
Qualified name
tmux_option:get/3
Declared in
tmux_option
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_option.erl
get(Scope, Key, Options) -spec get(scope(), key(), read_options()) -> {ok, value()} | none | {error, map()}.
Parameters

tmux command#

The tmux commands behind get/3.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference