diff options
| author | Christian Duerr <contact@christianduerr.com> | 2020-07-03 20:27:18 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-03 20:27:18 +0000 |
| commit | 09179d06fd07c13deb0b108a6f9264f77d9d9599 (patch) | |
| tree | 98410cebc1e1a8a7222fe752622d21c18e03d018 /docs | |
| parent | bc60782e424359d818a22ffa2ffa3c2dc88ab6fe (diff) | |
| download | alacritty-09179d06fd07c13deb0b108a6f9264f77d9d9599.tar.gz alacritty-09179d06fd07c13deb0b108a6f9264f77d9d9599.zip | |
Document supported escape sequences
Fixes #3440.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/escape_support.md | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/docs/escape_support.md b/docs/escape_support.md new file mode 100644 index 00000000..a02848b2 --- /dev/null +++ b/docs/escape_support.md @@ -0,0 +1,100 @@ +# Escape Sequence Support + +This list includes all escape sequences Alacritty currently supports. + +### Legend + +The available statuses are `PARTIAL`, `IMPLEMENTED` and `REJECTED`. While a +status of `PARTIAL` means there is still work left to be done, a status of +`IMPLEMENTED` for something partially implemented means all other features were +rejected. + +All whitespace in escape sequences is solely for formatting purposes and all +relevant spaces are denoted as `SP`. The escape parameters are omitted for +brevity. + +### ESC codes - `ESC` + +| ESCAPE | STATUS | NOTE | +| --------- | ----------- | -------------------------------------------------- | +| `ESC (` | IMPLEMENTED | Only charsets `B` and `0` are supported | +| `ESC )` | IMPLEMENTED | Only charsets `B` and `0` are supported | +| `ESC *` | IMPLEMENTED | Only charsets `B` and `0` are supported | +| `ESC +` | IMPLEMENTED | Only charsets `B` and `0` are supported | +| `ESC =` | IMPLEMENTED | | +| `ESC >` | IMPLEMENTED | | +| `ESC 7` | IMPLEMENTED | | +| `ESC 8` | IMPLEMENTED | | +| `ESC # 8` | IMPLEMENTED | | +| `ESC D` | IMPLEMENTED | | +| `ESC E` | IMPLEMENTED | | +| `ESC H` | IMPLEMENTED | | +| `ESC M` | IMPLEMENTED | | +| `ESC Z` | IMPLEMENTED | | + +### CSI (Control Sequence Introducer) - `ESC [` + +| ESCAPE | STATUS | NOTE | +| ---------- | ----------- | ------------------------------------------------- | +| ``CSI ` `` | IMPLEMENTED | | +| `CSI @` | IMPLEMENTED | | +| `CSI A` | IMPLEMENTED | | +| `CSI a` | IMPLEMENTED | | +| `CSI B` | IMPLEMENTED | | +| `CSI b` | IMPLEMENTED | | +| `CSI C` | IMPLEMENTED | | +| `CSI c` | PARTIAL | No parameter support | +| `CSI D` | IMPLEMENTED | | +| `CSI d` | IMPLEMENTED | | +| `CSI E` | IMPLEMENTED | | +| `CSI e` | IMPLEMENTED | | +| `CSI F` | IMPLEMENTED | | +| `CSI f` | IMPLEMENTED | | +| `CSI G` | IMPLEMENTED | | +| `CSI g` | IMPLEMENTED | | +| `CSI H` | IMPLEMENTED | | +| `CSI h` | PARTIAL | Only modes `4` and `20` are supported | +| `CSI ? h` | PARTIAL | Supported modes: | +| | | `1`, `3`, `6`, `7`, `12`, `25`, `1000`, `1002` | +| | | `1004`, `1005`, `1006`, `1007`, `1049`, `2004` | +| `CSI I` | IMPLEMENTED | | +| `CSI J` | IMPLEMENTED | | +| `CSI K` | IMPLEMENTED | | +| `CSI L` | IMPLEMENTED | | +| `CSI l` | PARTIAL | See `CSI h` for supported modes | +| `CSI ? l` | PARTIAL | See `CSI ? h` for supported modes | +| `CSI M` | IMPLEMENTED | | +| `CSI m` | PARTIAL | Colon separators are not supported | +| `CSI n` | IMPLEMENTED | | +| `CSI P` | IMPLEMENTED | | +| `CSI SP q` | PARTIAL | No blinking support | +| `CSI r` | IMPLEMENTED | | +| `CSI S` | IMPLEMENTED | | +| `CSI s` | IMPLEMENTED | | +| `CSI T` | IMPLEMENTED | | +| `CSI t` | PARTIAL | Only parameters `22` and `23` are supported | +| `CSI u` | IMPLEMENTED | | +| `CSI X` | IMPLEMENTED | | +| `CSI Z` | IMPLEMENTED | | + +### OSC (Operating System Command) - `ESC ]` + +| ESCAPE | STATUS | NOTE | +| --------- | ----------- | -------------------------------------------------- | +| `OSC 0` | IMPLEMENTED | Icon names are not supported | +| `OSC 1` | REJECTED | Icon names are not supported | +| `OSC 2` | IMPLEMENTED | | +| `OSC 4` | IMPLEMENTED | | +| `OSC 10` | IMPLEMENTED | | +| `OSC 11` | IMPLEMENTED | | +| `OSC 12` | IMPLEMENTED | | +| `OSC 50` | IMPLEMENTED | Only `CursorShape` is supported | +| `OSC 52` | IMPLEMENTED | Only Clipboard and primary selection supported | +| `OSC 104` | IMPLEMENTED | | +| `OSC 110` | IMPLEMENTED | | +| `OSC 111` | IMPLEMENTED | | +| `OSC 112` | IMPLEMENTED | | + +### DCS (Device Control String) - `ESC P` + +Alacritty does not support any DCS escapes. |