Skip to content

Add Documentation for New PSReadLine Option ViClipboardMode #10325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Add Documentation for New PSReadLine Option ViClipboardMode #10325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b5f137
Add Documentation for New PSReadLine Option ViClipboardMode
WestRyanK Aug 2, 2023
5a54b78
Update Set-PSReadLineOption.md
sdwheeler Aug 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions reference/7.4/PSReadLine/Get-PSReadLineOption.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ CompletionQueryItems : 100
MaximumKillRingCount : 10
ShowToolTips : True
ViModeIndicator : None
ViClipboardMode : ViRegister
WordDelimiters : ;:,.[]{}()/\|^&*-=+'"---
AnsiEscapeTimeout : 100
CommandColor : "`e[93m"
Expand Down
31 changes: 29 additions & 2 deletions reference/7.4/PSReadLine/Set-PSReadLineOption.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ Set-PSReadLineOption [-EditMode <EditMode>] [-ContinuationPrompt <String>] [-His
[-BellStyle <BellStyle>] [-CompletionQueryItems <Int32>] [-WordDelimiters <String>]
[-HistorySearchCaseSensitive] [-HistorySaveStyle <HistorySaveStyle>] [-HistorySavePath <String>]
[-AnsiEscapeTimeout <Int32>] [-PromptText <String[]>] [-ViModeIndicator <ViModeStyle>]
[-ViModeChangeHandler <ScriptBlock>] [-PredictionSource <PredictionSource>]
[-PredictionViewStyle <PredictionViewStyle>] [-Colors <Hashtable>] [<CommonParameters>]
[-ViModeChangeHandler <ScriptBlock>] [-ViClipboardMode <ViClipboardMode>]
[-PredictionSource <PredictionSource>] [-PredictionViewStyle <PredictionViewStyle>]
[-Colors <Hashtable>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -748,6 +749,32 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -ViClipboardMode

This option determines whether the local clipboard or system clipboard is used for copy and paste
operations while in the **Vi Edit Mode**.

The valid values are:

- **ViRegister**: The default value. Copy and paste with **Vi** keys are isolated to the current
prompt. Using **Vi** keys, text cannot be copied and pasted between windows, panes, or external
applications.
- **SystemClipboard**: Copy and paste with **Vi** keys use the system clipboard. Using **Vi** keys,
text can be copied and pasted between windows, panes, and external applications.


```yaml
Type: Microsoft.PowerShell.ViClipboardMode
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: ViRegister
Accept pipeline input: False
Accept wildcard characters: False
```

### -ViModeChangeHandler

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