m/shell-scripting-templates
1
0
Fork 0
mirror of https://github.com/natelandau/shell-scripting-templates.git synced 2025-11-10 22:13:48 -05:00
Code Issues Packages Projects Releases Wiki Activity

Document alert variables

Browse Source
This commit is contained in:
Nathaniel Landau
2021-07-21 15:03:57 -04:00
parent b1df496e95
commit 8cf7057e4c
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -90,7 +90,7 @@ _sourceHelperFiles_
```
## alerts.bash
Basic alerting and setting colors functions (included in scriptTemplate.sh by default). Print messages to stdout and to a user specified logfile using the following functions.
Basic alerting, logging, and setting color functions (included in scriptTemplate.sh by default). Print messages to stdout and to a user specified logfile using the following functions.
```bash
debug "some text" # Printed only when in Verbose mode
@@ -103,6 +103,12 @@ success "some text" # Prints a success message
header "some text" # Prints a header element
```
Set the following variables for the alert functions to work.
* `$LOGFILE` - Location of a log file
* `$LOGLEVEL` - One of: FATAL, ERROR, WARN, INFO, DEBUG, ALL, OFF (Default is 'ERROR')
* `$QUIET` - If `true`, nothing will print to STDOUT (Logs files will still be populated)
## arrays.bash
Common functions for working with BASH arrays.