Skip to content

Commit 8a8482c

Browse files
Ryan WestRyan West
authored andcommitted
Add Documentation for New PSReadLine Option ViClipboardMode
1 parent 698ca4e commit 8a8482c

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

reference/7.4/PSReadLine/Get-PSReadLineOption.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ CompletionQueryItems : 100
5656
MaximumKillRingCount : 10
5757
ShowToolTips : True
5858
ViModeIndicator : None
59+
ViClipboardMode : ViRegister
5960
WordDelimiters : ;:,.[]{}()/\|^&*-=+'"---
6061
AnsiEscapeTimeout : 100
6162
CommandColor : "`e[93m"

reference/7.4/PSReadLine/Set-PSReadLineOption.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ Set-PSReadLineOption [-EditMode <EditMode>] [-ContinuationPrompt <String>] [-His
2424
[-BellStyle <BellStyle>] [-CompletionQueryItems <Int32>] [-WordDelimiters <String>]
2525
[-HistorySearchCaseSensitive] [-HistorySaveStyle <HistorySaveStyle>] [-HistorySavePath <String>]
2626
[-AnsiEscapeTimeout <Int32>] [-PromptText <String[]>] [-ViModeIndicator <ViModeStyle>]
27-
[-ViModeChangeHandler <ScriptBlock>] [-PredictionSource <PredictionSource>]
28-
[-PredictionViewStyle <PredictionViewStyle>] [-Colors <Hashtable>] [<CommonParameters>]
27+
[-ViModeChangeHandler <ScriptBlock>] [-ViClipboardMode <ViClipboardMode>]
28+
[-PredictionSource <PredictionSource>] [-PredictionViewStyle <PredictionViewStyle>]
29+
[-Colors <Hashtable>] [<CommonParameters>]
2930
```
3031

3132
## DESCRIPTION
@@ -748,6 +749,29 @@ Accept pipeline input: False
748749
Accept wildcard characters: False
749750
```
750751

752+
### -ViClipboardMode
753+
754+
This option determines whether the local clipboard or system clipboard is used for copy and paste
755+
operations while in the **Vi Edit Mode**.
756+
757+
The valid values are as follows:
758+
- **ViRegister**: The default value. Copy and paste with **Vi** keys is isolated to the current prompt.
759+
Using **Vi** keys, text cannot be copied and pasted between windows, panes, or external applications.
760+
- **SystemClipboard**: Copy and paste with **Vi** keys uses the system clipboard. Using **Vi** keys,
761+
text can be copied and pasted between windows, panes, and external applications.
762+
763+
```yaml
764+
Type: Microsoft.PowerShell.ViClipboardMode
765+
Parameter Sets: (All)
766+
Aliases:
767+
768+
Required: False
769+
Position: Named
770+
Default value: None
771+
Accept pipeline input: False
772+
Accept wildcard characters: False
773+
```
774+
751775
### -ViModeChangeHandler
752776

753777
When the **ViModeIndicator** is set to `Script`, the script block provided will be invoked every

0 commit comments

Comments
 (0)