9edbbafb02a56d3be90e7dd0e88a3004b62774a1
[config/bash_prompt.git] / README
1 bash_prompt is a collection of custom bash prompts to be loaded using the
2 provided `set_prompt` function.
3
4 Example of use, with bash_prompt under ~/.bash/:
5
6   # load git prompt support
7   [ -f /usr/lib/git-core/git-sh-prompt ] && . /usr/lib/git-core/git-sh-prompt
8
9   # load function to set custom shell prompts
10   [ -f ~/.bash/bash_prompt/set_prompt ] && . ~/.bash/bash_prompt/set_prompt
11
12   # set a different prompt for the root user
13   if [ $UID -eq 0 ];
14   then
15     set_prompt fire
16   else
17     set_prompt iceg
18   fi
19
20 The prompts can contain backslash-escaped special characters as specified in
21 the bash(1) man page, or any ANSI escape sequences as described in the
22 console_codes(4) man page.
23
24 The `set_prompt` function provides symbolic constant for the most used escape
25 sequences, see the source code for the details.
26
27 Inspired by bashish: http://bashish.sourceforge.net/