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_key:unbind/3

Remove one key from the explicit table, defaulting to prefix. Only table is accepted in the options map. A missing key in an existing table is a native no-op; a missing explicit table remains an error. Removing the final custom binding can remove its table, so a repeated call can then report that missing table. Invalid native key names are never quietly suppressed.

Source and package
Qualified name
tmux_key:unbind/3
Declared in
tmux_key
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_key.erl
unbind(Server, Key0, Options) -spec unbind(tmux_server:t(), key(), #{table => binary()}) -> {ok, tmux_operation:completed()} | {error, tmux_operation:failure()}.

Description#

Performs I/O. Effects already queued by a client are unaffected. Use clear_table/2 to remove an entire explicitly named table.

Parameters

tmux command#

The tmux commands behind unbind/3.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss unbind/3.

Esc

Type to search.

Reference previewOpen reference