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-ocaml latest

Client.run_hook

Run the effective hook in an explicit session, window or pane context. A successful result follows completion of its synchronous command queue. Background work started by a hook has its own lifetime. A later hook failure returns an uncertain outcome; preceding effects remain. Named @ hooks return Unsupported because tmux can hide their parse failures in the server log. Configuration and inspection remain available.

Source and package
Qualified name
Libtmux_eio.Client.run_hook
Module
Libtmux_eio
Declared in
Client
Package
libtmux-eio
Source
eio/libtmux_eio.mli
val run_hook : t -> Libtmux.Options.scope -> string -> (unit, Libtmux.Error.t) result

Public owner: Libtmux_eio

Parameters

tmux command#

The tmux commands behind run_hook.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference