PowerShell API

cmdlet libtmux-powershell latest

LibTmux.Set-TmuxHook

Set a hook entry and optionally return its grouped readback.

Source and package

Qualified name: LibTmux\Set-TmuxHook
Declared in: LibTmux
Package: LibTmux
Source: src/LibTmux.PowerShell/SetTmuxHookCommand.cs

Pane: Set-TmuxHook [-Pane] <LibTmux.Pane> -Name <System.String> [-Scope <System.Nullable[LibTmux.OptionScope]>] [-Global] -Command <System.String> [-Append] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]Server (default): Set-TmuxHook [-Server] <LibTmux.Server> -Name <System.String> [-Scope <System.Nullable[LibTmux.OptionScope]>] [-Global] -Command <System.String> [-Append] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]Session: Set-TmuxHook [-Session] <LibTmux.Session> -Name <System.String> [-Scope <System.Nullable[LibTmux.OptionScope]>] [-Global] -Command <System.String> [-Append] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]Window: Set-TmuxHook [-Window] <LibTmux.Window> -Name <System.String> [-Scope <System.Nullable[LibTmux.OptionScope]>] [-Global] -Command <System.String> [-Append] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] cmdlet LibTmux [source] ¶

Description#

Pass a tmux command string to one hook or indexed entry. tmux normalizes the stored command text; native readback keeps that syntax unchanged so it can be supplied again. An unindexed set replaces existing entries. Append keeps existing entries and lets tmux select a free index; use explicit indices when order matters. PassThru emits the whole grouped hook readback. WhatIf performs no tmux I/O.

Notes

Server hooks are the global hook table; tmux has no separate server hook table. Choose a hook supported by the selected scope. Scope and Global pass through to tmux without remapping the owner. Empty pipelines do no I/O. Errors retain the native owner and core exception; Continue permits later owners and Stop terminates. Cancellation cannot undo commands already dispatched. Multiple mutations are sequential, not an atomic replacement.

Command details#

Command type: cmdlet
Default parameter set: Server
Confirmation: Supports -WhatIf and -Confirm; confirm impact: Medium.
Positional binding: Enabled.
Pipeline inputs: LibTmux.Server: A native server owner.; LibTmux.Session: A native session owner.; LibTmux.Window: A native window owner.; LibTmux.Pane: A native pane owner.
Outputs: LibTmux.TmuxHook

Examples#

Example 1 Store one indexed command on a native $session and inspect the grouped result. View source

$command = 'display-message "build finished"'
$session |
    LibTmux\Set-TmuxHook -Name 'alert-bell[7]' -Command $command -PassThru

Parameters

-Pane (LibTmux.Pane) for Pane #

The native pane whose table is used.

Required
Yes
Position
0
Pipeline input
By value
Validation
ValidateNotNull()
-Name (System.String) #

The tmux hook name, optionally indexed for a specific entry. tmux expands formats in names.

Required
Yes
Position
Named
Pipeline input
No
Validation
ValidateNotNullOrEmpty()
Validation
ValidatePattern("\\A[^\\x00]*[^\\s\\x00][^\\x00]*\\z")
-Scope (System.Nullable[LibTmux.OptionScope]) #

Override the owner scope with Server, Session, Window or Pane. Omission uses the native owner scope.

Required
No
Position
Named
Pipeline input
No
Validation
ValidateSet(["Server","Session","Window","Pane"])
-Global (System.Management.Automation.SwitchParameter) #

Pass tmux its global flag. Pane-local hooks still use the pane table. For global session defaults from a Server, specify Scope Session and Global.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
-Command (System.String) #

The tmux command text to run when the hook fires. This is tmux command syntax, not a PowerShell script block. NUL is rejected.

Required
Yes
Position
Named
Pipeline input
No
Validation
ValidateNotNull()
Validation
ValidatePattern("^[^\\x00]*$")
-Append (System.Management.Automation.SwitchParameter) #

Keep existing entries and let tmux choose a free index. This need not be after the highest existing index.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
-PassThru (System.Management.Automation.SwitchParameter) #

Emit the native value read back after the mutation. Without this switch, emit no success output. Readback still occurs.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
-WhatIf (System.Management.Automation.SwitchParameter) #

Show the selected owner, scope and operation without contacting tmux.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
Aliases
wi
-Confirm (System.Management.Automation.SwitchParameter) #

Ask for confirmation before changing the selected table.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
Aliases
cf
-Server (LibTmux.Server) for Server #

The native server whose table is used.

Required
Yes
Position
0
Pipeline input
By value
Validation
ValidateNotNull()
-Session (LibTmux.Session) for Session #

The native session whose table is used.

Required
Yes
Position
0
Pipeline input
By value
Validation
ValidateNotNull()
-Window (LibTmux.Window) for Window #

The native window whose table is used.

Required
Yes
Position
0
Pipeline input
By value
Validation
ValidateNotNull()

Common parameters 12

PowerShell supplies these parameters. See common parameter behavior for their effects.

-Verbose (System.Management.Automation.SwitchParameter) #

Display verbose messages produced by this command.

Aliases: vb Microsoft Learn reference
-Debug (System.Management.Automation.SwitchParameter) #

Display debug messages produced by this command.

Aliases: db Microsoft Learn reference
-ErrorAction (System.Management.Automation.ActionPreference) #

Choose how this command responds to non-terminating errors.

Aliases: ea Microsoft Learn reference
-WarningAction (System.Management.Automation.ActionPreference) #

Choose how this command responds to warning messages.

Aliases: wa Microsoft Learn reference
-InformationAction (System.Management.Automation.ActionPreference) #

Choose how this command handles information messages.

Aliases: infa Microsoft Learn reference
-ProgressAction (System.Management.Automation.ActionPreference) #

Choose how this command handles progress updates.

Aliases: proga Microsoft Learn reference
-ErrorVariable (System.String) #

Store the command's error records in the named variable.

Aliases: ev Microsoft Learn reference
-WarningVariable (System.String) #

Store the command's warning records in the named variable.

Aliases: wv Microsoft Learn reference
-InformationVariable (System.String) #

Store the command's information records in the named variable.

Aliases: iv Microsoft Learn reference
-OutVariable (System.String) #

Save output in the named variable while passing it down the pipeline.

Aliases: ov Microsoft Learn reference
-OutBuffer (System.Int32) #

Buffer output before passing it to the next pipeline command.

Aliases: ob Microsoft Learn reference
-PipelineVariable (System.String) #

Make the most recent output object available through a named variable within the pipeline.

Aliases: pv Microsoft Learn reference

Returns

LibTmux.TmuxHook: The complete native grouped hook, only with PassThru.

tmux command#

The tmux commands behind Set-TmuxHook.

set-hook

tmux C API#

The C declarations in tmux that implement these commands.

cmd_set_hook_entry cmd_set_option_exec

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

LibTmux.Set-TmuxHook

Description#

Command details#

Examples#

tmux command#

tmux C API#