fish-shell/doc_src/cmds/fish_key_reader.rst

.. _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.

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.

**-h** or **--help**
    Displays help about using this command.

**-V** or **--verbose**
    Explain what sequence was received in addition to the decoded key.

**-v** or **--version**
    Displays the current :program:`fish` version and then exits.

Usage Notes
-----------

``fish_key_reader`` intentionally disables handling of many signals. To terminate ``fish_key_reader`` in ``--continuous`` mode do:

- press :kbd:`ctrl-c` twice, or
- press :kbd:`ctrl-d` twice, or
- type ``exit``, or
- type ``quit``

Example
-------

::

   > fish_key_reader
   Press a key:
   # press up-arrow
   bind up 'do something'
docs: Add labels to all commands This allows us to use :ref: references, which don't require hardcoding it as html [ci skip] 2019-03-31 17:05:09 +08:00			`.. _cmd-fish_key_reader:`

Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00			`fish_key_reader - explore what characters keyboard keys send`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`============================================================`
Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 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]`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Description`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs: Use :doc: role when linking to commands This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands. 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.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			`The following options are available:`

docs: standardise on definition lists for options Harmonizes the option listing including formatting in a similar manner to the synopsis of each entry. 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.`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs: standardise on definition lists for options Harmonizes the option listing including formatting in a similar manner to the synopsis of each entry. 2022-03-11 23:56:20 +08:00			`-h or --help`
			`Displays help about using this command.`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Add back docs for fish_key_reader --verbose 2024-08-11 20:46:03 +08:00			`-V or --verbose`
			`Explain what sequence was received in addition to the decoded key.`

docs: standardise on definition lists for options Harmonizes the option listing including formatting in a similar manner to the synopsis of each entry. 2022-03-11 23:56:20 +08:00			`-v or --version`
			Displays the current :program:`fish` version and then exits.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Usage Notes`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 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:
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs: use canonical key names in :kbd: tags This seems a bit better because it's what bind uses. To makes sure that something like :kbd:`ctrl-x` looks good in HTML, remove the border from the kbd style. Else both "ctrl" and "x" get small boxes which looks weird. 2024-04-14 02:30:07 +08:00			- press :kbd:`ctrl-c` twice, or
			- press :kbd:`ctrl-d` twice, or
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- type ``exit``, or
			- type ``quit``
Make fish_key_reader's output simpler (#8467) * fish_key_reader: Simplify default output It now only prints the bind statement. Timing information and such is relegated to a separate "verbose" mode. * Adjust fish_key_reader docs * Adjust tests 2021-11-23 00:22:22 +08:00
			`Example`
			`-------`

			`::`

			`> fish_key_reader`
			`Press a key:`
			`# press up-arrow`
Extended & human-friendly keys See the changelog additions for user-visible changes. Since we enable/disable terminal protocols whenever we pass terminal ownership, tests can no longer run in parallel on the same terminal. For the same reason, readline shortcuts in the gdb REPL will not work anymore. As a remedy, use gdbserver, or lobby for CSI u support in libreadline. Add sleep to some tests, otherwise they fall (both in CI and locally). There are two weird failures on FreeBSD remaining, disable them for now https://github.com/fish-shell/fish-shell/pull/10359/checks?check_run_id=23330096362 Design and implementation borrows heavily from Kakoune. In future, we should try to implement more of the kitty progressive enhancements. Closes #10359 2024-03-30 23:10:12 +08:00			`bind up 'do something'`