From 21422020a424d229db83f4d32fa77c55dc51a352 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Herv=C3=A9=20Boutemy?= <hboutemy@apache.org>
Date: Sat, 14 Apr 2018 18:28:20 +0200
Subject: [PATCH] added explanations on results expected for specific
 situations

---
 .../main/java/org/fusesource/jansi/AnsiMain.java    | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/jansi/src/main/java/org/fusesource/jansi/AnsiMain.java b/jansi/src/main/java/org/fusesource/jansi/AnsiMain.java
index 04239344..7edc15f4 100644
--- a/jansi/src/main/java/org/fusesource/jansi/AnsiMain.java
+++ b/jansi/src/main/java/org/fusesource/jansi/AnsiMain.java
@@ -32,7 +32,18 @@
 import static org.fusesource.jansi.internal.CLibrary.isatty;
 
 /**
- * Main class for the library, providing executable jar to diagnose Jansi setup. 
+ * Main class for the library, providing executable jar to diagnose Jansi setup.
+ * <p>If no system property is set and output is sent to a terminal (no redirect to a file):
+ * <ul>
+ * <li>any terminal on any Unix should get <code>RESET_ANSI_AT_CLOSE</code> mode,</li>
+ * <li>on Windows, Git-bash or Cygwin terminals should get <code>RESET_ANSI_AT_CLOSE</code> mode also, since they
+ * support natively ANSI escape sequences like any Unix terminal,</li>
+ * <li>on Windows, cmd.exe, PowerShell or Git-cmd terminals should get <code>WINDOWS</code> mode.</li>
+ * </ul>
+ * The results will vary if you play with <code>jansi.passthrough</code>, <code>jansi.strip</code> or
+ * <code>jansi.force</code> system property, or if you redirect output to a file.
+ * <p>If you have a specific situation that is not covered, please report precise conditions to reproduce
+ * the issue and ideas on how to detect precisely the affected situation.
  */
 public class AnsiMain {
     public static void main(String... args) throws IOException {