LibTmux.Get-TmuxQueryField
Discover query fields, operators and native bindings.
Source and package
- Qualified name
-
LibTmux\ Get-Tmux Query Field - Declared in
LibTmux- Package
- LibTmux
- Source
- src/LibTmux.PowerShell/GetTmuxQueryFieldCommand.cs
- Get-TmuxQueryField [-Target] <Lib
Tmux > [<Common.Query .Query Target Parameters >] -
Description#
Return immutable descriptors from the shared
LibTmuxfield catalog. Each descriptor identifies the wire field, supported operations, capture depth and native bindings. Discovery is local and requires no server or tmux executable.Clientdescriptors are available for inspection; the PowerShell structured selectors acceptSession,WindowandPanetargets.Operatorsuse the native wire vocabulary: greaterThanOrEqual corresponds to the PowerShell criteria key Ge. See the criteria keys for the full mapping.Notes
Catalog discovery does not refresh captured objects.
Command details#
- Command type
cmdlet- Positional binding
- Enabled.
- Pipeline inputs
None: No pipeline input.- Outputs
LibTmux.Query.QueryFieldDescriptor
Examples#
Example 1 Inspect the pane-width field and its supported operations. View source
Terminal window LibTmux\Get-TmuxQueryField -Target Pane | Where-Object WireName -EQ 'pane_width'- Parameters
-
-
-Target(LibTmux ) #.Query .Query Target The entity whose catalog fields are returned.
- Required
- Yes
- Position
- 0
- Pipeline input
- No
- Validation
ValidateSet(["Session","Window","Pane","Client"])
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.Query.QueryFieldDescriptor: Native descriptors in wire-name order.
Guides#
Pages that discuss Get-TmuxQueryField.
- Concepts