Python API

method libtmux latest

Server.show_hooks

Return a dict of hooks for the target.

Source and package

Qualified name: libtmux.Server.show_hooks
Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/hooks.py
Other languages: Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp RubyLuaTypeScriptRust Go JavaC#C++Swift Kotlin Scala OCamlfunction F# Clojure

show_hooks ( self, global_: bool | None = False, scope: OptionScope | _DefaultOptionScope | None = DEFAULT_OPTION_SCOPE, ) → HookDict method [source] ¶

Examples#

>>> session.set_hook('session-renamed[0]', 'display-message "test"')
Session($...)

>>> hooks = session.show_hooks()
>>> isinstance(hooks, dict)
True

>>> 'session-renamed[0]' in hooks
True

>>> session.unset_hook('session-renamed')
Session($...)

Parameters

global_ (bool | None) # – Pass -g flag for global hooks, default False.
scope (OptionScope | _DefaultOptionScope | None) # – Hook scope (Server/Session/Window/Pane), defaults to object's scope.

Returns

HookDict Dictionary mapping hook names to their values.

The tmux commands behind show_hooks.

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.

Read the server's global hooks

Equivalents of Read the server's global hooks in other languages
Language	Equivalent
Ruby	`LibTmux::Server#hooks`
Lua	`libtmux.Server:list_hooks`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`server.Server.showHooks`
Rust	`server.Server.hooks`
Go	no equivalent on `Server`
Java	`io.github.libtmux.Server.hooks`
C#	`LibTmux.Server.Hooks`
C++	`libtmux::Server::hooks`
Swift	`Server.hooks(_:)`
OCaml	`Libtmux_unix.Client.capture_hooks` Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy.
Perl	`LibTmux::Server::show_hooks` Use global => true; raw bytes preserve sparse hook indexes and tmux quoting.

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