1FISH_KEY_READER(1)                fish-shell                FISH_KEY_READER(1)
2
3
4

NAME

6       fish_key_reader - explore what characters keyboard keys send
7

SYNOPSIS

9          fish_key_reader [OPTIONS]
10

DESCRIPTION

12       fish_key_reader  is  used to study input received from the terminal and
13       can help with key binds. The program is interactive and works on  stan‐
14       dard input. Individual characters themselves and their hexadecimal val‐
15       ues are displayed.
16
17       The tool will write an example bind command matching the character  se‐
18       quence  captured to stdout. If the character sequence matches a special
19       key name (see bind --key-names),  both bind CHARS ... and bind -k  KEY‐
20       NAME  ...  usage will be shown. Additional details about the characters
21       received, such as the delay between chars, are written to stderr.
22
23       The following options are available:
24
25       • -c or --continuous begins a session where multiple key sequences  can
26         be  inspected.  By default the program exits after capturing a single
27         key sequence.
28
29       • -h or --help prints usage information.
30
31       • -v or --version prints fish_key_reader's version and exits.
32

USAGE NOTES

34       The delay in milliseconds since the previous character was received  is
35       included in the diagnostic information written to stderr. This informa‐
36       tion may be useful to determine the optimal  fish_escape_delay_ms  set‐
37       ting  or  learn the amount of lag introduced by tools like ssh, mosh or
38       tmux.
39
40       fish_key_reader intentionally disables handling  of  many  signals.  To
41       terminate fish_key_reader in --continuous mode do:
42
43       • press Control+C twice, or
44
45       • press Control+D twice, or
46
47       • type exit, or
48
49       • type quit
50

52       2021, fish-shell developers
53
54
55
56
573.3                              Jul 06, 2021               FISH_KEY_READER(1)
Impressum