tmux list-keys
List key bindings.
Syntax¶
tmux list-keys [-1aNr] [-F format] [-O order] [-P prefix-string][-T key-table] [key]Alias: lsk.
Behavior¶
-F specifies the format of each
line. See the FORMATS section.
-T specifies a key-table to
list from. -1 lists only the first matching key.
-O specifies the sort order: one of
‘key’,
‘modifier’,
‘name’ (table name).
-r reverses the sort order.
If no format is given, there are two
forms: the default lists keys as bind-key
commands; -N lists only keys with attached notes
and shows only the key and note for each key.
With the default form, all key tables are listed unless specified otherwise.
With the -N form, only keys in the
root and prefix key tables are
listed by default; -T also lists only keys in
key-table. -P specifies a
prefix to print before each key. -a lists the
command for keys that do not have a note rather than skipping them.
C implementation¶
Internal declarations in tmux 3.7c:
Use from a library¶
Each API describes its own defaults, errors and execution model.
tmux sources and license
Syntax comes from tmux 3.7c list-commands. See the global options for sockets and configuration, and command syntax and targets.
Behavior is taken from the tmux 3.7c manual.
Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com> Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.