# libtmux:show-options-text

- **Package:** libtmux
- **Language:** Common Lisp
- **Kind:** function
- **Source:** https://github.com/libtmux/libtmux-lisp/blob/c2e5fc4ed3befda21f45dfa5d5868c38fd138311/src/configuration-operations.lisp#L263
- **Public owner:** libtmux
- **Page:** https://libtmux.org/en/lisp/latest/reference/libtmux-show-options-text/

```
(show-options-text client &key scope target name include-inherited include-hooks value-only format cancel-token timeout output-limit)
```

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.

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

- `client`
- `scope?`
- `target?`
- `name?`
- `include-inherited?`
- `include-hooks?`
- `value-only?`
- `format?`
- `cancel-token?`
- `timeout?`
- `output-limit?`

## Guides

Pages that discuss `show-options-text`.

- [Explicit operations](/en/lisp/latest/guides/operations/)