tmux_option:describe/2
Return source metadata for a canonical built-in name and a parsed daemon version, without I/O. Unknown names, unavailable names, tracking builds and uncatalogued versions have distinct errors. The catalogue describes scopes and parser types; it does not qualify runtime behavior or authorize hook execution.
Source and package
- Qualified name
-
tmux_option: describe/2 - Declared in
tmux_option- Package
- libtmux_erlang
- Source
- apps/libtmux_erlang/src/tmux_option.erl
- describe(Version, Name) -spec describe(tmux
_version: (), binary()) -> {ok, metadata()} | {error, map()}.t -
Examples#
1> {ok, V} = tmux_version:parse(<<"tmux 3.3a">>), ok.ok2> {ok, M} = tmux_option:describe(V, <<"exit-empty">>), ok.ok3> maps:get(scopes, M).[server]
Guides#
Pages that discuss describe/2.