fish-shell/doc_src/cmds/fish_right_prompt.rst

.. _cmd-fish_right_prompt:

fish_right_prompt - define the appearance of the right-side command line prompt
===============================================================================

Synopsis
--------

::

  function fish_right_prompt
      ...
  end


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

``fish_right_prompt`` is similar to ``fish_prompt``, except that it appears on the right side of the terminal window.

Multiple lines are not supported in ``fish_right_prompt``.


Example
-------

A simple right prompt:


::

    function fish_right_prompt -d "Write out the right prompt"
        date '+%m/%d/%y'
    end
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_right_prompt:`

Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00			`fish_right_prompt - define the appearance of the right-side command line prompt`
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
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
docs: Fix some sphinx errors See #5696. [ci skip] 2019-03-29 19:55:28 +00:00			`::`

			`function fish_right_prompt`
			`...`
			`end`
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00
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
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			``fish_right_prompt`` is similar to ``fish_prompt``, except that it appears on the right side of the terminal window.
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			Multiple lines are not supported in ``fish_right_prompt``.
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			`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
			`A simple right prompt:`

Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00

			`::`

			`function fish_right_prompt -d "Write out the right prompt"`
			`date '+%m/%d/%y'`
			`end`

Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00