mirror of
https://github.com/fish-shell/fish-shell
synced 2024-09-21 06:51:58 +00:00
41 lines
1.2 KiB
ReStructuredText
41 lines
1.2 KiB
ReStructuredText
.. _cmd-fish_vcs_prompt:
|
|
|
|
fish_vcs_prompt - output version control system information for use in a prompt
|
|
===============================================================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
::
|
|
|
|
function fish_prompt
|
|
printf '%s' $PWD (fish_vcs_prompt) ' $ '
|
|
end
|
|
|
|
Description
|
|
-----------
|
|
|
|
The ``fish_vcs_prompt`` function displays information about the current version control system (VCS) repository, if any.
|
|
|
|
It calls out to VCS-specific functions. The currently supported systems are:
|
|
|
|
- :ref:`fish_git_prompt <cmd-fish_git_prompt>`
|
|
- :ref:`fish_hg_prompt <cmd-fish_hg_prompt>`
|
|
- :ref:`fish_svn_prompt <cmd-fish_svn_prompt>`
|
|
|
|
If a VCS isn't installed, the respective function does nothing.
|
|
|
|
The svn prompt is disabled by default because it's slow on large svn repositories. To enable it, modify fish_vcs_prompt to uncomment it. See :ref:`funced <cmd-funced>`.
|
|
|
|
For more information, see the documentation for each of the functions above.
|
|
|
|
Example
|
|
-------
|
|
|
|
A simple prompt that displays all known VCS info::
|
|
|
|
function fish_prompt
|
|
...
|
|
set -g __fish_git_prompt_showupstream auto
|
|
printf '%s %s$' $PWD (fish_vcs_prompt)
|
|
end
|