tmux_hook:get/3
Read a builtin hook array or indexed entry. Options follow tmux_option:read_options/0: local-only by default, inherit = true follows its parent tables. Missing local arrays or entries return none; an empty local array returns {ok, #{}} and masks inheritance.
Source and package
- Qualified name
-
tmux_hook: get/3 - Declared in
tmux_hook- Package
- libtmux_erlang
- Source
- apps/libtmux_erlang/src/tmux_hook.erl
- get(Scope, Key, Options) -spec get(scope(), tmux
_option: (), tmuxkey _option: ()) -> {ok, value()} | none | {error, map()}.read _options -
Description#
Values are tmux's command-list serialization, including its quoting and escape sequences. They are neither the original input text nor individual decoded arguments. Reading does not execute them. Use
set/3for validated command values andunset/2to restore inheritance. Performs I/O and preserves backend errors; a vanished target is not an absent hook.- Parameters
-
-
Key(tmux_option: ()) #key
tmux command#
The tmux commands behind get/3.
tmux C API#
The C declarations in tmux that implement these commands.
Guides#
Pages that discuss get/3.