C++ API

method libtmux-cxx latest

Session.set_hook

Source and package

Qualified name: libtmux::Session::set_hook
Namespace: libtmux
Declared in: Session
Package: libtmux-cxx
Source: include/libtmux/entities.hpp
Other languages: Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby LuaTypeScriptRustGo Java C# Swift Kotlin Scala OCaml F# Clojure

[[C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.Language documentation]] expected<void, CommandFailure> set_hook(std::string_view name, std::string_view command) const; method readonly [source] ¶

Parameters

tmux command#

The tmux commands behind set_hook.

The C declarations in tmux that implement these commands.

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

Pages that discuss set_hook.

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.
TypeScript	`session.Session.setHook`
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
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#.