Move documentation on fish_prompt to the external command section

darcs-hash:20070324222135-ac50b-0b27258486492ea6178a852061dc894da60140ee.gz
This commit is contained in:
axel 2007-03-25 08:21:35 +10:00
parent 65d99117aa
commit e8ba091161
2 changed files with 23 additions and 22 deletions

23
doc_src/fish_prompt.txt Normal file
View file

@ -0,0 +1,23 @@
\section fish_prompt fish_prompt - define the apperance of the command line promp
\subsection fish_promt-synopsis Synopsis
<pre>function fish_prompt
...
end</pre>
\subsection fish_prompt-description Description
By defining the \c fish_prompt function, the user can choose a custom
prompt. The \c fish_prompt function is executed when the prompt is to
be shown, and the output is used as a prompt.
\subsection fish_prompt-example Example
A simple prompt:
<pre>
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
</pre>

View file

@ -1231,28 +1231,6 @@ Issuing <code>set fish_color_error black --background=red
--bold</code> will make all commandline errors be written in a black, --bold</code> will make all commandline errors be written in a black,
bold font, with a red background. bold font, with a red background.
\subsection prompt Programmable prompt
By defining the \c fish_prompt function, the user can choose a custom
prompt. The \c fish_prompt function is executed and the output is used
as a prompt.
Example:
<p>
The default \c fish prompt is
</p>
<p>
<pre>
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
</pre>
where \c prompt_pwd is a shellscript function that displays a condensed version of the current working directory.
</p>
\subsection title Programmable title \subsection title Programmable title
When using most virtual terminals, it is possible to set the message When using most virtual terminals, it is possible to set the message