fish-shell/doc_src/fish_vcs_prompt.txt
2019-02-10 14:44:50 +01:00

29 lines
714 B
Plaintext

\section fish_vcs_prompt fish_vcs_prompt - output vcs information for use in a prompt
\subsection fish_vcs_prompt-description Description
The fish_vcs_prompt function can be used to display information about the current vcs repository, if any.
It calls out to vcs-specific functions. The currently supported ones are:
- fish_git_prompt
- fish_hg_prompt
- fish_svn_prompt
If a vcs isn't installed, the respective function does nothing.
For more information, see their documentation.
\subsection fish_vcs_prompt-example Example
A simple prompt that displays vcs info:
\fish
function fish_prompt
...
set -g __fish_git_prompt_showupstream auto
printf '%s %s$' $PWD (fish_vcs_prompt)
end
\endfish