LibTmux.Get-TmuxClientAttachment
Resolve the session, window and pane a client currently views.
Source and package
- Qualified name
-
LibTmux\ Get-Tmux Client Attachment - Declared in
LibTmux- Package
- LibTmux
- Source
- src/LibTmux.PowerShell/GetTmuxClientAttachmentCommand.cs
- Get-TmuxClientAttachment [-Client] <Lib
Tmux > [<Common.Client Parameters >] -
Description#
Resolve current attachment data through the native core. Return a
ClientAttachmentcontaining nativeSession,WindowandPanehandles. A detached client or missing session produces no output.WindoworPanecan be null when unavailable. This explicit live read leaves the originalClientunchanged.Notes
The observation uses several tmux reads and is not a transaction.
Serveror transport failures write an error rather than becoming an empty result.Command details#
- Command type
cmdlet- Positional binding
- Enabled.
- Pipeline inputs
LibTmux.Client: Native pipeline owner.- Outputs
LibTmux.ClientAttachment
Examples#
Example 1 Resolve the current attachment of a previously selected native
$client. View sourceTerminal window $client | LibTmux\Get-TmuxClientAttachment- Parameters
-
-
The native client whose current state is read.
- 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.ClientAttachment: Native observed result.
tmux command#
The tmux commands behind Get-TmuxClientAttachment.
tmux C API#
The C declarations in tmux that implement these commands.