Skip to content

Commit 2142202

Browse files
committed
added explanations on results expected for specific situations
1 parent 1a77e3c commit 2142202

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

jansi/src/main/java/org/fusesource/jansi/AnsiMain.java

+12-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,18 @@
3232
import static org.fusesource.jansi.internal.CLibrary.isatty;
3333

3434
/**
35-
* Main class for the library, providing executable jar to diagnose Jansi setup.
35+
* Main class for the library, providing executable jar to diagnose Jansi setup.
36+
* <p>If no system property is set and output is sent to a terminal (no redirect to a file):
37+
* <ul>
38+
* <li>any terminal on any Unix should get <code>RESET_ANSI_AT_CLOSE</code> mode,</li>
39+
* <li>on Windows, Git-bash or Cygwin terminals should get <code>RESET_ANSI_AT_CLOSE</code> mode also, since they
40+
* support natively ANSI escape sequences like any Unix terminal,</li>
41+
* <li>on Windows, cmd.exe, PowerShell or Git-cmd terminals should get <code>WINDOWS</code> mode.</li>
42+
* </ul>
43+
* The results will vary if you play with <code>jansi.passthrough</code>, <code>jansi.strip</code> or
44+
* <code>jansi.force</code> system property, or if you redirect output to a file.
45+
* <p>If you have a specific situation that is not covered, please report precise conditions to reproduce
46+
* the issue and ideas on how to detect precisely the affected situation.
3647
*/
3748
public class AnsiMain {
3849
public static void main(String... args) throws IOException {

0 commit comments

Comments
 (0)