libtmux:list-keys
Inspect key bindings; return owned UTF-8 printer text and a command outcome. Omit TABLE to list every key table. TABLE and KEY are literal strings; native unknown-table and invalid-key failures remain errors. An unbound valid KEY is an error except on tmux 3.7 through 3.7c, which return empty text. Those releases also send a single matching row to the server message log and any selected frontend's status line instead of stdout. Empty text does not prove absence. FORMAT is explicit tmux format source and requires live tmux 3.7 or newer; older daemons signal UNSUPPORTED-CAPABILITY before payload dispatch. Omission uses the native human-readable listing.
Source and package
- Qualified name
-
libtmux:list-keys - Declared in
libtmux- Package
- libtmux
- Source
- src/key-bindings.lisp
-
Public owner:
libtmuxDescription#
FORMAT has no time expansion. #() can start asynchronous command-client jobs, whose output may be incomplete and whose cleanup follows client disconnect. Empty expanded lines may be omitted. Native escaping, whitespace and after-hook output are preserved; the text is not a parsed or replayable configuration. Blocks under shared preflight/dispatch limits and never retries. Invalid UTF-8 signals DECODING-ERROR; operational failures retain their outcome.
See also:
libtmux:bind-key,libtmux:error-outcome,libtmux:list-commands,libtmux:unbind-key.
Guides#
Pages that discuss list-keys.