Core LibraryalphaAPI 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-cxx latest

Session.hooks

Source and package
Qualified name
libtmux::Session::hooks
Namespace
libtmux
Declared in
Session
Package
libtmux-cxx
Source
include/libtmux/entities.hpp
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGoJavaC#Swift Kotlin Scala OCamlfunction 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<std::vector<OptionEntry>, CommandFailure> hooks() const;

tmux command#

The tmux commands behind hooks.

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.

Guides#

Pages that discuss hooks.

In other ports#

Read a session's hooks

Equivalents of Read a session's hooks in other languages
Language Equivalent
Python libtmux.Session.show_hooks
Ruby LibTmux::Session#hooks
Lua libtmux.Session:list_hooks
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript session.Session.showHooks
Rust session.Session.hooks
Go tmux.Session.Hooks
Java io.github.libtmux.Session.hooks
C# LibTmux.Session.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 an explicit session target ID; 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#.

Esc

Type to search.

Reference previewOpen reference