changeset 463:6dff6933879c stable-1.9.3-4

fixup documentation
author Carl Byington <carl@five-ten-sg.com>
date Sun, 28 Apr 2019 18:23:49 -0700
parents 0f53523562bb
children 3ebfae9bc0bd
files xml/510connectbot.in
diffstat 1 files changed, 23 insertions(+), 12 deletions(-) [+]
line wrap: on
line diff
--- a/xml/510connectbot.in	Sun Apr 28 17:46:13 2019 -0700
+++ b/xml/510connectbot.in	Sun Apr 28 18:23:49 2019 -0700
@@ -29,7 +29,7 @@
 
     <refentry id="x@PACKAGE@.1">
         <refentryinfo>
-            <date>2015-04-09</date>
+            <date>2019-04-28</date>
             <author>
                 <firstname>Carl</firstname>
                 <surname>Byington</surname>
@@ -171,9 +171,9 @@
             <para>
                 The messages exchanged between the terminal emulator and the
                 terminal monitor are arrays of uint16 values in network byte
-                order. Each message starts with a uint16 message byte length,
-                followed by that many bytes of data. Note that the message length
-                will always be even. The next uint16 contains the message
+                order. Each message starts with a uint16 message length,
+                followed by that many uint16 values.
+                The next uint16 contains the message
                 command value, and the remaining uint16 values are the arguments
                 if any for that command.
             </para>
@@ -195,7 +195,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.
@@ -221,7 +222,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>
@@ -231,10 +233,11 @@
                 and the second argument is the column number (0..79).
                 That is followed by the field value, a sequence of uint16
                 character codes from the screen buffer. The field
-                covers N columns, where N = (message length - 4) / 2.
+                covers N columns, where N = (message length - 4).
                 When sent from the monitor to the emulator, this causes
-                the emulator to send the field codes to the host. This is
-                also used as the reply message from the emulator to the
+                the emulator to send the field codes to the host (for async
+                modes) or to set the specified field contents (for block modes).
+                This is also used as the reply message from the emulator to the
                 monitor for a previous GETFIELD from the monitor.
             </para>
 
@@ -255,7 +258,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>
@@ -282,6 +286,13 @@
                 in block mode (tn5250) sessions. Those commands do trigger CURSORMOVE
                 updates in async mode (telnet, ssh) sessions.
             </para>
+
+            <para>
+                SAYSTRING = 12 (TE -> Monitor). The first argument is nonzero if
+                any current speech should be flushed. The second argument is nonzero
+                if this speech should be synchronous. That is followed by uint16
+                character codes to be spoken.
+            </para>
         </refsect1>
 
         <refsect1 id='todo.1'>
@@ -295,7 +306,7 @@
         <refsect1 id='copyright.1'>
             <title>Copyright</title>
             <para>
-                Copyright (C) 2014 by 510 Software Group &lt;carl@five-ten-sg.com&gt;
+                Copyright (C) 2019 by 510 Software Group &lt;carl@five-ten-sg.com&gt;
             </para>
             <para>
                 This program is free software; you can redistribute it and/or modify it
@@ -320,7 +331,7 @@
 
     <refentry id="x@PACKAGE@.5">
         <refentryinfo>
-            <date>2015-04-09</date>
+            <date>2019-04-28</date>
             <author>
                 <firstname>Carl</firstname>
                 <surname>Byington</surname>