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_eio .Client. capture _hooks - Module
- Libtmux_eio
- Declared in
Client- Package
- libtmux-eio
- Source
- eio/libtmux_eio.mli
- Other languages
- Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGoJavaC#C++Swift Kotlin Scala F# Clojure
- val capture_hooks : t -> Libtmux
.Options -> (Libtmux.scope .Options , Libtmux.t .Error ) result.t -
Public owner:
Libtmux_eio
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
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Ruby | Lib |
| Lua | libtmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | server |
| Rust | server |
| Go | no equivalent on Server |
| Java | io |
| C# | Lib |
| C++ | libtmux:: |
| Swift | Server |
| Perl | Lib 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
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Ruby | Lib |
| Lua | libtmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | session |
| Rust | session |
| Go | tmux |
| Java | io |
| C# | Lib |
| C++ | libtmux:: |
| Swift | Server |
| Perl | Lib 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
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Ruby | Lib |
| Lua | libtmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | window |
| Rust | no whole-table read; Window.hook reads one |
| Go | tmux |
| Java | io |
| C# | Lib |
| C++ | no equivalent on Window |
| Swift | Server |
| 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
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Ruby | Lib |
| Lua | libtmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | pane |
| Rust | no whole-table read; Pane.hook reads one |
| Go | tmux |
| Java | io |
| C# | Lib |
| C++ | no equivalent on Pane |
| Swift | Server |
| 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#.