Merge pull request #409 from crownedgrouse/feature/colorize_kerl

Colorize kerl
kerl · Apr 27, 2022 · 7eab90e · 7eab90e
2 parents e9e888e + 963ba46
commit 7eab90e
Show file tree

Hide file tree

Showing 2 changed files with 196 additions and 137 deletions.
diff --git a/README.md b/README.md
@@ -205,6 +205,23 @@ Tuning
 
 You can tune kerl using the .kerlrc file in your $HOME directory.
 
+## Colors configuration
+
+### KERL_COLORIZE
+
+Default: 1 (Enabled)
+Enable VT100 colorizing if `tput` available (provided by `ncurses`). Set to 0 to disable.
+Colorization will be disabled anyway if necessary requirements are missing.
+
+Color for log levels can be overriden, by setting ANSI numerical color code to variables `KERL_COLOR_*` :
+
+- KERL_COLOR_E : (1=red) Error level color
+- KERL_COLOR_W : (3=yellow) Warning level color
+- KERL_COLOR_N : (4=blue) Notice level color
+- KERL_COLOR_T : (6=cyan) Tip level color
+- KERL_COLOR_S : (2=green) Success level color
+- KERL_COLOR_D : (9) Default Terminal color
+
 ## Locations on disk
 
 ### KERL_BASE_DIR