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

Operations.set_hook

Set a hook to a nonempty command list. Without an index, replace the whole hook array, or fill the lowest free index when appending. An explicit @name custom hook stores command text as a user option; it requires complete replacement and has no array indexes. read_hook returns its Options.Text value; bulk hook capture includes built-ins. Commands may cause arbitrary tmux effects when triggered. Hooks that print output are outside the supported control transport contract.

Source and package
Qualified name
Libtmux.Operations.set_hook
Module
Libtmux
Declared in
Operations
Package
libtmux
Source
lib/libtmux.mli
val set_hook : ?index:int -> ?append:bool -> Options.scope -> name:string -> Hook.command list -> unit Command.t

Public owner: Libtmux

Parameters
Esc

Type to search.

Reference previewOpen reference