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:listing/2

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.

Source and package
Qualified name
tmux_key:listing/2
Declared in
tmux_key
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_key.erl
listing/2 -spec listing(tmux_server:t(), listing_options()) -> {ok, binary()} | {error, map()}.

Description#

tmux 3.4 can escape dollar signs in this output. tmux 3.7c can send a single matching entry to its status-message path, producing empty stdout without an attached target client. Empty presentation output does not prove absence. The key-table guide demonstrates a table with multiple bindings.

The baseline command has no custom format option on tmux 3.3. Deliberate newer-server formatting is available through tmux_command:raw/2. Performs I/O; missing tables, invalid key spellings and backend errors remain errors.

tmux command#

The tmux commands behind listing/2.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss listing/2.

Esc

Type to search.

Reference previewOpen reference