fish-shell/sphinx_doc_src/cmds/fish_mode_prompt.rst

.. _cmd-fish_mode_prompt:

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


The fish_mode_prompt function will output the mode indicator for use in vi-mode.

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

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. You can also define an empty ``fish_mode_prompt`` function to remove the Vi mode indicators. The ``$fish_bind_mode variable`` can be used to determine the current mode. It
will be one of ``default``, ``insert``, ``replace_one``, or ``visual``.

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 17:05:09 +08:00			`.. _cmd-fish_mode_prompt:`

Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00			`fish_mode_prompt - define the appearance of the mode indicator`
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
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00

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

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
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08: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. You can also define an empty ``fish_mode_prompt`` function to remove the Vi mode indicators. 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-17 05:08:41 +08:00
Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Example`
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 \fish sections to rst format 2018-12-19 11:14:04 +08: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-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			Outputting multiple lines is not supported in ``fish_mode_prompt``.