Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-12-26 12:53:13 +00:00
Code Issues Projects Releases Packages Wiki Activity

fkr manual improvments.

Browse source
This commit is contained in:
Aaron Gyes 2016-07-03 03:43:14 -07:00
parent 9b4938e2c2
commit 163e16f546
1 changed files with 13 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
doc_src/fish_key_reader.txt
View file

@ -2,19 +2,25 @@
\subsection fish_key_reader-synopsis Synopsis \subsection fish_key_reader-synopsis Synopsis
\fish{synopsis} \fish{synopsis}
fish_key_reader [-c | --continuous] [-d | --debug-level] [-D | --debug-stack-frames] fish_key_reader [-c] [-d LEVEL]
\endfish \endfish
\subsection fish_key_reader-description Description \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`. - `-d` or `--debug-level=DEBUG_LEVEL` enables debug output and specifies a verbosity level. Like `fish -d`. Defaults to 0.
- `-D` or `--debug-stack-frames=DEBUG_LEVEL` specifies how many stack frames to display when debug messages are written. The default is zero. 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`