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 latest

Server.set_hook

Set hook for tmux target.

Source and package
Qualified name
libtmux.Server.set_hook
Module
libtmux
Declared in
Server
Package
libtmux
Source
src/libtmux/hooks.py
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby LuaTypeScriptRust Go Java C# C++ Swift Kotlin Scala OCaml F# Clojure
set_hook ( self, hook: str, value: int | str, unset: bool | None = None, run: bool | None = None, append: bool | None = None, g: bool | None = None, global_: bool | None = None, scope: OptionScope | _DefaultOptionScope | None = DEFAULT_OPTION_SCOPE, ) → Self

Inherited from libtmux.hooks.HooksMixin

Description#

Wraps $ tmux set-hook <hook> <value>.

tmux command#

The tmux commands behind set_hook.

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
Lua libtmux.Server:set_hook
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript server.Server.setHook
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:)
OCaml Libtmux_unix.Client.set_hook
Perl LibTmux::Server::set_hook Use global => true; 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