LibTmux.Remove-TmuxWindowLink
LibTmux\Remove-TmuxWindowLink Remove one session placement of a window.
Source and package
- Declared in
- LibTmux
- Package
- LibTmux
- Source
- src/LibTmux.PowerShell/RemoveTmuxWindowLinkCommand.cs
- Remove-TmuxWindowLink [-Window] <Lib
Tmux > [-Kill.Window If ] [-WhatLast If ] [-Confirm] [<CommonParameters >] -
Description#
Remove only the session-relative link captured by the native
Windowhandle. Other links to the same physical window remain. Without KillIfLast, tmux refuses to remove the final link. With it, removing the final link also destroys the window and its panes. Confirmation is requested by default.WhatIfperforms no tmux I/O.Notes
This command differs from
Remove-TmuxWindow, which kills the physical window and all its links. The core verifies source placement and server generation in tmux's native queue before unlinking. Stale or missing placements write a per-inputTmux.WindowUnlinkFailederror.ErrorActionContinue permits later inputs;ErrorActionStop stops at the first failure.Command details#
- Command type
cmdlet- Confirmation
- Supports
-WhatIfand-Confirm; confirm impact: High. - Positional binding
- Enabled.
- Pipeline inputs
-
LibTmux.Window:Onenative window placement per pipeline input. - Outputs
System.Void
Examples#
Example 1 Remove the selected
$windowplacement from its session while retaining the physical window through another link. View sourceTerminal window $window | LibTmux\Remove-TmuxWindowLink -Confirm:$false- Parameters
-
-
The native placement to remove. It must identify the session and index that still contain the captured window.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
-
-KillIfLast(System.Management ) #.Automation .Switch Parameter Allow tmux to destroy the physical window and its panes when this was its last link. Without this switch, the last-link operation fails.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Switch
- Yes
-
-WhatIf(System.Management ) #.Automation .Switch Parameter Runs the command in a mode that only reports what would happen without performing the actions.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Switch
- Yes
- Aliases
wi
-
-Confirm(System.Management ) #.Automation .Switch Parameter Prompts you for confirmation before running the cmdlet.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Switch
- Yes
- Aliases
cf
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
-
None: No success objects are emitted.