mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-29 14:23:09 +00:00
55c425a0dd
This used to print all codepoints outside of the ASCII range (i.e. above 0x80) in \uXXXX or \UYYYYYYYY notation. That's quite awkward, considering that this is about keys that are being pressed, and many keyboards have actual symbols for these on them - I have an "ö" key, so I would like to use `bind ö` and not `bind \u00F6`. So we go by iswgraph. On a slightly different note, `\e` was written as `\c[ (or \e)`. I do not believe anyone really uses `\c[` (the `[` would need to be escaped!), and it's confusing and unnecessary to even mention that.
62 lines
2.1 KiB
ReStructuredText
62 lines
2.1 KiB
ReStructuredText
.. _cmd-fish_key_reader:
|
|
|
|
fish_key_reader - explore what characters keyboard keys send
|
|
============================================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. synopsis::
|
|
|
|
fish_key_reader [OPTIONS]
|
|
|
|
Description
|
|
-----------
|
|
|
|
:program:`fish_key_reader` is used to explain how you would bind a certain key sequence. By default, it prints the :doc:`bind <bind>` command for one key sequence read interactively over standard input.
|
|
|
|
If the character sequence matches a special key name (see ``bind --key-names``), both ``bind CHARS ...`` and ``bind -k KEYNAME ...`` usage will be shown. In verbose mode (enabled by passing ``--verbose``), additional details about the characters received, such as the delay between chars, are written to standard error.
|
|
|
|
The following options are available:
|
|
|
|
**-c** or **--continuous**
|
|
Begins a session where multiple key sequences can be inspected. By default the program exits after capturing a single key sequence.
|
|
|
|
**-V** or **--verbose**
|
|
Tells fish_key_reader to output timing information and explain the sequence in more detail.
|
|
|
|
**-h** or **--help**
|
|
Displays help about using this command.
|
|
|
|
**-v** or **--version**
|
|
Displays the current :program:`fish` version and then exits.
|
|
|
|
Usage Notes
|
|
-----------
|
|
|
|
In verbose mode, the delay in milliseconds since the previous character was received is included in the diagnostic information written to standard error. This information may be useful to determine the optimal ``fish_escape_delay_ms`` setting or learn the amount of lag introduced by tools like ``ssh``, ``mosh`` or ``tmux``.
|
|
|
|
``fish_key_reader`` intentionally disables handling of many signals. To terminate ``fish_key_reader`` in ``--continuous`` mode do:
|
|
|
|
- press :kbd:`Control`\ +\ :kbd:`C` twice, or
|
|
- press :kbd:`Control`\ +\ :kbd:`D` twice, or
|
|
- type ``exit``, or
|
|
- type ``quit``
|
|
|
|
Example
|
|
-------
|
|
|
|
::
|
|
|
|
> fish_key_reader
|
|
Press a key:
|
|
# press up-arrow
|
|
bind \e\[A 'do something'
|
|
|
|
> fish_key_reader --verbose
|
|
Press a key:
|
|
# press alt+enter
|
|
hex: 1B char: \e
|
|
( 0.027 ms) hex: D char: \cM (or \r)
|
|
bind \e\r 'do something'
|
|
|