fish-shell/doc_src/fish_prompt.txt

\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
Typos 2013-04-14 05:17:19 +08:00			`\section fish_prompt fish_prompt - define the appearance of the command line prompt`
Move documentation on fish_prompt to the external command section darcs-hash:20070324222135-ac50b-0b27258486492ea6178a852061dc894da60140ee.gz 2007-03-25 06:21:35 +08:00
Support for fish_right_prompt Fixes https://github.com/fish-shell/fish-shell/issues/80 2012-11-08 11:59:20 +08:00			`\subsection fish_prompt-synopsis Synopsis`
Simplify styling 2014-08-01 20:25:41 +08:00			`\fish{synopsis}`
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			`function fish_prompt`
Move documentation on fish_prompt to the external command section darcs-hash:20070324222135-ac50b-0b27258486492ea6178a852061dc894da60140ee.gz 2007-03-25 06:21:35 +08:00			`...`
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			`end`
			`\endfish`

Move documentation on fish_prompt to the external command section darcs-hash:20070324222135-ac50b-0b27258486492ea6178a852061dc894da60140ee.gz 2007-03-25 06:21:35 +08:00			`\subsection fish_prompt-description Description`

Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00			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.
Move documentation on fish_prompt to the external command section darcs-hash:20070324222135-ac50b-0b27258486492ea6178a852061dc894da60140ee.gz 2007-03-25 06:21:35 +08:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			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.
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 15:56:01 +08:00
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00			`fish` ships with a number of example prompts that can be chosen with the `fish_config` command.

Added small note to the fish_prompt doc 2012-07-11 01:11:21 +08:00
Move documentation on fish_prompt to the external command section darcs-hash:20070324222135-ac50b-0b27258486492ea6178a852061dc894da60140ee.gz 2007-03-25 06:21:35 +08:00			`\subsection fish_prompt-example Example`

			`A simple prompt:`

Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			`\fish`
Move documentation on fish_prompt to the external command section darcs-hash:20070324222135-ac50b-0b27258486492ea6178a852061dc894da60140ee.gz 2007-03-25 06:21:35 +08:00			`function fish_prompt -d "Write out the prompt"`
Tutorial auto colouring, Man page and Make fixes Completely fixes #1557 and the underlying Doxygen changes that caused it. Should make fish docs simpler and more robust, more consistent and generally prettier. todo: - trap unmarked text as arguments in context - test & fix sed portability - see in particular. (so far tested on BSD (Mac) and GNU sed). - test Makefile changes - last round of aesthetic changes and getting that ascii fish in there… 2014-08-08 10:44:37 +08:00			`printf '%s@%s%s%s%s> ' (whoami) (hostname \| cut -d . -f 1) \`
			`(set_color $fish_color_cwd) (prompt_pwd) (set_color normal)`
Move documentation on fish_prompt to the external command section darcs-hash:20070324222135-ac50b-0b27258486492ea6178a852061dc894da60140ee.gz 2007-03-25 06:21:35 +08:00			`end`
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			`\endfish`
Move documentation on fish_prompt to the external command section darcs-hash:20070324222135-ac50b-0b27258486492ea6178a852061dc894da60140ee.gz 2007-03-25 06:21:35 +08:00