Skip to content

Commit 11e613c

Browse files
committed
Use colon format for list items
1 parent 46f14db commit 11e613c

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

docs/terminal/shell-integration.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -233,11 +233,11 @@ VS Code has a set of custom escape sequences designed to enable the shell integr
233233

234234
These sequences should be ignored by other terminals, but unless other terminals end up adopting the sequences more widely, it's recommended to check that `$TERM_PROGRAM` is `vscode` before writing them.
235235

236-
- `OSC 633 ; A ST` - Mark prompt start.
237-
- `OSC 633 ; B ST` - Mark prompt end.
238-
- `OSC 633 ; C ST` - Mark pre-execution.
239-
- `OSC 633 ; D [; <exitcode>] ST` - Mark execution finished with an optional exit code.
240-
- `OSC 633 ; E ; <commandline> [; <nonce] ST` - Explicitly set the command line with an optional nonce.
236+
- `OSC 633 ; A ST`: Mark prompt start.
237+
- `OSC 633 ; B ST`: Mark prompt end.
238+
- `OSC 633 ; C ST`: Mark pre-execution.
239+
- `OSC 633 ; D [; <exitcode>] ST`: Mark execution finished with an optional exit code.
240+
- `OSC 633 ; E ; <commandline> [; <nonce] ST`: Explicitly set the command line with an optional nonce.
241241

242242
The E sequence allows the terminal to reliably get the exact command line interpreted by the shell. When this is not specified, the terminal may fallback to using the A, B and C sequences to get the command, or disable the detection all together if it's unreliable.
243243

@@ -253,30 +253,30 @@ These sequences should be ignored by other terminals, but unless other terminals
253253
";" -> "\x3b"
254254
```
255255

256-
- `OSC 633 ; P ; <Property>=<Value> ST` - Set a property on the terminal, only known properties will be handled.
256+
- `OSC 633 ; P ; <Property>=<Value> ST`: Set a property on the terminal, only known properties will be handled.
257257

258258
Known properties:
259259

260-
- `Cwd` - Reports the current working directory to the terminal.
261-
- `IsWindows` - Indicates whether the terminal is using a Windows backend like winpty or conpty. This may be used to enable additional heuristics as the positioning of the shell integration sequences are not guaranteed to be correct. Valid values are `True` and `False`.
262-
- `HasRichCommandDetection` - Indicates whether the terminal has rich command detection capabilities. This property is set to `True` when the shell integration script acts ideally as VS Code expects it, specifically sequences should come in the expected positions in the order `A, B, E, C, D`.
260+
- `Cwd`: Reports the current working directory to the terminal.
261+
- `IsWindows`: Indicates whether the terminal is using a Windows backend like winpty or conpty. This may be used to enable additional heuristics as the positioning of the shell integration sequences are not guaranteed to be correct. Valid values are `True` and `False`.
262+
- `HasRichCommandDetection`: Indicates whether the terminal has rich command detection capabilities. This property is set to `True` when the shell integration script acts ideally as VS Code expects it, specifically sequences should come in the expected positions in the order `A, B, E, C, D`.
263263

264264

265265
### Final Term shell integration
266266

267267
VS Code supports Final Term's shell integration sequences, which allow non-VS Code shell integration scripts to work in VS Code. This results in a somewhat degraded experience as it doesn't support as many features as `OSC 633`. Here are the specific sequences that are supported:
268268

269-
- `OSC 133 ; A ST` - Mark prompt start.
270-
- `OSC 133 ; B ST` - Mark prompt end.
271-
- `OSC 133 ; C ST` - Mark pre-execution.
272-
- `OSC 133 ; D [; <exitcode>] ST` - Mark execution finished with an optional exit code.
269+
- `OSC 133 ; A ST`: Mark prompt start.
270+
- `OSC 133 ; B ST`: Mark prompt end.
271+
- `OSC 133 ; C ST`: Mark pre-execution.
272+
- `OSC 133 ; D [; <exitcode>] ST`: Mark execution finished with an optional exit code.
273273

274274
### iTerm2 shell integration
275275

276276
The following sequences that iTerm2 pioneered are supported:
277277

278-
- `OSC 1337 ; CurrentDir=<Cwd> S` - Sets the current working directory of the terminal, similar to `OSC 633 ; P ; Cwd=<Cwd> ST`.
279-
- `OSC 1337 ; SetMark ST` - Adds a mark to the left of the line it was triggered on and also adds an annotation to the scroll bar:
278+
- `OSC 1337 ; CurrentDir=<Cwd> S`: Sets the current working directory of the terminal, similar to `OSC 633 ; P ; Cwd=<Cwd> ST`.
279+
- `OSC 1337 ; SetMark ST`: Adds a mark to the left of the line it was triggered on and also adds an annotation to the scroll bar:
280280

281281
![When the sequence is written to the terminal a small grey circle will appear to the left of the command, with a matching annotation in the scroll bar](images/shell-integration/setmark.png)
282282

0 commit comments

Comments
 (0)