1 files changed, 11 insertions, 1 deletions
diff --git a/src/libutil/terminal.hh b/src/libutil/terminal.hh
index 43df5bd70..2c422ecff 100644
--- a/src/libutil/terminal.hh
+++ b/src/libutil/terminal.hh
@@ -9,6 +9,15 @@ namespace nix {
 /**
  * Determine whether ANSI escape sequences are appropriate for the
  * present output.
+ *
+ * This follows the rules described on https://bixense.com/clicolors/
+ * with CLICOLOR defaulted to enabled (and thus ignored).
+ *
+ * That is to say, the following procedure is followed in order:
+ * - NO_COLOR or NOCOLOR set             -> always disable colour
+ * - CLICOLOR_FORCE or FORCE_COLOR set   -> enable colour
+ * - The output is a tty; TERM != "dumb" -> enable colour
+ * - Otherwise                           -> disable colour
  */
 bool shouldANSI();
 
@@ -21,7 +30,8 @@ bool shouldANSI();
  */
 std::string filterANSIEscapes(std::string_view s,
     bool filterAll = false,
-    unsigned int width = std::numeric_limits<unsigned int>::max());
+    unsigned int width = std::numeric_limits<unsigned int>::max(),
+    bool eatTabs = true);
 
 /**
  * Recalculate the window size, updating a global variable. Used in the