LibTmux.Get-TmuxHook
LibTmux\Get-TmuxHook Read native grouped hooks from an owner table.
Source and package
- Declared in
- LibTmux
- Package
- LibTmux
- Source
- src/LibTmux.PowerShell/GetTmuxHookCommand.cs
- Pane: Get-TmuxHook [-Pane] <Lib
Tmux > [-Name <System.Pane .String >] [-Scope <System.Nullable [LibTmux ]>] [-Global] [<Common.Option Scope Parameters >] Server (default): Get-TmuxHook [-Server] <LibTmux > [-Name <System.Server .String >] [-Scope <System.Nullable [LibTmux ]>] [-Global] [<Common.Option Scope Parameters >] Session: Get-TmuxHook [-Session] <LibTmux > [-Name <System.Session .String >] [-Scope <System.Nullable [LibTmux ]>] [-Global] [<Common.Option Scope Parameters >] Window: Get-TmuxHook [-Window] <LibTmux > [-Name <System.Window .String >] [-Scope <System.Nullable [LibTmux ]>] [-Global] [<Common.Option Scope Parameters >] -
Description#
Emit native
TmuxHookobjects with a base Name and indexed Values entries. Get by base name only; indexed names are rejected with a clear error rather than silently returning no matches. Missing local hooks emit no objects and are not filled from the global table. Omit Name to list the selected scope.Notes
Serverhooks 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 - 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 Inspect a previously configured hook on a native
$session. View sourceTerminal window $session | LibTmux\Get-TmuxHook -Name 'alert-bell'- Parameters
-
-
-Pane(LibTmux ) (for.Pane Pane) #The native pane whose table is used.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
-
The base hook name. Indexed reads are rejected before I/O; inspect Values for indexed entries. Omit Name to list the selected table.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Validation
ValidateNotNullOrEmpty()- Validation
ValidatePattern("\\A[^\\x00]*[^\\s\\x00][^\\x00]*\\z")
-
-Scope(System.Nullable [LibTmux ]) #.Option Scope Override the owner scope with
Server,Session,WindoworPane. Omission uses the native owner scope.- Required
- No
- Position
- Named
- Pipeline input
- No
- Validation
ValidateSet(["Server","Session","Window","Pane"])
-
-Global(System.Management ) #.Automation .Switch Parameter Use the global table for the selected scope. For global session defaults from a
Server, specify ScopeSessionand Global.- Required
- No
- Position
- Named
- Pipeline input
- No
- Switch
- Yes
-
-Server(LibTmux ) (for.Server Server) #The native server whose table is used.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
-
-Session(LibTmux ) (for.Session Session) #The native session whose table is used.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
-
-Window(LibTmux ) (for.Window 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 .Switch Parameter Display verbose messages produced by this command.
Aliases:vbMicrosoft Learn reference -
-Debug(System.Management ) #.Automation .Switch Parameter Display debug messages produced by this command.
Aliases:dbMicrosoft Learn reference -
-ErrorAction(System.Management ) #.Automation .Action Preference Choose how this command responds to non-terminating errors.
Aliases:eaMicrosoft Learn reference -
-WarningAction(System.Management ) #.Automation .Action Preference Choose how this command responds to warning messages.
Aliases:waMicrosoft Learn reference -
-InformationAction(System.Management ) #.Automation .Action Preference Choose how this command handles information messages.
Aliases:infaMicrosoft Learn reference -
-ProgressAction(System.Management ) #.Automation .Action Preference Choose how this command handles progress updates.
Aliases:progaMicrosoft Learn reference -
-ErrorVariable(System.String ) #Store the command's error records in the named variable.
Aliases:evMicrosoft Learn reference -
-WarningVariable(System.String ) #Store the command's warning records in the named variable.
Aliases:wvMicrosoft Learn reference -
-InformationVariable(System.String ) #Store the command's information records in the named variable.
Aliases:ivMicrosoft Learn reference -
-OutVariable(System.String ) #Save output in the named variable while passing it down the pipeline.
Aliases:ovMicrosoft Learn reference -
Buffer output before passing it to the next pipeline command.
Aliases:obMicrosoft Learn reference -
-PipelineVariable(System.String ) #Make the most recent output object available through a named variable within the pipeline.
Aliases:pvMicrosoft Learn reference
-
- Returns
-
LibTmux.TmuxHook:Onenative grouped hook per result, with indexedTmuxHookEntryvalues.