User Interface#
Bash functions for interacting with users on the command line.
Info
You can hush the print functions (print-*) through the ES_PRINT_HUSH environment variable. If this variable is set (to any value other than an empty string) nothing will be echoed on terminal. This is useful for creating quiet/verbose scripts as printing can be easily switched on or off.
Format codes#
Color and format codes used by echo. These codes are exported as environment variables, making them available for any other script or function. Codes can be combined.
Font colors:
TXT_BLACK Black
TXT_RED Red
TXT_GREEN Green
TXT_YELLOW Yellow
TXT_BLUE Blue
TXT_PURPLE Magenta
Background colors:
BACK_YELLOW Yellow
BACK_BLUE Blue
Other:
TXT_BOLD Bold fonts
TXT_NORM Clear all formatting.
Useful after formatted text, so next echo prints unformatted chars.
Usage
echo -e "${TXT_BOLD}${TXT_YELLOW}I'm in bold yellow${TXT_NORM} This is unformatted text"
cls#
Clear console screen. You can't even scroll up after this.
Usage
cls
confirm#
Ask for confirmation. If reply is y or Y return with exit code "0" otherwise non-zero. You can configure the prompt, but the default 'Are you sure?' should suffice for most situations. 
Usage
confirm [PROMPT]
Params:
PROMPT Question prompt. Defaults to "Are you sure? (y/n) "
print-error#
Print error message to stderr. Red, bold.
Usage
print-error MESSAGE
Params:
MESSAGE Error message
print-finish#
Print OK message in green with bold letters.
Usage
print-finish [MESSAGE]
Params:
MESSAGE Message to print, default: "Done."
print-header#
Print header: text with yellow font-color on its own line.
Usage
print-header HEADER
Params:
HEADER Header text
print-run-time#
Print running time of script in a nice summary format. Seconds converted to hours, mins e.g. 3665 seconds => 1 hour(s) 1 min(s) 5 second(s). Could be useful for long-running overnight scripts.
Usage
print-run-time
print-section#
Print section header: blue background and white letters followed by a line of ~ chars as wide as the header.
Usage
print-section HEADER
Params:
HEADER Header text
print-status#
Print yellow status message. No new line is printed after that so next echo continues on same line!
Usage
print-status MESSAGE
Params:
MESSAGE Status message
print-title#
Print title: blue background and white letters followed by a line of ~ chars. Title is centered add padded with whitespace to 80 characters wide so the whole title line is highlighted in blue.
Usage
print-title TITLE
Params:
TITLE Title text
print-warning#
Print warning message to stderr with yellow background.
Usage
print-warning [MESSAGE]
Params:
MESSAGE Warning message