Prep for 2019 release
[fanfix.git] / README.md
index dc976599bf6cffeb4d37a2d48a3d0bc0932d5d77..009ec6f99a5dfa9b23b530df024ec592e8e1da6a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,8 +14,8 @@ Jexer currently supports three backends:
 * System.in/out to a command-line ECMA-48 / ANSI X3.64 type terminal
   (tested on Linux + xterm).  I/O is handled through terminal escape
   sequences generated by the library itself: ncurses is not required
-  or linked to.  xterm mouse tracking using UTF8 and SGR coordinates
-  are supported.  For the demo application, this is the default
+  or linked to.  xterm mouse tracking is supported using both UTF8 and
+  SGR coordinates.  For the demo application, this is the default
   backend on non-Windows/non-Mac platforms.
 
 * The same command-line ECMA-48 / ANSI X3.64 type terminal as above,
@@ -36,7 +36,7 @@ constructor.  See Demo5 and Demo6 for examples of other backends.
 
 The Jexer homepage, which includes additional information and binary
 release downloads, is at: https://jexer.sourceforge.io .  The Jexer
-source code is hosted at: https://github.com/klamonte/jexer .
+source code is hosted at: https://gitlab.com/klamonte/jexer .
 
 
 
@@ -203,7 +203,14 @@ The following properties control features of Jexer:
   Used by jexer.TTerminalWindow.  If true, spawn shell using the
   'ptypipe' utility rather than 'script'.  This permits terminals to
   resize with the window.  ptypipe is a separate C language utility,
-  available at https://github.com/klamonte/ptypipe.  Default: false.
+  available at https://gitlab.com/klamonte/ptypipe.  Default: false.
+
+  jexer.ECMA48.rgbColor
+  ---------------------
+
+  Used by jexer.backend.ECMA48Terminal.  If true, emit T.416-style RGB
+  colors for normal system colors.  This is expensive in bandwidth,
+  and potentially terrible looking for non-xterms.  Default: false.
 
 
 
@@ -234,7 +241,7 @@ ambiguous.  This section describes such issues.
   - TTerminalWindow can only notify the child process of changes in
     window size if using the 'ptypipe' utility, due to Java's lack of
     support for forkpty() and similar.  ptypipe is available at
-    https://github.com/klamonte/ptypipe.
+    https://gitlab.com/klamonte/ptypipe.
 
   - Java's InputStreamReader as used by the ECMA48 backend requires a
     valid UTF-8 stream.  The default X10 encoding for mouse