diff --git a/doc_src/fish_key_reader.txt b/doc_src/fish_key_reader.txt index f2788c214..f27726ff2 100644 --- a/doc_src/fish_key_reader.txt +++ b/doc_src/fish_key_reader.txt @@ -2,17 +2,25 @@ \subsection fish_key_reader-synopsis Synopsis \fish{synopsis} -fish_key_reader [-c | --continuous] [-d | --debug-level] [-D | --debug-stack-frames] +fish_key_reader [-c] [-d LEVEL] \endfish \subsection fish_key_reader-description Description -`fish_key_reader` can be used to interrogate the characters received by `fish` and figure out key binds. If the sequence of characters matches a key name recognized by the `bind` command, `bind`'s representation will be shown. The delay in milliseconds since the previous character was received is also shown. +`fish_key_reader` is used to study input `fish` receives from the terminal and can help with key binds. The program is interactive and works on standard input. Individual characters themselves and their hexadecimal values are displayed. -The tool will output an example bind command matching the sequence captured which can be fed back into fish after being given. +The tool will output an example `bind` command matching the character sequence captured. If a character sequence is read that matches a key name recognized by the `bind` command (see `bind --key-names`), additionally a bind command will also be shown for `bind -k` usage. -The timing data may be useful to determine a preferred `fish_escape_delay_ms` setting or learn the amount of lag introduced by `ssh` or `tmux`. +The following parameters are available: -- `-c` or `--continuous` begins a session where mutlitple key sequences can be inspected. By default the program exits after capturing a single key sequence. Press `^D` twice or type `exit` to exit. +- `-c` or `--continuous` begins a session where multiple key sequences can be inspected. By default the program exits after capturing a single key sequence. -- `-d` or `--debug-level=DEBUG_LEVEL` enables debug output and specifies a verbosity level. Like `fish -d`. \ No newline at end of file +- `-d` or `--debug-level=DEBUG_LEVEL` enables debug output and specifies a verbosity level. Like `fish -d`. + +If using `-c`, the delay in milliseconds since the previous character was received is also shown. This timing data may be useful to determine a preferred `fish_escape_delay_ms` setting or learn the amount of lag introduced by `ssh` or `tmux`. + +`fish_key_reader` intentionally disables handling of many signals. To terminate `fish_key_reader` in a `--continuous` run: +- press `Ctrl-C` twice, or +- press `Ctrl-D` twice, or +- type `exit`, or +- type `quit` \ No newline at end of file