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
18       sequence  captured  to stdout. If the character sequence matches a spe‐
19       cial key name (see bind --key-names),  both bind CHARS ... and bind  -k
20       KEYNAME  ...  usage will be shown. Additional details about the charac‐
21       ters 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       · -d or --debug=CATEGORY_GLOB enables debug output and specifies a glob
30         for matching debug categories (like fish -d). Defaults to empty.
31
32       · -D  or --debug-stack-frames=DEBUG_LEVEL specify how many stack frames
33         to display when debug messages are written. The default  is  zero.  A
34         value  of  3  or  4  is usually sufficient to gain insight into how a
35         given debug call was reached but you can specify a value up to 128.
36
37       · -h or --help prints usage information.
38
39       · -v or --version prints fish_key_reader's version and exits.
40

USAGE NOTES

42       The delay in milliseconds since the previous character was received  is
43       included in the diagnostic information written to stderr. This informa‐
44       tion may be useful to determine the optimal  fish_escape_delay_ms  set‐
45       ting  or  learn the amount of lag introduced by tools like ssh, mosh or
46       tmux.
47
48       fish_key_reader intentionally disables handling  of  many  signals.  To
49       terminate fish_key_reader in --continuous mode do:
50
51       · press Ctrl-C twice, or
52
53       · press Ctrl-D twice, or
54
55       · type exit, or
56
57       · type quit
58

60       2019, fish-shell developers
61
62
63
64
653.1                              Apr 29, 2020               FISH_KEY_READER(1)
Impressum