Library file | Function | Sections | Content | help file |
---|---|---|---|---|
bmtPrompt | bmtPromptFunc | 201-210 | Prompts | bmtPrompt.md |
Section Two, Prompts
- 201 Horizontal lines across terminal, in any colour
- 202 yes-no-quit [y/n/q] loop prompt
- 203 yes-NO [y/N] prompt
- 204 YES-no [Y/n] prompt
- 205 Anykey to continue prompt, in any colour
- 206 quit-NO [q/N] prompt
- 207 QUIT-no [Q/N] prompt
- 208 Wish to continue loop prompt
- 209 Print centered text
- 210 Print event status
Sub-Sections
- Horizontal lines across terminal of single character
Keyword is line, first option the character, second option is colour, if no colour passed default is "bold cyan"
bmtPromptFunc line "="
bmtPromptFunc line "8" red
- yes-no-quit prompt y/n/q
Keyword is yesnoquit , returns codes based on user input
echo "Do you want to foo? [y/n/q] :"
bmtPromptFunc yesnoquit
Returns 0 for yes , 2 for no , 3 for quit
- Yes-no prompt [y/N] where no is default
Keyword is yesno , returns codes based on user input second option yes
echo "Do you want to foo? [y/N] :"
bmtPromptFunc yesno yes
Returns 0 for yes , 2 for no , 50 for bad user option
- Yes-no prompt [Y/n] where yes is default
Keyword is yesno , returns codes based on user input second option is no
echo "Do you want to foo? [Y/n] :"
bmtPromptFunc yesno no
Returns 0 for no , 2 for yes , 50 for bad user option
- Anykey prompt
Keyword is anykey , first option amended text, second option is colour, if no colour passed default is "bold cyan"
bmtPromptFunc anykey "my Text here"
bmtPromptFunc anykey "my Text here" u_red
- QUIT-no prompt [q/N] where quit is default
Keyword is quitno , returns codes based on user input second option quit
echo "Do you want to foo? [q/N] :"
bmtPromptFunc quitno quit
Returns 0 for quit , 2 for no , 50 for bad user option
- quit-NO prompt [Q/n] where no is default
Keyword is quitno , returns codes based on user input second option no
echo "Do you want to foo? [Q/n] :"
bmtPromptFunc quitno no
Returns 0 for no , 2 for quit , 50 for bad user option
- Wish to continue loop prompt Exits program if user presses N , continues if user presses yes. Param1 Message Custom. Param2 is colour, if no colour passed default is "bold cyan"
bmtPromptFunc wishtocontinue "Do you wish to contine?"
- Print centred text in terminal
bmtPromptFunc centertext "Hello World."
- Print an event status , Installing bashMultiTool ...... [OK]
- Param 1 text on left
- Param 2 text on right
- Param 3 colour , if no colour passed default is "bold cyan"
bmtPromptFunc eventstatus "Installing bashMultiTool" "OK"