Miscellaneous protocol extensions - kitty
Description: These are a few small protocol extensions kitty implements, primarily for use by its own kitten, they are documented here for completeness. Simple save/restore of all terminal modes: XTerm has the ...

Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# Miscellaneous protocol extensions

These are a few small protocol extensions kitty implements, primarily for use by its own kitten, they are documented here for completeness.

## Simple save/restore of all terminal modes

XTerm has the XTSAVE/XTRESTORE escape codes to save and restore terminal private modes. However, they require specifying an explicit list of modes to save/restore. kitty extends this protocol to specify that when no modes are specified, all side-effect free modes should be saved/restored. By side-effects we mean things that can affect other terminal state such as cursor position or screen contents. Examples of modes that have side effects are: DECOM and DECCOLM.

This allows TUI applications to easily save and restore emulator state without needing to maintain lists of modes.

## Independent control of bold and faint SGR properties

In common terminal usage, bold is set via SGR 1 and faint by SGR 2. However, there is only one number to reset these attributes, SGR 22, which resets both. There is no way to reset one and not the other. kitty uses 221 and 222 to reset bold and faint independently.

## kitty specific private escape codes

These are a family of escape codes used by kitty for various things including remote control. They are all DCS (Device Control String) escape codes starting with `\x1b P @ kitty-` (ignoring spaces present for clarity).