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_hook:set/3

Replace one {Name, Index} entry with validated command values. An explicit index is required; other entries remain. Indexes range from zero to 2147483647. The rendered command text is bounded before dispatch. Native commands still interpret their arguments and formats when the hook later runs. Use append/3 for native vacant-index selection and clear/2 to mask inherited hooks with an empty local array.

Source and package
Qualified name
tmux_hook:set/3
Declared in
tmux_hook
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_hook.erl
set(Scope, Key, Commands) -spec set(scope(), {binary(), non_neg_integer()}, commands()) -> {ok, tmux_operation:completed()} | {error, tmux_operation:failure()}.

Description#

Performs I/O. tmux parses commands before replacing an existing entry, but a failed first write can already create an empty local override. Registration and later execution are separate; this call promises no transaction, rollback or completion of future effects.

Parameters

tmux command#

The tmux commands behind set/3.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss set/3.

Esc

Type to search.

Reference previewOpen reference