Mercurial > 510Connectbot

comparison xml/510connectbot.in @ 463:6dff6933879c stable-1.9.3-4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fixup documentation
author Carl Byington <carl@five-ten-sg.com>
date Sun, 28 Apr 2019 18:23:49 -0700
parents f65d8bb11eb0
children 7c8aebcc882a
comparison
equal deleted inserted replaced
462:0f53523562bb 463:6dff6933879c
27 </para> 27 </para>
28 </partintro> 28 </partintro>
29 29
30 <refentry id="x@PACKAGE@.1"> 30 <refentry id="x@PACKAGE@.1">
31 <refentryinfo> 31 <refentryinfo>
32 <date>2015-04-09</date> 32 <date>2019-04-28</date>
33 <author> 33 <author>
34 <firstname>Carl</firstname> 34 <firstname>Carl</firstname>
35 <surname>Byington</surname> 35 <surname>Byington</surname>
36 <affiliation><orgname>510 Software Group</orgname></affiliation> 36 <affiliation><orgname>510 Software Group</orgname></affiliation>
37 </author> 37 </author>
169 </para> 169 </para>
170 170
171 <para> 171 <para>
172 The messages exchanged between the terminal emulator and the 172 The messages exchanged between the terminal emulator and the
173 terminal monitor are arrays of uint16 values in network byte 173 terminal monitor are arrays of uint16 values in network byte
174 order. Each message starts with a uint16 message byte length, 174 order. Each message starts with a uint16 message length,
175 followed by that many bytes of data. Note that the message length 175 followed by that many uint16 values.
176 will always be even. The next uint16 contains the message 176 The next uint16 contains the message
177 command value, and the remaining uint16 values are the arguments 177 command value, and the remaining uint16 values are the arguments
178 if any for that command. 178 if any for that command.
179 </para> 179 </para>
180 180
181 <para> 181 <para>
193 </para> 193 </para>
194 194
195 <para> 195 <para>
196 ACTIVATE = 1 (TE -> Monitor). The first argument is the 196 ACTIVATE = 1 (TE -> Monitor). The first argument is the
197 number of lines. The second argument is the number of columns. 197 number of lines. The second argument is the number of columns.
198 That is followed by lines*columns uint16 character codes. 198 That is followed by lines*columns uint16 character codes for
199 the current screen contents.
199 This connection is now the active connection. It is the 200 This connection is now the active connection. It is the
200 topmost (or only) window visible to the user - typed keystrokes 201 topmost (or only) window visible to the user - typed keystrokes
201 will be sent to the host on the other end of this connection. 202 will be sent to the host on the other end of this connection.
202 </para> 203 </para>
203 204
219 </para> 220 </para>
220 221
221 <para> 222 <para>
222 SCREENCHANGE = 4 (TE -> Monitor). The first argument is the 223 SCREENCHANGE = 4 (TE -> Monitor). The first argument is the
223 number of lines. The second argument is the number of columns. 224 number of lines. The second argument is the number of columns.
224 That is followed by lines*columns uint16 character codes. 225 That is followed by lines*columns uint16 character codes for
226 the current screen contents.
225 </para> 227 </para>
226 228
227 <para> 229 <para>
228 FIELDVALUE = 5 (TE -> Monitor). 230 FIELDVALUE = 5 (TE -> Monitor).
229 SETFIELD = 5 (Monitor -> TE). 231 SETFIELD = 5 (Monitor -> TE).
230 The first argument is the line number (0..23) 232 The first argument is the line number (0..23)
231 and the second argument is the column number (0..79). 233 and the second argument is the column number (0..79).
232 That is followed by the field value, a sequence of uint16 234 That is followed by the field value, a sequence of uint16
233 character codes from the screen buffer. The field 235 character codes from the screen buffer. The field
234 covers N columns, where N = (message length - 4) / 2. 236 covers N columns, where N = (message length - 4).
235 When sent from the monitor to the emulator, this causes 237 When sent from the monitor to the emulator, this causes
236 the emulator to send the field codes to the host. This is 238 the emulator to send the field codes to the host (for async
237 also used as the reply message from the emulator to the 239 modes) or to set the specified field contents (for block modes).
240 This is also used as the reply message from the emulator to the
238 monitor for a previous GETFIELD from the monitor. 241 monitor for a previous GETFIELD from the monitor.
239 </para> 242 </para>
240 243
241 <para> 244 <para>
242 GETFIELD = 6 (Monitor -> TE). 245 GETFIELD = 6 (Monitor -> TE).
253 and the second argument is the starting column number (0..79), 256 and the second argument is the starting column number (0..79),
254 and the third argument is the field length in columns. 257 and the third argument is the field length in columns.
255 This command causes the emulator to watch the specified 258 This command causes the emulator to watch the specified
256 part of the screen for changes. When that part of the screen 259 part of the screen for changes. When that part of the screen
257 changes, the emulator will send a SCREENCHANGE message back 260 changes, the emulator will send a SCREENCHANGE message back
258 to the monitor. 261 to the monitor. The initial screen watch area is the entire
262 screen.
259 </para> 263 </para>
260 264
261 <para> 265 <para>
262 DEPRESS = 8 (Monitor -> TE). The argument is a single uint16 266 DEPRESS = 8 (Monitor -> TE). The argument is a single uint16
263 value containing the vk_key value. This command causes the emulator 267 value containing the vk_key value. This command causes the emulator
280 should send a CURSORMOVE update to the monitor. Cursor movement caused 284 should send a CURSORMOVE update to the monitor. Cursor movement caused
281 by SETFIELD or DEPRESS commands does not trigger CURSORMOVE updates 285 by SETFIELD or DEPRESS commands does not trigger CURSORMOVE updates
282 in block mode (tn5250) sessions. Those commands do trigger CURSORMOVE 286 in block mode (tn5250) sessions. Those commands do trigger CURSORMOVE
283 updates in async mode (telnet, ssh) sessions. 287 updates in async mode (telnet, ssh) sessions.
284 </para> 288 </para>
289
290 <para>
291 SAYSTRING = 12 (TE -> Monitor). The first argument is nonzero if
292 any current speech should be flushed. The second argument is nonzero
293 if this speech should be synchronous. That is followed by uint16
294 character codes to be spoken.
295 </para>
285 </refsect1> 296 </refsect1>
286 297
287 <refsect1 id='todo.1'> 298 <refsect1 id='todo.1'>
288 <title>TODO</title> 299 <title>TODO</title>
289 <para> 300 <para>
293 </refsect1> 304 </refsect1>
294 305
295 <refsect1 id='copyright.1'> 306 <refsect1 id='copyright.1'>
296 <title>Copyright</title> 307 <title>Copyright</title>
297 <para> 308 <para>
298 Copyright (C) 2014 by 510 Software Group &lt;carl@five-ten-sg.com&gt; 309 Copyright (C) 2019 by 510 Software Group &lt;carl@five-ten-sg.com&gt;
299 </para> 310 </para>
300 <para> 311 <para>
301 This program is free software; you can redistribute it and/or modify it 312 This program is free software; you can redistribute it and/or modify it
302 under the terms of the GNU General Public License as published by the 313 under the terms of the GNU General Public License as published by the
303 Free Software Foundation; either version 3, or (at your option) any 314 Free Software Foundation; either version 3, or (at your option) any
318 </refsect1> 329 </refsect1>
319 </refentry> 330 </refentry>
320 331
321 <refentry id="x@PACKAGE@.5"> 332 <refentry id="x@PACKAGE@.5">
322 <refentryinfo> 333 <refentryinfo>
323 <date>2015-04-09</date> 334 <date>2019-04-28</date>
324 <author> 335 <author>
325 <firstname>Carl</firstname> 336 <firstname>Carl</firstname>
326 <surname>Byington</surname> 337 <surname>Byington</surname>
327 <affiliation><orgname>510 Software Group</orgname></affiliation> 338 <affiliation><orgname>510 Software Group</orgname></affiliation>
328 </author> 339 </author>