LibTmux.Set-TmuxPaneSize
Resize a pane or toggle its zoom.
Source and package
- Qualified name
-
LibTmux\ Set-Tmux Pane Size - Declared in
LibTmux- Package
- LibTmux
- Source
- src/LibTmux.PowerShell/SetTmuxPaneSizeCommand.cs
- Direction: Set-TmuxPaneSize [-Pane] <Lib
Tmux > -Direction <Lib.Pane Tmux > -Adjustment <System.Resize Direction .Int32 > [-PassThru ] [-WhatIf ] [-Confirm] [<CommonParameters >]Size (default): Set-TmuxPaneSize [-Pane] <LibTmux > [-Width <System.Pane .String >] [-Height <System.String >] [-PassThru ] [-WhatIf ] [-Confirm] [<CommonParameters >]Zoom: Set-TmuxPaneSize [-Pane] <LibTmux > -Zoom [-Pass.Pane Thru ] [-WhatIf ] [-Confirm] [<CommonParameters >] -
Description#
Specify at least one positive cell or percentage dimension, an edge Direction with positive Adjustment, or Zoom. These forms cannot be combined. Zoom toggles the current state; repeating it turns zoom off. tmux clamps sizes that do not fit. PassThru returns the observed replacement
Pane, which may differ from the requested dimensions.Notes
A disappeared target or stale generation writes a per-target error. Use
-ErrorActionStop to terminate. Cancellation cannot undo an already dispatched change.Command details#
- Command type
cmdlet- Default parameter set
- Size
- Confirmation
- Supports
-WhatIfand-Confirm; confirm impact: Medium. - Positional binding
- Enabled.
- Pipeline inputs
LibTmux.Pane: Native pipeline owner.- Outputs
LibTmux.Pane
Examples#
Example 1 Give a previously selected native
$pane40 columns in a window with a horizontal split. View sourceTerminal window $pane | LibTmux\Set-TmuxPaneSize -Width 40 -PassThru- Parameters
-
-
The native pane to change.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
-
-Direction(LibTmux ) for.Resize Direction Direction#Move the Up, Down, Left or Right edge.
- Required
- Yes
- Position
- Named
- Pipeline input
- No
- Validation
ValidateSet(["Up","Down","Left","Right"])
-
-Adjustment(System.Int32 ) forDirection#Positive number of cells to move the selected edge.
- Required
- Yes
- Position
- Named
- Pipeline input
- No
- Validation
ValidateRange(1, 2147483647)
-
-PassThru(System.Management ) #.Automation .Switch Parameter Emit the native replacement handle carrying observed state.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Switch
- Yes
-
-WhatIf(System.Management ) #.Automation .Switch Parameter Preview the change without contacting tmux.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Switch
- Yes
- Aliases
wi
-
-Confirm(System.Management ) #.Automation .Switch Parameter Ask for confirmation before changing tmux.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Switch
- Yes
- Aliases
cf
-
-Width(System.String ) forSize#Positive width in cells or as a percentage such as 50%. At least one of Width or Height is required in the Size parameter set.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Validation
ValidateNotNullOrEmpty()- Validation
ValidatePattern("\\A0*[1-9][0-9]*%?\\z")
-
-Height(System.String ) forSize#Positive height in cells or as a percentage.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Validation
ValidateNotNullOrEmpty()- Validation
ValidatePattern("\\A0*[1-9][0-9]*%?\\z")
-
-Zoom(System.Management ) for.Automation .Switch Parameter Zoom#Togglepane zoom; this does not mean set zoom to true.- Required
- Yes
- Position
- Named
- Pipeline input
- No
- Switch
- Yes
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.Pane: Emitted only with PassThru.
tmux command#
The tmux commands behind Set-TmuxPaneSize.
tmux C API#
The C declarations in tmux that implement these commands.