From 95ebeebb84e86c1c0c56d9709252b886054ae005 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Sun, 17 Jan 2021 11:41:35 +0530 Subject: [PATCH] Mention alternate screen mode in the quickstart --- docs/keyboard-protocol.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/keyboard-protocol.rst b/docs/keyboard-protocol.rst index b904297d2..1a5ac7837 100644 --- a/docs/keyboard-protocol.rst +++ b/docs/keyboard-protocol.rst @@ -41,11 +41,12 @@ If you are an application or library developer just interested in using this protocol to make keyboard handling simpler and more robust in your application, without too many changes, do the following: -#. Emit the escape code ``CSI > 1 u`` at application startup +#. Emit the escape code ``CSI > 1 u`` at application startup or when entering + alternate screen mode #. All key events will now be sent in only a few forms to your application, that are easy to parse unambiguously. -#. Emit the escape sequence ``CSI < u`` at application exit to restore the - previously used keyboard mode. +#. Emit the escape sequence ``CSI < u`` at application exit or just before + leaving alternate screen mode to restore the previously used keyboard mode. Key events will all be delivered to your application either as plain UTF-8 text, or using the following escape codes, for those keys that do not produce