fish-shell/sphinx_doc_src/cmds/fish_hg_prompt.rst

.. _cmd-fish_hg_prompt:

fish_hg_prompt - output Mercurial information for use in a prompt
=================================================================

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

The fish_hg_prompt function displays information about the current Mercurial repository, if any.

`Mercurial <https://www.mercurial-scm.org/>`_ (``hg``) must be installed.

There are numerous customization options, which can be controlled with fish variables.

- ``$fish_color_hg_clean``, ``$fish_color_hg_modified`` and ``$fish_color_hg_dirty`` are colors used when the repository has the respective status.

Some colors for status symbols:

- ``$fish_color_hg_added``
- ``$fish_color_hg_renamed``
- ``$fish_color_hg_copied``
- ``$fish_color_hg_deleted``
- ``$fish_color_hg_untracked``
- ``$fish_color_hg_unmerged``

The status symbols themselves:

- ``$fish_prompt_hg_status_added``, default '✚'
- ``$fish_prompt_hg_status_modified``, default '*'
- ``$fish_prompt_hg_status_copied``, default '⇒'
- ``$fish_prompt_hg_status_deleted``, default '✖'
- ``$fish_prompt_hg_status_untracked``, default '?'
- ``$fish_prompt_hg_status_unmerged``, default '!'

Finally, ``$fish_prompt_hg_status_order``, which can be used to change the order the status symbols appear in. It defaults to ``added modified copied deleted untracked unmerged``.

See also :ref:`fish_vcs_prompt <cmd-fish_vcs_prompt>`, which will call all supported version control prompt functions, including git, Mercurial and Subversion.

Example
-------

A simple prompt that displays hg info::

    function fish_prompt
        ...
        printf '%s %s$' $PWD (fish_hg_prompt)
    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_hg_prompt:`

docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00:00			`fish_hg_prompt - output Mercurial information for use in a prompt`
Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00			`=================================================================`

			`Description`
			`-----------`

docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00:00			`The fish_hg_prompt function displays information about the current Mercurial repository, if any.`
Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00:00			`Mercurial <https://www.mercurial-scm.org/>`_ (``hg``) must be installed.
Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00:00			`There are numerous customization options, which can be controlled with fish variables.`
Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00:00			- ``$fish_color_hg_clean``, ``$fish_color_hg_modified`` and ``$fish_color_hg_dirty`` are colors used when the repository has the respective status.
Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00
			`Some colors for status symbols:`

docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00:00			- ``$fish_color_hg_added``
			- ``$fish_color_hg_renamed``
			- ``$fish_color_hg_copied``
			- ``$fish_color_hg_deleted``
			- ``$fish_color_hg_untracked``
			- ``$fish_color_hg_unmerged``
Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00:00			`The status symbols themselves:`
Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00:00			- ``$fish_prompt_hg_status_added``, default '✚'
			- ``$fish_prompt_hg_status_modified``, default '*'
			- ``$fish_prompt_hg_status_copied``, default '⇒'
			- ``$fish_prompt_hg_status_deleted``, default '✖'
			- ``$fish_prompt_hg_status_untracked``, default '?'
			- ``$fish_prompt_hg_status_unmerged``, default '!'
Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00:00			Finally, ``$fish_prompt_hg_status_order``, which can be used to change the order the status symbols appear in. It defaults to ``added modified copied deleted untracked unmerged``.
Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00:00			See also :ref:`fish_vcs_prompt <cmd-fish_vcs_prompt>`, which will call all supported version control prompt functions, including git, Mercurial and Subversion.
Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00
			`Example`
			`-------`

			`A simple prompt that displays hg info::`

			`function fish_prompt`
			`...`
			`printf '%s %s$' $PWD (fish_hg_prompt)`
			`end`