2019-03-31 17:05:09 +08:00
.. _cmd-fish_key_reader:
2018-12-17 09:39:33 +08:00
fish_key_reader - explore what characters keyboard keys send
2019-01-03 12:10:47 +08:00
============================================================
2018-12-17 09:39:33 +08:00
2018-12-18 09:58:24 +08:00
Synopsis
--------
2018-12-17 05:08:41 +08:00
docs synopsis: add HTML highlighing and automate manpage markup
Recent synopsis changes move from literal code blocks to
[RST line blocks]. This does not translate well to HTML: it's not
rendered in monospace, so aligment is lost. Additionally, we don't
get syntax highlighting in HTML, which adds differences to our code
samples which are highlighted.
We hard-wrap synopsis lines (like code blocks). To align continuation
lines in manpages we need [backslashes in weird places]. Combined with
the **, *, and `` markup, it's a bit hard to get the alignment right.
Fix these by moving synopsis sources back to code blocks and compute
HTML syntax highlighting and manpage markup with a custom Sphinx
extension.
The new Pygments lexer can tokenize a synopsis and assign the various
highlighting roles, which closely matches fish's syntax highlighing:
- command/keyword (dark blue)
- parameter (light blue)
- operator like and/or/not/&&/|| (cyan)
- grammar metacharacter (black)
For manpage output, we don't project the fish syntax highlighting
but follow the markup convention in GNU's man(1):
bold text type exactly as shown.
italic text replace with appropriate argument.
To make it easy to separate these two automatically, formalize that
(italic) placeholders must be uppercase; while all lowercase text is
interpreted literally (so rendered bold).
This makes manpages more consistent, see string-join(1) and and(1).
Implementation notes:
Since we want manpage formatting but Sphinx's Pygments highlighing
plugin does not support manpage output, add our custom "synopsis"
directive. This directive parses differently when manpage output is
specified. This means that the HTML and manpage build processes must
not share a cache, because the parsed doctrees are cached. Work around
this by using separate cache locations for build targets "sphinx-docs"
(which creates HTML) and "sphinx-manpages". A better solution would
be to only override Sphinx's ManualPageBuilder but that would take a
bit more code (ideally we could override ManualPageWriter but Sphinx
4.3.2 doesn't really support that).
---
Alternative solution: stick with line blocks but use roles like
:command: or :option: (or custom ones). While this would make it
possible to produce HTML that is consistent with code blocks (by adding
a bit of CSS), the source would look uglier and is harder to maintain.
(Let's say we want to add custom formatting to the [|] metacharacters
in HTML. This is much easier with the proposed patch.)
---
[RST line blocks]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks
[backslashes in weird places]: https://github.com/fish-shell/fish-shell/pull/8626#discussion_r782837750
2022-01-09 22:09:46 +08:00
.. synopsis ::
fish_key_reader [OPTIONS]
2018-12-17 05:08:41 +08:00
2018-12-19 10:44:30 +08:00
Description
2019-01-03 12:10:47 +08:00
-----------
2018-12-17 05:08:41 +08:00
2022-09-24 01:57:49 +08:00
: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.
2018-12-17 05:08:41 +08:00
2022-03-12 00:18:41 +08:00
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.
2018-12-17 05:08:41 +08:00
The following options are available:
2022-03-11 23:56:20 +08:00
**-c** or **--continuous**
Begins a session where multiple key sequences can be inspected. By default the program exits after capturing a single key sequence.
2018-12-17 05:08:41 +08:00
2022-03-11 23:56:20 +08:00
**-V** or **--verbose**
Tells fish_key_reader to output timing information and explain the sequence in more detail.
2021-11-23 00:22:22 +08:00
2022-03-11 23:56:20 +08:00
**-h** or **--help**
Displays help about using this command.
2018-12-17 05:08:41 +08:00
2022-03-11 23:56:20 +08:00
**-v** or **--version**
Displays the current :program: `fish` version and then exits.
2018-12-17 05:08:41 +08:00
2018-12-19 10:44:30 +08:00
Usage Notes
2019-01-03 12:10:47 +08:00
-----------
2018-12-17 05:08:41 +08:00
2022-03-12 00:18:41 +08:00
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 `` .
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
`` fish_key_reader `` intentionally disables handling of many signals. To terminate `` fish_key_reader `` in `` --continuous `` mode do:
2018-12-17 05:08:41 +08:00
2020-03-20 13:47:22 +08:00
- press :kbd: `Control` \ +\ :kbd: `C` twice, or
- press :kbd: `Control` \ +\ :kbd: `D` twice, or
2018-12-20 04:02:45 +08:00
- type `` exit `` , or
- type `` quit ``
2021-11-23 00:22:22 +08:00
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
2023-08-26 15:40:53 +08:00
hex: 1B char: \e
2021-11-23 00:22:22 +08:00
( 0.027 ms) hex: D char: \cM (or \r)
bind \e\r 'do something'
