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-rs latest

Pane.set_hook

Set one hook to a tmux command.

Source and package
Qualified name
libtmux::pane::Pane::set_hook
Module
pane
Declared in
Pane
Package
libtmux
Source
crates/libtmux/src/pane/settings.rs
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby LuaTypeScriptGo Java C# C++ Swift Kotlin Scala OCaml F# Clojure
pub async fn set_hook( &self, name: &str, command: impl Into<OsString> ) -> Result<(), Error>

Description#

Hooks live in the same option tables, so a hook is an array option and Self::typed_option() reads it under an indexed name such as after-new-window[0].

Errors

Returns an error when tmux rejects the hook name or command.

Returns crate::Error::OptionScopeMismatch when tmux keeps the option in another of its tables.

Parameters

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.

Guides#

Pages that discuss set_hook.

In other ports#

Bind a command to a pane hook

Equivalents of Bind a command to a pane hook in other languages
Language Equivalent
Python libtmux.Pane.set_hook
Lua libtmux.Pane:set_hook
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript pane.Pane.setHook
Go tmux.Pane.SetHook
Java reached through Pane.hooks, whose Hooks carries the write
C# reached through Pane.Hooks, whose TmuxHooks carries the write
C++ no equivalent on Pane
Swift Server.setHook(_:to:at:in:)
OCaml Libtmux_unix.Client.set_hook
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

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

Esc

Type to search.

Reference previewOpen reference