tmux_key
Register and remove bindings in explicit server key tables.
Source and package
- Qualified name
-
tmux_key - Package
- libtmux_erlang
- Source
- apps/libtmux_erlang/src/tmux_key.erl
- tmux_key
-
Description#
bind/3uses the native prefix table;bind/4chooses a table, repeat flag and note. Command values usetmux_command:to_config/1for the stored parser boundary. Replacing a binding resets its commands, repeat flag and note. Registration does not prove that a client later executed the binding.Tables belong to the server. A session's key-table option selects its default table through
tmux_option; tmux's prefix and client table-switching rules still apply. Registering a custom table does not select it for any client.clear_table/2requires an explicit name and can affect attached clients.listing/2returns native presentation bytes. Field padding, quoting, note coverage and formatting vary by daemon release. It does not decode bindings or promise reusable configuration. Retain the original command values when an application needs to install the same binding again.Key names use tmux's own binary spellings, such as C-b, Enter and MouseDown1Pane. The daemon validates actual names and modifiers. Library validation bounds bytes and rejects NUL before dispatch. Calls use registered endpoint identity, perform explicit I/O and never retry uncertain mutations. They do not attach a client or refresh captured rows.
The key-table guide installs and removes an application-owned table.
Members10#
Collections and queries1#
Common operations6#
- bind/3 function Register commands in the native prefix table with default options. Performs I/O; see
bind/4for replacement, command parsing and future execution. - unbind/2 function Remove a binding from the native prefix table. Performs I/O; see
unbind/3. - bind/4 function Register or replace one binding with validated command values. Commands can be one value or a flat nonempty list;
tmux_command:to_config/1applies the aggregate count and byte bounds. Options followbind_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. - clear_table/2 function Remove the entire explicitly named table through native unbind-key -a -T. Names use the bounds in
bind_options/0. This can remove default bindings and affect attached clients. Missing tables remain native errors; this call does not restore factory defaults or cancel commands already queued. Performs I/O after endpoint and argument validation. - listing/2 function Read native list-keys presentation output, optionally filtering by table and key through
listing_options/0. Returns the command's stdout unchanged; spacing, quoting and included metadata follow that daemon. This is a text view, with no decoded-row, exact-note or configuration-round-trip guarantee. - unbind/3 function 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.
Other members3#
- bind_options/0 typealias Default table is prefix and repeat is false. Tables contain 1..1024 NUL-free bytes. note is at most 32 KiB of NUL-free bytes; omitting it removes an old note when commands are replaced. Command-level aggregate bounds still apply.
- key/0 typealias A nonempty NUL-free native key spelling, at most 128 bytes; tmux validates its meaning.
- listing_options/0 typealias No table filter lists all native tables. table restricts the listing to one nonempty NUL-free name of at most 1024 bytes; key restricts it to a native key spelling. Missing tables and invalid key spellings retain native errors. Unmatched filters can return empty output or a backend error by release.
Guides#
Pages that discuss tmux_key.