fish-shell/doc_src/cmds/fish_mode_prompt.rst

.. _cmd-fish_mode_prompt:

fish_mode_prompt - define the appearance of the mode indicator
==============================================================

Synopsis
--------

.. synopsis::

    fish_mode_prompt

::

     function fish_mode_prompt
          echo -n "$fish_bind_mode "
     end


Description
-----------

The ``fish_mode_prompt`` function outputs the mode indicator for use in vi-mode.

The default ``fish_mode_prompt`` function will output indicators about the current Vi editor mode displayed to the left of the regular prompt. Define your own function to customize the appearance of the mode indicator. The ``$fish_bind_mode variable`` can be used to determine the current mode. It will be one of ``default``, ``insert``, ``replace_one``, or ``visual``.

You can also define an empty ``fish_mode_prompt`` function to remove the Vi mode indicators::

    function fish_mode_prompt; end
    funcsave fish_mode_prompt

``fish_mode_prompt`` will be executed when the vi mode changes. If it produces any output, it is displayed and used. If it does not, the other prompt functions (:doc:`fish_prompt <fish_prompt>` and :doc:`fish_right_prompt <fish_right_prompt>`) will be executed as well in case they contain a mode display.

Example
-------


::

    function fish_mode_prompt
      switch $fish_bind_mode
        case default
          set_color --bold red
          echo 'N'
        case insert
          set_color --bold green
          echo 'I'
        case replace_one
          set_color --bold green
          echo 'R'
        case visual
          set_color --bold brmagenta
          echo 'V'
        case '*'
          set_color --bold red
          echo '?'
      end
      set_color normal
    end


Outputting multiple lines is not supported in ``fish_mode_prompt``.
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 09:05:09 +00:00			`.. _cmd-fish_mode_prompt:`

Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00			`fish_mode_prompt - define the appearance of the mode indicator`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`==============================================================`
Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 09:59:04 +00:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00: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 14:09:46 +00:00			`.. synopsis::`

			`fish_mode_prompt`

docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 09:59:04 +00:00			`::`

			`function fish_mode_prompt`
			`echo -n "$fish_bind_mode "`
			`end`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00

Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Description`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 09:59:04 +00:00			The ``fish_mode_prompt`` function outputs the mode indicator for use in vi-mode.

docs: link and explicit instructions on creating a blank fish_mode_prompt Work on #5783. [ci skip] 2020-06-06 14:52:07 +00:00			The default ``fish_mode_prompt`` function will output indicators about the current Vi editor mode displayed to the left of the regular prompt. Define your own function to customize the appearance of the mode indicator. The ``$fish_bind_mode variable`` can be used to determine the current mode. It will be one of ``default``, ``insert``, ``replace_one``, or ``visual``.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
docs: link and explicit instructions on creating a blank fish_mode_prompt Work on #5783. [ci skip] 2020-06-06 14:52:07 +00:00			You can also define an empty ``fish_mode_prompt`` function to remove the Vi mode indicators::

			`function fish_mode_prompt; end`
			`funcsave fish_mode_prompt`

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-23 17:57:49 +00:00			``fish_mode_prompt`` will be executed when the vi mode changes. If it produces any output, it is displayed and used. If it does not, the other prompt functions (:doc:`fish_prompt <fish_prompt>` and :doc:`fish_right_prompt <fish_right_prompt>`) will be executed as well in case they contain a mode display.
Repaint-mode to reexecute the rest if mode-prompt output is empty We previously checked if fish_mode_prompt existed as a function, but that's a bad change for those who already set it to an empty function to have a mode display elsewhere. 2019-05-14 11:07:04 +00:00
Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Example`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00

			`::`

			`function fish_mode_prompt`
			`switch $fish_bind_mode`
			`case default`
			`set_color --bold red`
			`echo 'N'`
			`case insert`
			`set_color --bold green`
			`echo 'I'`
			`case replace_one`
			`set_color --bold green`
			`echo 'R'`
			`case visual`
			`set_color --bold brmagenta`
			`echo 'V'`
			`case '*'`
			`set_color --bold red`
			`echo '?'`
			`end`
			`set_color normal`
			`end`

Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			Outputting multiple lines is not supported in ``fish_mode_prompt``.