Next: Utilities, Previous: Configuration Files, Up: BashStyle-NG Documentation  

21 Prompt Hooks ¶

Some of the supplied prompt styles of BashStyle-NG allow hooking into them, meaning you can define a function that will be automatically called from the prompt.

This allows you to add custom content to existing styles, without having to use the custom prompt builder or start from scratch. You need to place the desired hook in the file:

$HOME/.bashstyle.custom

The following lists the prompt style, name of the hook and where it takes effect:

separator style

• SEPA_1() | at the start of the prompt
• SEPA_2() | at the end of the prompt

vector style

• VECTOR_1() | after time/date entry
• VECTOR_2() | at the end of the prompt

clock style

• CLOCK() | at the end of the prompt

equinox style

• EQUINOX_1() | before the user symbol

elite style

• ELITE_1() | at the end of the prompt

poweruser style

• POWER_1() | before the user symbol

dirks style

• DIRKS_1() | at the end of the first line
• DIRKS_2() | at the end of the prompt

sepa-ng style

• SEPA_NG_1() | at the end of the prompt

quirk style

• QUIRK_1() | at the end of the prompt

Additonally each hook-part features a color variable with the same naming scheme, eg.:

• SEPA_1() is colored by $SEPA_1_COLOR
• VECTOR_2() is colored by $VECTOR_2_COLOR

You can use one of the following predefined color names:

• black
• red
• green
• yellow
• blue
• magenta
• cyan
• grey
• white
• coldblue
• smoothblue
• iceblue
• turqoise
• smoothgreen
• winered
• brown
• silver
• ocher
• orange
• purple
• pink
• cream

If you want to use theese predefinied colors not in the variable, but in the function, you can access printable versions by prepending e to the color name, eg.:

• black -> eblack
• white -> ewhite

Note: if the terminal is set to dark (in the Style settings), then black becomes white, else white becomes black, that’s not a bug, but a feature.

Here’s an example that hooks into the sepa-ng prompt, we use gitkit o show branch, revision (like svn revision) and current action in repository in yellow:

SEPA_NG_1_COLOR=$yellow
SEPA_NG_1 () {
    echo -e " $(gitkit branch):$(gitkit revno):$(gitkit action) "
}