Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased libtmux has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-ocaml latest

Client.capture_hooks

Capture locally configured built-in hooks. Command values are tmux's printed representation, retained as data.

Source and package
Qualified name
Libtmux_unix.Client.capture_hooks
Module
Libtmux_unix
Declared in
Client
Package
libtmux-unix
Source
unix/libtmux_unix.mli
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGoJavaC#C++Swift Kotlin Scala F# Clojure

Public owner: Libtmux_unix

tmux command#

The tmux commands behind capture_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.

In other ports#

Read the server's global hooks

Equivalents of Read the server's global hooks in other languages
Language Equivalent
Python libtmux.Server.show_hooks
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(_:)
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#.

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
C++ libtmux::Session::hooks
Swift Server.hooks(_:)
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#.

Read a window's hooks

Equivalents of Read a window's hooks in other languages
Language Equivalent
Python libtmux.Window.show_hooks
Ruby LibTmux::Window#hooks
Lua libtmux.Window:list_hooks
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript window.Window.showHooks
Rust no whole-table read; Window.hook reads one
Go tmux.Window.Hooks
Java io.github.libtmux.Window.hooks
C# LibTmux.Window.Hooks
C++ no equivalent on Window
Swift Server.hooks(_:)
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

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

Read a pane's hooks

Equivalents of Read a pane's hooks in other languages
Language Equivalent
Python libtmux.Pane.show_hooks
Ruby LibTmux::Pane#hooks
Lua libtmux.Pane:list_hooks
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
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(_:)
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

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

Esc

Type to search.

Reference previewOpen reference