From e8ba091161277b397221c782b729f8d97b187de7 Mon Sep 17 00:00:00 2001 From: axel Date: Sun, 25 Mar 2007 08:21:35 +1000 Subject: [PATCH] Move documentation on fish_prompt to the external command section darcs-hash:20070324222135-ac50b-0b27258486492ea6178a852061dc894da60140ee.gz --- doc_src/fish_prompt.txt | 23 +++++++++++++++++++++++ doc_src/index.hdr.in | 22 ---------------------- 2 files changed, 23 insertions(+), 22 deletions(-) create mode 100644 doc_src/fish_prompt.txt diff --git a/doc_src/fish_prompt.txt b/doc_src/fish_prompt.txt new file mode 100644 index 000000000..dda80913a --- /dev/null +++ b/doc_src/fish_prompt.txt @@ -0,0 +1,23 @@ +\section fish_prompt fish_prompt - define the apperance of the command line promp + +\subsection fish_promt-synopsis Synopsis +
function fish_prompt
+    ...
+end
+ +\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: + +
+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
+
+ diff --git a/doc_src/index.hdr.in b/doc_src/index.hdr.in index 1d6797bcb..e43be6747 100644 --- a/doc_src/index.hdr.in +++ b/doc_src/index.hdr.in @@ -1231,28 +1231,6 @@ Issuing set fish_color_error black --background=red --bold will make all commandline errors be written in a black, 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: -

-The default \c fish prompt is -

-

-

-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
-
- -where \c prompt_pwd is a shellscript function that displays a condensed version of the current working directory. - -

- - \subsection title Programmable title When using most virtual terminals, it is possible to set the message