ASCII And ANSI Escape Sequences (key-code)

Returns character sequences for any key pressed (ie sent from the terminal)

Description

key-code is a tool used for querying what byte sequence the terminal emulator

Usage

key-code -> <stdout>

<stdin> -> key-code -> <stdout>

Examples

Typical use case

» key-code
Press any key to print its escape constants...

…then press [f9] and key-code returns…

ANSI Constants:   {F9}
Byte Sequence:    %[27 91 50 48 126]
Contains Unicode: false

As a method

» tout str '{ESC}[20~' -> key-code
ANSI Constants:   {F9}
Byte Sequence:    %[27 91 50 48 126]
Contains Unicode: false

Detail

Redirection

If stdout is not a TTY then only the thing written is the ANSI Constant. This is so that it can be used as a variable. eg

key-code -> set $key

event onKeyPress close=$key {
    exit
}

See Also


This document was generated from builtins/events/onKeyPress/keycodes_doc.yaml.

This site's content is rebuilt automatically from murex's source code after each merge to the master branch. Downloadable murex binaries are also built with the website.

Last built on Wed Sep 18 21:18:57 UTC 2024 against commit c037883c03788357164e9846c84d9f777251495d9452a8e.

Current version is 6.3.4225 (develop) which has been verified against tests cases.