Python API

method libtmux stable

Pane.show_hooks

Return a dict of hooks for the target.

Source and package

Qualified name: libtmux.Pane.show_hooks
Module: libtmux
Declared in: Pane
Package: libtmux
Source: src/libtmux/hooks.py
Other languages: PowerShell Julia RubyLuaTypeScript Rust GoJavaC# C++ Swift Kotlin Scala F#

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.

tmux catalog Hooks

In other ports Read a pane's hooks

PowerShell
No source-verified PowerShell equivalent is recorded for this operation.
Julia
No source-verified Julia equivalent is recorded for this operation.
Ruby
LibTmux::Pane#hooks
Lua
libtmux.Pane:list_hooks
TypeScript
pane.Pane.showHooks
Rust
no whole-table read; Pane.hook reads one
Go
tmux.Pane.Hooks
Java
io.github.libtmux.Pane.hooks
C#
LibTmux.Pane.Hooks
C++
no equivalent on Pane
Swift
Server.hooks(_:)
Kotlin
No source-verified Kotlin equivalent is recorded for this operation.
Scala
No source-verified Scala equivalent is recorded for this operation.
F#
No source-verified F# equivalent is recorded for this operation.