tmux_key:bind/4
Register or replace one binding with validated command values. Commands can be one value or a flat nonempty list; tmux_command:to_config/1 applies the aggregate count and byte bounds. Options follow bind_options/0. Arguments, table names and notes are literal bytes at registration; stored commands still interpret their values and formats when a client executes them.
Source and package
- Qualified name
-
tmux_key: bind/4 - Declared in
tmux_key- Package
- libtmux_erlang
- Source
- apps/libtmux_erlang/src/tmux_key.erl
- bind(Server, Key0, Commands, Options) -spec bind(tmux
_server: (), key(), tmuxt _command: () | [tmuxt _command: (), ...], bindt _options ()) -> {ok, tmux_operation: ()} | {error, tmuxcompleted _operation: ()}.failure -
Description#
Performs I/O. tmux parses the commands before replacing an existing binding. The result confirms registration, while effects of future key presses need their own acknowledgement. Replacement resets the old repeat flag and note using the supplied options. Errors preserve backend diagnostics and unknown outcomes; there is no rollback or automatic retry.
- Parameters
-
-
Server(tmux_server: ()) #t -
Commands(tmux_command: () | [tmuxt _command: (), ...]) #t -
Options(bind_options ()) #
-
tmux command#
The tmux commands behind bind/4.
tmux C API#
The C declarations in tmux that implement these commands.
Guides#
Pages that discuss bind/4.