aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/fish_prompt.txt
blob: 1beb5304e4e2bde19aee22f6b8e8d53958b7a182 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
\section fish_prompt fish_prompt - define the appearance of the command line prompt

\subsection fish_prompt-synopsis Synopsis
\fish{synopsis}
function fish_prompt
    ...
end
\endfish

\subsection fish_prompt-description Description

By defining the `fish_prompt` function, the user can choose a custom prompt. 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 <a href="index.html#variables-status">$status</a> outside of the `fish_prompt` function.

`fish` ships with a number of example prompts that can be chosen with the `fish_config` command.


\subsection fish_prompt-example Example

A simple prompt:

\fish
function fish_prompt -d "Write out the prompt"
    printf '%s@%s%s%s%s> ' (whoami) (hostname | cut -d . -f 1) \
    		(set_color $fish_color_cwd) (prompt_pwd) (set_color normal)
end
\endfish