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
11

DESCRIPTION

13       fish_key_reader is used to explain how you would bind a certain key se‐
14       quence. By default, it prints the bind command  for  one  key  sequence
15       read interactively over standard input.
16
17       If  the  character  sequence  matches  a  special  key  name  (see bind
18       --key-names),  both bind CHARS ... and bind -k KEYNAME ...  usage  will
19       be  shown.  In  verbose mode (enabled by passing --verbose), additional
20       details about the characters received, such as the delay between chars,
21       are written to standard error.
22
23       The following options are available:
24
25       -c or --continuous
26              Begins  a session where multiple key sequences can be inspected.
27              By default the program exits after capturing a  single  key  se‐
28              quence.
29
30       -V or --verbose
31              Tells  fish_key_reader  to output timing information and explain
32              the sequence in more detail.
33
34       -h or --help
35              Displays help about using this command.
36
37       -v or --version
38              Displays the current fish version and then exits.
39

USAGE NOTES

41       In verbose mode, the delay in milliseconds since the previous character
42       was received is included in the diagnostic information written to stan‐
43       dard error. This information may be useful  to  determine  the  optimal
44       fish_escape_delay_ms  setting  or learn the amount of lag introduced by
45       tools like ssh, mosh or tmux.
46
47       fish_key_reader intentionally disables handling  of  many  signals.  To
48       terminate fish_key_reader in --continuous mode do:
49
50       • press Control+C twice, or
51
52       • press Control+D twice, or
53
54       • type exit, or
55
56       • type quit
57

EXAMPLE

59          > fish_key_reader
60          Press a key:
61          # press up-arrow
62          bind \e\[A 'do something'
63
64          > fish_key_reader --verbose
65          Press a key:
66          # press alt+enter
67                     hex:   1B  char: \c[  (or \e)
68          (  0.027 ms)  hex:    D  char: \cM  (or \r)
69          bind \e\r 'do something'
70

72       2023, fish-shell developers
73
74
75
76
773.6                              Dec 06, 2023               FISH_KEY_READER(1)
Impressum