1fish_key_reader(1)                   fish                   fish_key_reader(1)
2
3
4

NAME

6       fish_key_reader
7

fish_key_reader - explore what characters keyboard keys send

9   Synopsis
10       fish_key_reader [OPTIONS]
11
12   Description
13       fish_key_reader is used to study input received from the terminal and
14       can help with key binds. The program is interactive and works on
15       standard input. Individual characters themselves and their hexadecimal
16       values are displayed.
17
18       The tool will write an example bind command matching the character
19       sequence captured to stdout. If the character sequence matches a
20       special key name (see bind --key-names), both bind CHARS ... and bind
21       -k KEYNAME ... usage will be shown. Additional details about the
22       characters received, such as the delay between chars, are written to
23       stderr.
24
25       The following options are available:
26
27       · -c or --continuous begins a session where multiple key sequences can
28         be inspected. By default the program exits after capturing a single
29         key sequence.
30
31       · -d or --debug-level=DEBUG_LEVEL enables debug output and specifies a
32         verbosity level (like fish -d). Defaults to 0.
33
34       · -D or --debug-stack-frames=DEBUG_LEVEL specify how many stack frames
35         to display when debug messages are written. The default is zero. A
36         value of 3 or 4 is usually sufficient to gain insight into how a
37         given debug call was reached but you can specify a value up to 128.
38
39       · -h or --help prints usage information.
40
41       · -v or --version prints fish_key_reader's version and exits.
42
43   Usage Notes
44       The delay in milliseconds since the previous character was received is
45       included in the diagnostic information written to stderr. This
46       information may be useful to determine the optimal fish_escape_delay_ms
47       setting or learn the amount of lag introduced by tools like ssh, mosh
48       or tmux.
49
50       fish_key_reader intentionally disables handling of many signals. To
51       terminate fish_key_reader in --continuous mode do:
52
53       · press Ctrl-C twice, or
54
55       · press Ctrl-D twice, or
56
57       · type exit, or
58
59       · type quit
60
61Version 3.0.2                   Sun Feb 24 2019             fish_key_reader(1)
Impressum