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:set-hook

Install tmux COMMAND-SOURCE for one registered hook and return an outcome. SCOPE/TARGET follow SET-OPTION. COMMAND-SOURCE is explicit tmux command language, not Lisp code; this function neither reads nor executes it locally. KEY selects one hook-array entry. APPEND applies to an unkeyed hook assignment; tmux does not append command source within a keyed hook entry. The ordinary install path never uses set-hook -R, but tmux may still run a registered native after-hook such as after-set-hook as a consequence of this set-hook command. Dynamic @ event sources require a live catalog that supports them. SET-OPTION rejects registered hooks; use UNSET-HOOK to remove this state. Never retries.

Source and package
Qualified name
libtmux:set-hook
Declared in
libtmux
Package
libtmux
Source
src/configuration-operations.lisp
(set-hook client name command-source &key scope target (key nil key-p) append cancel-token timeout output-limit)

Public owner: libtmux

Description#

See also: libtmux:set-option, libtmux:unset-hook.

tmux command#

The tmux commands behind set-hook.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss set-hook.

Esc

Type to search.

Reference previewOpen reference