mirror of
https://github.com/fish-shell/fish-shell.git
synced 2026-05-02 02:41:15 -03:00
484032fa9e
Add support for the SHELL_PROMPT_PREFIX, SHELL_PROMPT_SUFFIX, and SHELL_WELCOME environment variables as standardized by systemd v257. SHELL_PROMPT_PREFIX and SHELL_PROMPT_SUFFIX are automatically prepended and appended to the left prompt at the shell level, so all prompts (default, custom, and sample) pick them up without modification. SHELL_WELCOME is displayed after the greeting when an interactive shell starts. These variables provide a standard interface for tools like systemd's run0 to communicate session context to the shell. Fixes https://github.com/fish-shell/fish-shell/issues/10924 Closes #12570
50 lines
1.4 KiB
ReStructuredText
50 lines
1.4 KiB
ReStructuredText
fish_prompt - define the appearance of the command line prompt
|
|
==============================================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. synopsis::
|
|
|
|
fish_prompt
|
|
|
|
::
|
|
|
|
function fish_prompt
|
|
...
|
|
end
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
The ``fish_prompt`` function is executed when the prompt is to be shown, and the output is used as a prompt.
|
|
|
|
The exit status of commands within ``fish_prompt`` will not modify the value of :ref:`$status <variables-status>` outside of the ``fish_prompt`` function.
|
|
|
|
If :envvar:`fish_transient_prompt` is set to 1, ``fish_prompt --final-rendering`` is run before executing the commandline.
|
|
|
|
If :envvar:`SHELL_PROMPT_PREFIX` or :envvar:`SHELL_PROMPT_SUFFIX` are set, they are automatically prepended and appended to the left prompt. This applies to all prompts regardless of whether ``fish_prompt`` has been customized.
|
|
|
|
``fish`` ships with a number of example prompts that can be chosen with the ``fish_config`` command.
|
|
|
|
|
|
Example
|
|
-------
|
|
|
|
A simple prompt:
|
|
|
|
|
|
|
|
::
|
|
|
|
function fish_prompt -d "Write out the prompt"
|
|
# This shows up as USER@HOST /home/user/ >, with the directory colored
|
|
# $USER and $hostname are set by fish, so you can just use them
|
|
# instead of using `whoami` and `hostname`
|
|
printf '%s@%s %s%s%s > ' $USER $hostname \
|
|
(set_color $fish_color_cwd) (prompt_pwd) (set_color --reset)
|
|
end
|
|
|
|
|