Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased libtmux has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-lisp latest

libtmux:list-commands

Inspect built-in tmux commands; return owned UTF-8 printer text and an outcome. Omit COMMAND to list all built-ins. COMMAND is an exact name or built-in alias through tmux 3.5a; unknown selectors produce no rows. From 3.6, unique prefixes are accepted and unknown/ambiguous selectors fail. Configured command-alias entries are not listed or expanded by this selector.

Source and package
Qualified name
libtmux:list-commands
Declared in
libtmux
Package
libtmux
Source
src/key-bindings.lisp
(list-commands client &key command format cancel-token timeout output-limit)

Public owner: libtmux

Description#

FORMAT is explicit tmux format source, without time expansion. #() can start asynchronous jobs owned by this command client; results may be incomplete and disconnect cleans up those jobs. Omission uses tmux's human-readable format. Preserve native escaping, whitespace and after-hook output; this is not a decoded registry. Blocks under shared preflight/dispatch limits, never retries and starts no daemon. Failures retain their outcome; invalid UTF-8 signals DECODING-ERROR.

See also: libtmux:display-message, libtmux:error-outcome, libtmux:list-keys, libtmux:outcome-stdout.

Guides#

Pages that discuss list-commands.

Esc

Type to search.

Reference previewOpen reference