From d282bc462578a6e47747c78d2d42883530f0d11e Mon Sep 17 00:00:00 2001 From: Mark Griffiths Date: Fri, 1 Aug 2014 03:37:32 +0100 Subject: 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. --- doc_src/fish_prompt.txt | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) (limited to 'doc_src/fish_prompt.txt') diff --git a/doc_src/fish_prompt.txt b/doc_src/fish_prompt.txt index 5cf5abf9..cecc338d 100644 --- a/doc_src/fish_prompt.txt +++ b/doc_src/fish_prompt.txt @@ -1,28 +1,31 @@ \section fish_prompt fish_prompt - define the appearance of the command line prompt \subsection fish_prompt-synopsis Synopsis -
function fish_prompt
+\fish{syn}
+function fish_prompt
     ...
-end
+end +\endfish + \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 +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 \c fish_prompt will not modify the value of $status outside of the \c fish_prompt function. +The exit status of commands within `fish_prompt` will not modify the value of $status outside of the `fish_prompt` function. -\c fish ships with a number of example prompts that can be chosen with the -\c fish_config command. +`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)
+    printf '%s@%s%s%s%s> ' (whoami) (hostname|cut -d . -f 1) (set_color $fish_color_cwd) (prompt_pwd) (set_color normal)
 end
-
+\endfish -- cgit v1.2.3