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:run/2

Request native set-hook -R in the explicit context/0. tmux resolves the hook through that context's effective tables; global table flags do not select a separate execution scope. A session uses its current window and pane. A window link fixes the observed session/index and expected physical window; a pane context additionally checks that pane's observed parent.

Source and package
Qualified name
tmux_hook:run/2
Declared in
tmux_hook
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_hook.erl
run(Context, Name0) -spec run(context(), binary()) -> {ok, tmux_operation:completed()} | {error, tmux_operation:failure()}.

Description#

Performs I/O. The result is the native command outcome, not an acknowledgement of background work launched by its commands. A missing or empty effective hook can succeed without effects. Wait on an application completion condition when effects matter. Existence and membership checks precede dispatch. If the target disappears after preflight, tmux can still fall back to another context. This is not atomic compare-and-act. Use fresh links after known topology changes.

Parameters

tmux command#

The tmux commands behind run/2.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss run/2.

Esc

Type to search.

Reference previewOpen reference