1
0
Fork 0
mirror of https://github.com/alacritty/alacritty.git synced 2024-11-11 13:51:01 -05:00
alacritty/docs/escape_support.md
Taylor Blau 56e0f5bb05
Add support for urgency hints CSI
Teach Alacritty to stop setting the window as urgent upon a bell by
emulating xterm's 'bellIsUrgent' resource and relevant CSI. When this
resource is enabled (with 'CSI ? 1042 h'), a bell event causes the
window to be marked as urgent. When the resource is disabled (with 'CSI
? 1042 l'), the window is not marked urgent in the event of a bell.

There are two wrinkles worth noting here:

  - The 'TermMode::URGENCY_HINTS' does _not_ affect the terminal's
    configured bell command, since we only want to control whether or
    not the window is marked as urgent, not anything else.

  - In xterm, the 'bellIsUrgent' resource is _disabled_ by default.
    Since bouncing the dock icon has been the default in Alacritty on
    macOS thus far, do not make an effort to change that in this patch.

This allows users to emit "\e[?1042l" and disable bouncing the dock
icon.

Fixes #2950.
2020-10-10 21:24:40 +00:00

6.6 KiB

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 IMPLEMENTED
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, 1042, 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 Only singular straight underlines are 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
REJECTED 1-13, 15, 19-21, 24
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.