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

Server.setHook

Bind a tmux command to a global hook.

Source and package
Qualified name
Server.setHook
Module
server
Declared in
Server
Package
libtmux
Source
packages/libtmux/src/server.ts
Other languages
PowerShell Julia Elixir Python Ruby LuaRust Go Java C# C++ Swift Kotlin Scala F#

Description#

A hook holds a list of commands. Without append this writes the whole list, so it replaces whatever the hook already ran.

Examples#

await server.setHook("session-created", "display-message 'hello'");
await server.setHook("session-created", "display-message 'and this'", { append: true });

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 global hook

Equivalents of Bind a command to a global hook in other languages
Language Equivalent
Python libtmux.Server.set_hook
Lua libtmux.Server:set_hook
Rust server.Server.set_hook
Go no equivalent on Server
Java reached through Server.hooks, whose Hooks carries the write
C# reached through Server.Hooks, whose TmuxHooks carries the write
C++ no equivalent on Server
Swift Server.setHook(_:to:at:in:)

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

Esc

Type to search.

Reference previewOpen reference