libtmux:show-options-text
Inspect an option table; return owned UTF-8 printer text and a COMMAND-OUTCOME. Required SCOPE and captured TARGET follow SET-OPTION. They select native flags; tmux can infer a built-in's table from NAME instead. NAME is a literal option reference with native abbreviation/array syntax; omission lists the table. INCLUDE-INHERITED uses -A, which does not promise inherited user @ options in a whole-table listing. INCLUDE-HOOKS uses -H and VALUE-ONLY uses -v.
Source and package
- Qualified name
-
libtmux:show-options-text - Declared in
libtmux- Package
- libtmux
- Source
- src/configuration-operations.lisp
-
Public owner:
libtmuxDescription#
FORMAT is explicit tmux format source, requires live tmux 3.8, and has no implicit time expansion. #() can start asynchronous command-client jobs; their results can be incomplete and disconnect cleans them up. Omission uses native printer syntax. Escaping, whitespace and ordinary hook output remain text; this does not decode values or prove presence, provenance or completeness. Blocks under shared preflight/dispatch limits, starts no daemon and never retries. Missing names remain errors with retained outcomes. Invalid UTF-8 signals DECODING-ERROR with the client and outcome.
See also:
libtmux:error-outcome,libtmux:set-option,libtmux:show-environment-text,libtmux:show-hooks-text.- Parameters
-
Guides#
Pages that discuss show-options-text.