annotate xml/510connectbotmonitor.in @ 25:3975d341e3dd stable-1.0.4-0

document synchronization issues
author Carl Byington <carl@five-ten-sg.com>
date Fri, 01 May 2015 12:31:25 -0700
parents 2586a4f5c8c3
children 0bc0b4798d9e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1 <reference>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
2 <title>@PACKAGE@ - Version @VERSION@</title>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
3 <partintro>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
4 <title>Packages</title>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
5
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
6 <para>The various source and binary packages are available at <ulink
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
7 url="http://www.five-ten-sg.com/@PACKAGE@/packages/">http://www.five-ten-sg.com/@PACKAGE@/packages/</ulink>.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
8 The most recent documentation is available at <ulink
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
9 url="http://www.five-ten-sg.com/@PACKAGE@/">http://www.five-ten-sg.com/@PACKAGE@/</ulink>.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
10 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
11
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
12 <para>A <ulink
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
13 url="http://www.selenic.com/mercurial/wiki/">Mercurial</ulink> source
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
14 code repository for this project is available at <ulink
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
15 url="http://hg.five-ten-sg.com/@PACKAGE@/">http://hg.five-ten-sg.com/@PACKAGE@/</ulink>.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
16 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
17
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
18 </partintro>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
19
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
20 <refentry id="x@PACKAGE@.1">
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
21 <refentryinfo>
25
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
22 <date>2015-05-01</date>
1
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
23 <author>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
24 <firstname>Carl</firstname>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
25 <surname>Byington</surname>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
26 <affiliation><orgname>510 Software Group</orgname></affiliation>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
27 </author>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
28 </refentryinfo>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
29
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
30 <refmeta>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
31 <refentrytitle>@PACKAGE@</refentrytitle>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
32 <manvolnum>1</manvolnum>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
33 <refmiscinfo>@PACKAGE@ @VERSION@</refmiscinfo>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
34 </refmeta>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
35
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
36 <refnamediv id='name.1'>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
37 <refname>@PACKAGE@</refname>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
38 <refpurpose>a monitoring package for the android terminal emulator</refpurpose>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
39 </refnamediv>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
40
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
41 <refsect1 id='build.1'>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
42 <title>Build method</title>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
43 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
44 This is an android project with no native code, so
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
45 "android update project -p . -t android-16; ant debug"
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
46 should build cleanly.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
47 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
48 </refsect1>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
49
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
50 <refsect1 id='introduction.1'>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
51 <title>Introduction</title>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
52 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
53 This is a stub monitoring application for the related
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
54 510 Connectbot android terminal emulator package.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
55 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
56 </refsect1>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
57
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
58 <refsect1 id='monitor.1'>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
59 <title>Terminal Monitor</title>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
60 <para>
2
f6a1aabf384f add copyright
Carl Byington <carl@five-ten-sg.com>
parents: 1
diff changeset
61 For every terminal session (local, telnet, ssh or tn5250), the
1
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
62 terminal emulator also makes a connection to a terminal monitor
2
f6a1aabf384f add copyright
Carl Byington <carl@five-ten-sg.com>
parents: 1
diff changeset
63 process, which can see cursor movement and screen contents, and can
1
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
64 inject characters to send to the host.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
65 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
66
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
67 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
68 The terminal monitor is invoked by calling an android Intent
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
69 named "com.five_ten_sg.connectbot.monitor.MonitorService". That
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
70 ensures that the monitor process is running, and should then
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
71 be listening on TCP port 6000 for incoming connections. The terminal
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
72 emulator then connects to the terminal monitor on port 6000.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
73 The native android Intent and Service communication mechanisms
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
74 are not used.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
75 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
76
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
77 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
78 The messages exchanged between the terminal emulator and the
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
79 terminal monitor are arrays of uint16 values in network byte
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
80 order. Each message starts with a uint16 message byte length,
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
81 followed by that many bytes of data. Note that the message length
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
82 will always be even. The next uint16 contains the message
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
83 command value, and the remaining uint16 values are the arguments
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
84 if any for that command.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
85 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
86
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
87 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
88 Any arguments that are keystrokes or characters are represented
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
89 as 16 bit unicode. Note that the first 256 such characters are
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
90 identical to the ISO-8859-1 latin character set.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
91 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
92
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
93 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
94 INIT = 0 (TE -> Monitor). The argument is a string of uint16
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
95 characters. The meaning of these characters is defined by the
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
96 monitor. It might be a fully qualified path name, or some other
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
97 data used by the monitor to drive the monitoring of this
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
98 connection.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
99 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
100
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
101 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
102 ACTIVATE = 1 (TE -> Monitor). The first argument is the
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
103 number of lines. The second argument is the number of columns.
25
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
104 That is followed by lines*columns uint16 character codes for
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
105 the current screen contents.
1
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
106 This connection is now the active connection. It is the
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
107 topmost (or only) window visible to the user - typed keystrokes
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
108 will be sent to the host on the other end of this connection.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
109 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
110
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
111 <para>
2
f6a1aabf384f add copyright
Carl Byington <carl@five-ten-sg.com>
parents: 1
diff changeset
112 KEYSTATE = 2 (TE -> Monitor). The argument is a single uint16
f6a1aabf384f add copyright
Carl Byington <carl@five-ten-sg.com>
parents: 1
diff changeset
113 value, 1 for key down, 0 for key up. The TE tracks a single special
f6a1aabf384f add copyright
Carl Byington <carl@five-ten-sg.com>
parents: 1
diff changeset
114 key for the monitor, and reports key up/down state when it changes.
25
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
115 The actual key should be configurable.
1
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
116 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
117
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
118 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
119 CURSORMOVE = 3 (TE -> Monitor).
23
2586a4f5c8c3 add mechanism to allow getfield from other threads
Carl Byington <carl@five-ten-sg.com>
parents: 18
diff changeset
120 The first argument is the line number (0..23),
2586a4f5c8c3 add mechanism to allow getfield from other threads
Carl Byington <carl@five-ten-sg.com>
parents: 18
diff changeset
121 the second argument is the column number (0..79), and the third
2586a4f5c8c3 add mechanism to allow getfield from other threads
Carl Byington <carl@five-ten-sg.com>
parents: 18
diff changeset
122 argument is the reason for sending this cursor update. REASON=0 is
2586a4f5c8c3 add mechanism to allow getfield from other threads
Carl Byington <carl@five-ten-sg.com>
parents: 18
diff changeset
123 from a previous CURSORREQUEST command. REASON=1 is a cursor update
2586a4f5c8c3 add mechanism to allow getfield from other threads
Carl Byington <carl@five-ten-sg.com>
parents: 18
diff changeset
124 related to the previous SCREENCHANGE buffer update. REASON=2 is
2586a4f5c8c3 add mechanism to allow getfield from other threads
Carl Byington <carl@five-ten-sg.com>
parents: 18
diff changeset
125 a cursor update caused by user keystrokes.
1
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
126 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
127
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
128 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
129 SCREENCHANGE = 4 (TE -> Monitor). The first argument is the
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
130 number of lines. The second argument is the number of columns.
25
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
131 That is followed by lines*columns uint16 character codes for
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
132 the current screen contents.
1
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
133 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
134
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
135 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
136 FIELDVALUE = 5 (TE -> Monitor).
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
137 SETFIELD = 5 (Monitor -> TE).
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
138 The first argument is the line number (0..23)
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
139 and the second argument is the column number (0..79).
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
140 That is followed by the field value, a sequence of uint16
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
141 character codes from the screen buffer. The field
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
142 covers N columns, where N = (message length - 4) / 2.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
143 When sent from the monitor to the emulator, this causes
18
a94ca5a89fe8 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 16
diff changeset
144 the emulator to send the field codes to the host (for async
a94ca5a89fe8 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 16
diff changeset
145 modes) or to set the specified field contents (for block modes).
a94ca5a89fe8 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 16
diff changeset
146 This is also used as the reply message from the emulator to the
1
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
147 monitor for a previous GETFIELD from the monitor.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
148 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
149
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
150 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
151 GETFIELD = 6 (Monitor -> TE).
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
152 The first argument is the line number (0..23)
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
153 and the second argument is the starting column number (0..79),
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
154 and the third argument is the field length in columns.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
155 This command causes the emulator to send a FIELDVALUE message
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
156 back to the monitor.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
157 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
158
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
159 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
160 SCREENWATCH = 7 (Monitor -> TE).
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
161 The first argument is the line number (0..23)
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
162 and the second argument is the starting column number (0..79),
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
163 and the third argument is the field length in columns.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
164 This command causes the emulator to watch the specified
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
165 part of the screen for changes. When that part of the screen
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
166 changes, the emulator will send a SCREENCHANGE message back
25
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
167 to the monitor. The initial screen watch area is the entire
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
168 screen.
1
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
169 </para>
2
f6a1aabf384f add copyright
Carl Byington <carl@five-ten-sg.com>
parents: 1
diff changeset
170
f6a1aabf384f add copyright
Carl Byington <carl@five-ten-sg.com>
parents: 1
diff changeset
171 <para>
13
5bf6d84cc5b8 add showurl command
Carl Byington <carl@five-ten-sg.com>
parents: 2
diff changeset
172 DEPRESS = 8 (Monitor -> TE). The argument is a single uint16
5bf6d84cc5b8 add showurl command
Carl Byington <carl@five-ten-sg.com>
parents: 2
diff changeset
173 value containing the vk_key value. This command causes the emulator
5bf6d84cc5b8 add showurl command
Carl Byington <carl@five-ten-sg.com>
parents: 2
diff changeset
174 to simulate a keypress for that key. The codes are defined
5bf6d84cc5b8 add showurl command
Carl Byington <carl@five-ten-sg.com>
parents: 2
diff changeset
175 <ulink url="http://msdn.microsoft.com/en-us/library/windows/desktop/dd375731">here</ulink>.
5bf6d84cc5b8 add showurl command
Carl Byington <carl@five-ten-sg.com>
parents: 2
diff changeset
176 </para>
5bf6d84cc5b8 add showurl command
Carl Byington <carl@five-ten-sg.com>
parents: 2
diff changeset
177
5bf6d84cc5b8 add showurl command
Carl Byington <carl@five-ten-sg.com>
parents: 2
diff changeset
178 <para>
5bf6d84cc5b8 add showurl command
Carl Byington <carl@five-ten-sg.com>
parents: 2
diff changeset
179 SHOWURL = 9 (Monitor -> TE). The single argument is a sequence
5bf6d84cc5b8 add showurl command
Carl Byington <carl@five-ten-sg.com>
parents: 2
diff changeset
180 of uint16 character codes forming a URL to be displayed.
2
f6a1aabf384f add copyright
Carl Byington <carl@five-ten-sg.com>
parents: 1
diff changeset
181 </para>
16
a481d8fb5571 add switch session command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 13
diff changeset
182
a481d8fb5571 add switch session command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 13
diff changeset
183 <para>
a481d8fb5571 add switch session command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 13
diff changeset
184 SWITCHSESSION = 10 (Monitor -> TE). There are no arguments. The TE
a481d8fb5571 add switch session command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 13
diff changeset
185 should display this session.
a481d8fb5571 add switch session command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 13
diff changeset
186 </para>
18
a94ca5a89fe8 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 16
diff changeset
187
a94ca5a89fe8 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 16
diff changeset
188 <para>
a94ca5a89fe8 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 16
diff changeset
189 CURSORREQUEST = 11 (Monitor -> TE). There are no arguments. The TE
a94ca5a89fe8 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 16
diff changeset
190 should send a CURSORMOVE update to the monitor. Cursor movement caused
a94ca5a89fe8 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 16
diff changeset
191 by SETFIELD or DEPRESS commands does not trigger CURSORMOVE updates
a94ca5a89fe8 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 16
diff changeset
192 in block mode (tn5250) sessions. Those commands do trigger CURSORMOVE
a94ca5a89fe8 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 16
diff changeset
193 updates in async mode (telnet, ssh) sessions.
a94ca5a89fe8 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 16
diff changeset
194 </para>
1
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
195 </refsect1>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
196
25
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
197 <refsect1 id='synchronization.1'>
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
198 <title>Synchronization issues</title>
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
199 <para>
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
200 The terminal emulator should delay sending CURSORMOVE and SCREENCHANGE
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
201 messages until the socket has been quiet for 10 milliseconds or until
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
202 the 5250 block mode terminal keyboard has been unlocked by the host.
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
203 The monitor might send SETFIELD or DEPRESS messages in response to
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
204 those CURSORMOVE or SCREENCHANGE messages. If the 5250 block mode
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
205 keyboard is locked, the terminal emulator should buffer those keystrokes
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
206 and send them when the keyboard unlocks.
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
207 </para>
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
208 </refsect1>
3975d341e3dd document synchronization issues
Carl Byington <carl@five-ten-sg.com>
parents: 23
diff changeset
209
1
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
210 <refsect1 id='todo.1'>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
211 <title>TODO</title>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
212 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
213 Nothing.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
214 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
215 </refsect1>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
216
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
217 <refsect1 id='copyright.1'>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
218 <title>Copyright</title>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
219 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
220 Copyright (C) 2014 by 510 Software Group &lt;carl@five-ten-sg.com&gt;
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
221 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
222 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
223 This program is free software; you can redistribute it and/or modify it
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
224 under the terms of the GNU General Public License as published by the
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
225 Free Software Foundation; either version 3, or (at your option) any
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
226 later version.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
227 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
228 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
229 You should have received a copy of the GNU General Public License along
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
230 with this program; see the file COPYING. If not, please write to the
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
231 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
232 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
233 </refsect1>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
234
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
235 <refsect1 id='version.1'>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
236 <title>Version</title>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
237 <para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
238 @VERSION@
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
239 </para>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
240 </refsect1>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
241 </refentry>
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
242
f12df02aa228 add docs
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
243 </reference>