Skip to content

Commit 16b50e9

Browse files
authored
Add docs for "Copy with control sequences" functionality (#756)
See microsoft/terminal#17059
1 parent 726fd71 commit 16b50e9

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

TerminalDocs/customize-settings/actions.md

+1
Original file line numberDiff line numberDiff line change
@@ -1177,6 +1177,7 @@ This copies the selected terminal content to your clipboard. If no selection exi
11771177
| Name | Necessity | Accepts | Description |
11781178
| ---- | --------- | ------- | ----------- |
11791179
| `singleLine` | Optional | `true`, `false` | When `true`, the copied content will be copied as a single line. When `false`, newlines persist from the selected text. |
1180+
| `withControlSequences` | Optional | `true`, `false` | When `true`, copied content will contain ANSI escape code control sequences representing the styling of the content. When `false`, only the plain text will be copied. |
11801181
| `copyFormatting` | Optional | `true`, `false`, `"all"`, `"none"`, `"html"`, `"rtf"` | When `true`, the color and font formatting of the selected text is also copied to your clipboard. When `false`, only plain text is copied to your clipboard. You can also specify which formats you would like to copy. When `null`, the global `"copyFormatting"` behavior is inherited. |
11811182

11821183
### Paste

TerminalDocs/selection.md

+2
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ As mentioned above, selected text can be copied with a right-click or the `copy`
7373
- You can copy text without dismissing the text selection by setting the `dismissSelection` parameter in the `copy` action to `false`.
7474
- Copying as a single line
7575
- You can copy text as a single line using the `singleLine` parameter in the `copy` action.
76+
- Copying with control sequences
77+
- You can include [ANSI escape code](https://en.wikipedia.org/wiki/ANSI_escape_code) control sequences in the copied text using the `withControlSequences` parameter in the `copy` action.
7678
- Removing trailing whitespace from block selections
7779
- You can remove the trailing whitespace from a block selection using the `trimBlockSelection` global setting.
7880

0 commit comments

Comments
 (0)