LibTmux.Get-TmuxOption
Read a native tmux option table or named option.
Source and package
- Qualified name
-
LibTmux\ Get-Tmux Option - Declared in
LibTmux- Package
- LibTmux
- Source
- src/LibTmux.PowerShell/GetTmuxOptionCommand.cs
- Pane: Get-TmuxOption [-Pane] <Lib
Tmux > [-Name <System.Pane .String >] [-Scope <System.Nullable [LibTmux ]>] [-Global] [-Include.Option Scope Inherited ] [-IncludeHooks ] [-Quiet] [<CommonParameters >]Server (default): Get-TmuxOption [-Server] <LibTmux > [-Name <System.Server .String >] [-Scope <System.Nullable [LibTmux ]>] [-Global] [-Include.Option Scope Inherited ] [-IncludeHooks ] [-Quiet] [<CommonParameters >]Session: Get-TmuxOption [-Session] <LibTmux > [-Name <System.Session .String >] [-Scope <System.Nullable [LibTmux ]>] [-Global] [-Include.Option Scope Inherited ] [-IncludeHooks ] [-Quiet] [<CommonParameters >]Window: Get-TmuxOption [-Window] <LibTmux > [-Name <System.Window .String >] [-Scope <System.Nullable [LibTmux ]>] [-Global] [-Include.Option Scope Inherited ] [-IncludeHooks ] [-Quiet] [<CommonParameters >] -
Description#
The native owner selects its option table. Scope overrides that choice, and Global requests global defaults; pane-local options still use the pane table. A named read emits each native
TmuxOptionrow, preserving sparse array indices, inherited markers andTmuxOptionValuefields. Omit Name to list the table. IncludeInherited requests inherited values explicitly.Global values and local overrides remain separate. Names follow tmux syntax, including array indices and tmux format expansion. Use
Where-Objecton returned rows for local PowerShell filtering.Notes
Reads contact tmux explicitly. Empty owner pipelines perform no I/O. Errors retain the original core exception and native owner as their target.
ErrorActionContinue permits later owners; Stop terminates the pipeline. Cancellation stops the operation but cannot undo a dispatched mutation. Set readback is an observation, not a transaction with other clients.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.TmuxOption
Examples#
Example 1 Read the effective key mode from a previously selected native
$session. View sourceTerminal window $session | LibTmux\Get-TmuxOption -Name 'status-keys' -IncludeInherited- Parameters
-
-
-Pane(LibTmux ) for.Pane Pane#The native pane whose table is used.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
-
The tmux option name, optionally indexed. tmux expands formats in option names; this is not a literal wildcard selector. Whitespace-only names and NUL are rejected.
- 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 Pass tmux its global flag.
Pane-local options still use the pane table. For global session defaults from aServer, specify ScopeSessionand Global.- Required
- No
- Position
- Named
- Pipeline input
- No
- Switch
- Yes
-
-IncludeInherited(System.Management ) #.Automation .Switch Parameter Include values inherited from a parent scope.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Switch
- Yes
-
-IncludeHooks(System.Management ) #.Automation .Switch Parameter Include hooks alongside options.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Switch
- Yes
-
-Quiet(System.Management ) #.Automation .Switch Parameter Pass tmux its quiet flag. Missing reads emit no objects; suppressed writes may return an absent value with PassThru.
- 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.TmuxOption:Oneobject per option or array entry, in tmux order.
tmux command#
The tmux commands behind Get-TmuxOption.
tmux C API#
The C declarations in tmux that implement these commands.