#18 move to event-driven main loop

[fanfix.git] / README.md

diff --git a/README.md b/README.md
index 6bf20a962e3e0046a4141b8472ecf0682702d712..7e4a0e509a4e48edf0758ad2b81cd890acf82f61 100644 (file)
--- a/README.md
+++ b/README.md
@@ -24,15 +24,15 @@ Jexer currently supports three backends:
   TCP socket.  jexer.demos.Demo3 demonstrates how one might use a
   character encoding than the default UTF-8.
 
-* Java Swing UI.  The default window size for Swing is 80x25, which is
-  set in jexer.session.SwingSession.  For the demo applications, this
-  is the default backend on Windows and Mac platforms.  This backend
-  can be explicitly selected for the demo applications by setting
-  jexer.Swing=true.
+* Java Swing UI.  The default window size for Swing is 80x25 and 20
+  point font; this can be changed in the TApplication(BackendType)
+  constructor.  For the demo applications, this is the default backend
+  on Windows and Mac platforms.  This backend can be explicitly
+  selected for the demo applications by setting jexer.Swing=true.
 
 Additional backends can be created by subclassing
 jexer.backend.Backend and passing it into the TApplication
-constructor.
+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
@@ -149,6 +149,13 @@ follows:
   * 'java -cp jexer.jar jexer.demos.Demo4' .  This demonstrates hidden
     windows and a custom TDesktop.
 
+  * 'java -cp jexer.jar jexer.demos.Demo5' .  This demonstrates two
+    demo applications using different fonts in the same Swing frame.
+
+  * 'java -cp jexer.jar jexer.demos.Demo6' .  This demonstrates one
+    application performing I/O to two screens: an xterm screen and a
+    Swing screen.
+
 
 
 More Screenshots
@@ -176,16 +183,17 @@ The following properties control features of Jexer:
   jexer.Swing.cursorStyle
   -----------------------
 
-  Used by jexer.io.SwingScreen.  Selects the cursor style to draw.
-  Valid values are: underline, block, outline.  Default: underline.
+  Used by jexer.backend.SwingTerminal.  Selects the cursor style to
+  draw.  Valid values are: underline, block, outline.  Default:
+  underline.
 
   jexer.Swing.tripleBuffer
   ------------------------
 
-  Used by jexer.io.SwingScreen.  If true, use triple-buffering which
-  reduces screen tearing but may also be slower to draw on slower
-  systems.  If false, use naive Swing thread drawing, which may be
-  faster on slower systems but also more likely to have screen
+  Used by jexer.backend.SwingTerminal.  If true, use triple-buffering
+  which reduces screen tearing but may also be slower to draw on
+  slower systems.  If false, use naive Swing thread drawing, which may
+  be faster on slower systems but also more likely to have screen
   tearing.  Default: true.
 
 
@@ -214,6 +222,11 @@ ambiguous.  This section describes such issues.
   - Closing a TTerminalWindow without exiting the process inside it
     may result in a zombie 'script' process.
 
+  - TTerminalWindow cannot notify the child process of changes in
+    window size, due to Java's lack of support for forkpty() and
+    similar.  Solving this requires C, and will be pursued only if
+    sufficient user requests come in.
+
   - Java's InputStreamReader as used by the ECMA48 backend requires a
     valid UTF-8 stream.  The default X10 encoding for mouse
     coordinates outside (160,94) can corrupt that stream, at best
@@ -228,9 +241,9 @@ ambiguous.  This section describes such issues.
     check the current window size, performing the same function as
     ioctl(TIOCGWINSZ) but without requiring a native library.
 
-  - jexer.io.ECMA48Terminal calls 'stty' to perform the equivalent of
-    cfmakeraw() when using System.in/out.  System.out is also
-    (blindly!) put in 'stty sane cooked' mode when exiting.
+  - jexer.backend.ECMA48Terminal calls 'stty' to perform the
+    equivalent of cfmakeraw() when using System.in/out.  System.out is
+    also (blindly!) put in 'stty sane cooked' mode when exiting.