Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-ts latest

Window.setHook

Bind a tmux command to a window-scoped hook.

Source and package
Qualified name
Window.setHook
Module
window
Declared in
Window
Package
libtmux
Source
packages/libtmux/src/window.ts
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby LuaRustGo Java C# C++ Swift Kotlin Scala OCaml F# Clojure

Examples#

await window.setHook("window-renamed", "display-message 'renamed'");

tmux command#

The tmux commands behind setHook.

tmux C API#

The C declarations in tmux that implement these commands.

tmux hooks#

Events that run tmux commands, with the scope each hook belongs to and where tmux fires it.

In other ports#

Bind a command to a window hook

Equivalents of Bind a command to a window hook in other languages
Language Equivalent
Python libtmux.Window.set_hook
Lua libtmux.Window:set_hook
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Rust window.Window.set_hook
Go tmux.Window.SetHook
Java reached through Window.hooks, whose Hooks carries the write
C# reached through Window.Hooks, whose TmuxHooks carries the write
C++ no equivalent on Window
Swift Server.setHook(_:to:at:in:)
OCaml Libtmux_unix.Client.set_hook
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in Ruby, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference