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:show-hooks-text

Inspect native hooks; return owned UTF-8 printer text and a COMMAND-OUTCOME. SCOPE/TARGET follow SET-HOOK; :SERVER is unavailable because show-hooks has no server-table flag. NAME is a literal native reference; omission lists hooks. Tmux can infer a built-in's table from NAME. A named ordinary @ option can also be printed; that success does not prove event registration.

Source and package
Qualified name
libtmux:show-hooks-text
Declared in
libtmux
Package
libtmux
Source
src/configuration-operations.lisp
(show-hooks-text client &key scope target name format monitors cancel-token timeout output-limit)

Public owner: libtmux

Description#

FORMAT is explicit tmux format source with no implicit time expansion. MONITORS selects native monitor presentation (-B). Both require live tmux 3.8. #() in FORMAT can start command-client jobs with incomplete results and cleanup on disconnect. Native escaping, whitespace and ordinary hook output remain printer text, not a decoded or replayable configuration. No -R is invoked. Blocks under shared preflight/dispatch limits, starts no daemon and never retries. Missing names and decoding/resource failures retain outcome evidence.

See also: libtmux:error-outcome, libtmux:set-hook, libtmux:show-options-text, libtmux:unset-hook.

Guides#

Pages that discuss show-hooks-text.

Esc

Type to search.

Reference previewOpen reference