# HG changeset patch
# User Carl Byington <carl@five-ten-sg.com>
# Date 1430508685 25200
# Node ID 3975d341e3dd5995f5233515b0753e576cba3413
# Parent  4f1cc4f44c41b4f3e68b9e82659e82d73b6c2183
document synchronization issues

diff -r 4f1cc4f44c41 -r 3975d341e3dd xml/510connectbotmonitor.in
--- a/xml/510connectbotmonitor.in	Fri May 01 12:00:38 2015 -0700
+++ b/xml/510connectbotmonitor.in	Fri May 01 12:31:25 2015 -0700
@@ -19,7 +19,7 @@
 
     <refentry id="x@PACKAGE@.1">
         <refentryinfo>
-            <date>2014-07-01</date>
+            <date>2015-05-01</date>
             <author>
                 <firstname>Carl</firstname>
                 <surname>Byington</surname>
@@ -101,7 +101,8 @@
             <para>
                 ACTIVATE = 1 (TE -> Monitor).  The first argument is the
                 number of lines. The second argument is the number of columns.
-                That is followed by lines*columns uint16 character codes.
+                That is followed by lines*columns uint16 character codes for
+                the current screen contents.
                 This connection is now the active connection. It is the
                 topmost (or only) window visible to the user - typed keystrokes
                 will be sent to the host on the other end of this connection.
@@ -111,7 +112,7 @@
                 KEYSTATE = 2 (TE -> Monitor). The argument is a single uint16
                 value, 1 for key down, 0 for key up. The TE tracks a single special
                 key for the monitor, and reports key up/down state when it changes.
-                The actual key is configurable.
+                The actual key should be configurable.
             </para>
 
             <para>
@@ -127,7 +128,8 @@
             <para>
                 SCREENCHANGE = 4 (TE -> Monitor). The first argument is the
                 number of lines. The second argument is the number of columns.
-                That is followed by lines*columns uint16 character codes.
+                That is followed by lines*columns uint16 character codes for
+                the current screen contents.
             </para>
 
             <para>
@@ -162,7 +164,8 @@
                 This command causes the emulator to watch the specified
                 part of the screen for changes. When that part of the screen
                 changes, the emulator will send a SCREENCHANGE message back
-                to the monitor.
+                to the monitor. The initial screen watch area is the entire
+                screen.
             </para>
 
             <para>
@@ -191,6 +194,19 @@
             </para>
         </refsect1>
 
+        <refsect1 id='synchronization.1'>
+            <title>Synchronization issues</title>
+            <para>
+                The terminal emulator should delay sending CURSORMOVE and SCREENCHANGE
+                messages until the socket has been quiet for 10 milliseconds or until
+                the 5250 block mode terminal keyboard has been unlocked by the host.
+                The monitor might send SETFIELD or DEPRESS messages in response to
+                those CURSORMOVE or SCREENCHANGE messages. If the 5250 block mode
+                keyboard is locked, the terminal emulator should buffer those keystrokes
+                and send them when the keyboard unlocks.
+            </para>
+        </refsect1>
+
         <refsect1 id='todo.1'>
             <title>TODO</title>
             <para>