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

Session.setHook

Bind a tmux command to a hook on this session.

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

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 session.setHook("window-linked", "display-message 'linked'");
await session.setHook("window-linked", "display-message 'twice'", { 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 session hook

Equivalents of Bind a command to a session hook in other languages
Language Equivalent
Python libtmux.Session.set_hook
Lua libtmux.Session:set_hook
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Rust session.Session.set_hook
Go tmux.Session.SetHook
Java reached through Session.hooks, whose Hooks carries the write
C# reached through Session.Hooks, whose TmuxHooks carries the write
C++ libtmux::Session::set_hook
Swift Server.setHook(_:to:at:in:)
OCaml Libtmux_unix.Client.set_hook
Perl LibTmux::Server::set_hook Use an explicit session target ID; command is an explicit native tmux command string.

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

Esc

Type to search.

Reference previewOpen reference