annotate xml/510connectbot.in @ 514:947ea334735d default tip

update copyrights
author Carl Byington <carl@five-ten-sg.com>
date Fri, 10 Feb 2023 19:13:58 -0700
parents 13a922d1fc5c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1 <reference>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
2 <title>@PACKAGE@ - Version @VERSION@</title>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
3 <partintro>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
4 <title>Packages</title>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
5
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
6 <para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
7 The various source and binary packages are available at <ulink
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
8 url="https://www.five-ten-sg.com/@PACKAGE@/packages/">https://www.five-ten-sg.com/@PACKAGE@/packages/</ulink>.
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
9 The most recent documentation is available at <ulink
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
10 url="https://www.five-ten-sg.com/@PACKAGE@/">https://www.five-ten-sg.com/@PACKAGE@/</ulink>.
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
11 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
12
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
13 <para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
14 A <ulink url="http://www.selenic.com/mercurial/wiki/">Mercurial</ulink> source
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
15 code repository for this project is available at <ulink
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
16 url="https://hg.five-ten-sg.com/@PACKAGE@/">https://hg.five-ten-sg.com/@PACKAGE@/</ulink>.
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
17 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
18
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
19 <para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
20 A companion terminal monitor project is available at <ulink
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
21 url="https://www.five-ten-sg.com/510ConnectbotMonitor">https://www.five-ten-sg.com/510ConnectbotMonitor</ulink>
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
22 </para>
435
9c6a269fabb5 add bitcoin donation address
Carl Byington <carl@five-ten-sg.com>
parents: 390
diff changeset
23
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
24 </partintro>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
25
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
26 <refentry id="x@PACKAGE@.1">
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
27 <refentryinfo>
470
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
28 <date>2019-10-04</date>
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
29 <author>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
30 <firstname>Carl</firstname>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
31 <surname>Byington</surname>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
32 <affiliation><orgname>510 Software Group</orgname></affiliation>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
33 </author>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
34 </refentryinfo>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
35
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
36 <refmeta>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
37 <refentrytitle>@PACKAGE@</refentrytitle>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
38 <manvolnum>1</manvolnum>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
39 <refmiscinfo>@PACKAGE@ @VERSION@</refmiscinfo>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
40 </refmeta>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
41
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
42 <refnamediv id='name.1'>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
43 <refname>@PACKAGE@</refname>
382
41fa02fdb9c6 cleanup help pages
Carl Byington <carl@five-ten-sg.com>
parents: 381
diff changeset
44 <refpurpose>an android vt320 tn5250 terminal emulator for telnet and ssh connections</refpurpose>
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
45 </refnamediv>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
46
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
47 <refsect1 id='build.1'>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
48 <title>Build method</title>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
49 <para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
50 This is an android project with native code, so
453
f65d8bb11eb0 update build directions
Carl Byington <carl@five-ten-sg.com>
parents: 435
diff changeset
51 "make builder style=debug" should build cleanly.
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
52 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
53 </refsect1>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
54
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
55 <refsect1 id='introduction.1'>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
56 <title>Introduction</title>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
57 <para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
58 I belive that the previous connectbot projects are improperly licensed.
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
59 They contain a mix of Apache 2.0 and GPLv2+ code, and those two licenses
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
60 are incompatible. I have relicensed this as GPLv3+, since that is
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
61 compatible with the licenses of all the sub-parts.
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
62 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
63 <para>
388
ebcb4aea03ec fix documentation typos
Carl Byington <carl@five-ten-sg.com>
parents: 382
diff changeset
64 This fork extends previous Connectbot projects in two ways. It includes
73
accf93be8c12 update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents: 0
diff changeset
65 tn5250 terminal emulation, in addition to the previous vt320 terminal
accf93be8c12 update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents: 0
diff changeset
66 emulation. It also contains hooks for a separate monitoring process
accf93be8c12 update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents: 0
diff changeset
67 that has access to some of the internal operations in this emulator.
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
68 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
69 </refsect1>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
70
220
4fdf6b5a6f43 update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 206
diff changeset
71 <refsect1 id='changes.1'>
388
ebcb4aea03ec fix documentation typos
Carl Byington <carl@five-ten-sg.com>
parents: 382
diff changeset
72 <title>Other changes from previous Connectbots</title>
220
4fdf6b5a6f43 update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 206
diff changeset
73 <itemizedlist>
221
70ecbf70eadb document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 220
diff changeset
74 <listitem><para>
344
b40bc65fa09a compensate for SecureRandom bug on older devices
Carl Byington <carl@five-ten-sg.com>
parents: 273
diff changeset
75 The Android SecureRandom bug has been fixed in newer versions
b40bc65fa09a compensate for SecureRandom bug on older devices
Carl Byington <carl@five-ten-sg.com>
parents: 273
diff changeset
76 of Android, but this code now compensates for that bug in
388
ebcb4aea03ec fix documentation typos
Carl Byington <carl@five-ten-sg.com>
parents: 382
diff changeset
77 older versions. If you have keys generated on older Android
344
b40bc65fa09a compensate for SecureRandom bug on older devices
Carl Byington <carl@five-ten-sg.com>
parents: 273
diff changeset
78 devices, those keys should be discarded, and you should generate
b40bc65fa09a compensate for SecureRandom bug on older devices
Carl Byington <carl@five-ten-sg.com>
parents: 273
diff changeset
79 new keys.
b40bc65fa09a compensate for SecureRandom bug on older devices
Carl Byington <carl@five-ten-sg.com>
parents: 273
diff changeset
80 </para></listitem>
b40bc65fa09a compensate for SecureRandom bug on older devices
Carl Byington <carl@five-ten-sg.com>
parents: 273
diff changeset
81
b40bc65fa09a compensate for SecureRandom bug on older devices
Carl Byington <carl@five-ten-sg.com>
parents: 273
diff changeset
82 <listitem><para>
358
37f4a3b506d9 move nist ec curves to lower priority
Carl Byington <carl@five-ten-sg.com>
parents: 344
diff changeset
83 The underlying compression code from jcraft has
37f4a3b506d9 move nist ec curves to lower priority
Carl Byington <carl@five-ten-sg.com>
parents: 344
diff changeset
84 been updated. The underlying socks proxy code has
37f4a3b506d9 move nist ec curves to lower priority
Carl Byington <carl@five-ten-sg.com>
parents: 344
diff changeset
85 been updated. The underlying ssh code has been
37f4a3b506d9 move nist ec curves to lower priority
Carl Byington <carl@five-ten-sg.com>
parents: 344
diff changeset
86 updated from trilead to ganymed. Elliptic curve
37f4a3b506d9 move nist ec curves to lower priority
Carl Byington <carl@five-ten-sg.com>
parents: 344
diff changeset
87 crypto is now supported, but the NIST curves are
37f4a3b506d9 move nist ec curves to lower priority
Carl Byington <carl@five-ten-sg.com>
parents: 344
diff changeset
88 placed after the RSA and DH types in the list of
37f4a3b506d9 move nist ec curves to lower priority
Carl Byington <carl@five-ten-sg.com>
parents: 344
diff changeset
89 key exchange algorithms, so they should only be
37f4a3b506d9 move nist ec curves to lower priority
Carl Byington <carl@five-ten-sg.com>
parents: 344
diff changeset
90 used if the server does not support RSA or
37f4a3b506d9 move nist ec curves to lower priority
Carl Byington <carl@five-ten-sg.com>
parents: 344
diff changeset
91 DH. This change is based on on a general lack of
37f4a3b506d9 move nist ec curves to lower priority
Carl Byington <carl@five-ten-sg.com>
parents: 344
diff changeset
92 trust in NIST curves that have possibly been
390
d26faad31533 test buffer changed when 5250 keyboard unlocks
Carl Byington <carl@five-ten-sg.com>
parents: 388
diff changeset
93 compromised by the NSA.
344
b40bc65fa09a compensate for SecureRandom bug on older devices
Carl Byington <carl@five-ten-sg.com>
parents: 273
diff changeset
94 </para></listitem>
b40bc65fa09a compensate for SecureRandom bug on older devices
Carl Byington <carl@five-ten-sg.com>
parents: 273
diff changeset
95
b40bc65fa09a compensate for SecureRandom bug on older devices
Carl Byington <carl@five-ten-sg.com>
parents: 273
diff changeset
96 <listitem><para>
225
c6157535e180 update version; consistent defaults for hardware buttons
Carl Byington <carl@five-ten-sg.com>
parents: 221
diff changeset
97 The soft function keypad now has better labels, and can generate
c6157535e180 update version; consistent defaults for hardware buttons
Carl Byington <carl@five-ten-sg.com>
parents: 221
diff changeset
98 all 24 function keys for 5250 emulation. A hardware button can
c6157535e180 update version; consistent defaults for hardware buttons
Carl Byington <carl@five-ten-sg.com>
parents: 221
diff changeset
99 be configured to display that function keypad.
221
70ecbf70eadb document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 220
diff changeset
100 </para></listitem>
220
4fdf6b5a6f43 update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 206
diff changeset
101
221
70ecbf70eadb document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 220
diff changeset
102 <listitem><para>
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
103 A 510Connectbot.connections text file is read (and optionally deleted) on
220
4fdf6b5a6f43 update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 206
diff changeset
104 startup. This may be used to preconfigure the global options
388
ebcb4aea03ec fix documentation typos
Carl Byington <carl@five-ten-sg.com>
parents: 382
diff changeset
105 and to create an initial set of host connections. This is only
ebcb4aea03ec fix documentation typos
Carl Byington <carl@five-ten-sg.com>
parents: 382
diff changeset
106 useful for bulk deployments.
221
70ecbf70eadb document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 220
diff changeset
107 </para></listitem>
220
4fdf6b5a6f43 update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 206
diff changeset
108
221
70ecbf70eadb document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 220
diff changeset
109 <listitem><para>
220
4fdf6b5a6f43 update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 206
diff changeset
110 The font sizes are now kept with one decimal point, and font
4fdf6b5a6f43 update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 206
diff changeset
111 size changes are done by scaling by a constant factor of 1.1,
4fdf6b5a6f43 update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 206
diff changeset
112 rather than the linear additive 2 point factor.
221
70ecbf70eadb document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 220
diff changeset
113 </para></listitem>
254
5517cca2bd81 update version; help shows full version info; update change list
Carl Byington <carl@five-ten-sg.com>
parents: 229
diff changeset
114
5517cca2bd81 update version; help shows full version info; update change list
Carl Byington <carl@five-ten-sg.com>
parents: 229
diff changeset
115 <listitem><para>
262
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
116 On a per-host basis, you can either allow the font size to change
266
c922a60043db update documentation
Carl Byington <carl@five-ten-sg.com>
parents: 262
diff changeset
117 the number of rows and columns depending on the visibility
262
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
118 of the soft keyboard, or you can fix the number of rows and colums.
388
ebcb4aea03ec fix documentation typos
Carl Byington <carl@five-ten-sg.com>
parents: 382
diff changeset
119 Using a larger font with a fixed number of rows and columns, you
266
c922a60043db update documentation
Carl Byington <carl@five-ten-sg.com>
parents: 262
diff changeset
120 may only be able to see the top left part of the logical screen that
c922a60043db update documentation
Carl Byington <carl@five-ten-sg.com>
parents: 262
diff changeset
121 is being used by the host system. There is no vertical or horizontal
c922a60043db update documentation
Carl Byington <carl@five-ten-sg.com>
parents: 262
diff changeset
122 scrolling yet.
254
5517cca2bd81 update version; help shows full version info; update change list
Carl Byington <carl@five-ten-sg.com>
parents: 229
diff changeset
123 </para></listitem>
5517cca2bd81 update version; help shows full version info; update change list
Carl Byington <carl@five-ten-sg.com>
parents: 229
diff changeset
124
5517cca2bd81 update version; help shows full version info; update change list
Carl Byington <carl@five-ten-sg.com>
parents: 229
diff changeset
125 <listitem><para>
258
89bad826152b fix documentation typos
Carl Byington <carl@five-ten-sg.com>
parents: 254
diff changeset
126 The configurable hardware buttons can now change the font size.
254
5517cca2bd81 update version; help shows full version info; update change list
Carl Byington <carl@five-ten-sg.com>
parents: 229
diff changeset
127 </para></listitem>
5517cca2bd81 update version; help shows full version info; update change list
Carl Byington <carl@five-ten-sg.com>
parents: 229
diff changeset
128
262
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
129 <listitem><para>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
130 The soft function keypad now includes the cursor movement keys.
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
131 </para></listitem>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
132
220
4fdf6b5a6f43 update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 206
diff changeset
133 </itemizedlist>
4fdf6b5a6f43 update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 206
diff changeset
134 </refsect1>
4fdf6b5a6f43 update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents: 206
diff changeset
135
361
395a16681ae1 add help files to the web documentation
Carl Byington <carl@five-ten-sg.com>
parents: 358
diff changeset
136 <refsect1 id='helppages.1'>
395a16681ae1 add help files to the web documentation
Carl Byington <carl@five-ten-sg.com>
parents: 358
diff changeset
137 <title>Help Pages</title>
395a16681ae1 add help files to the web documentation
Carl Byington <carl@five-ten-sg.com>
parents: 358
diff changeset
138 <itemizedlist>
381
95188bd4badb cleanup help pages
Carl Byington <carl@five-ten-sg.com>
parents: 379
diff changeset
139 <listitem><para><ulink url="About.html">About</ulink> - including list of credits</para></listitem>
361
395a16681ae1 add help files to the web documentation
Carl Byington <carl@five-ten-sg.com>
parents: 358
diff changeset
140 <listitem><para><ulink url="Hints.html">Hints</ulink></para></listitem>
395a16681ae1 add help files to the web documentation
Carl Byington <carl@five-ten-sg.com>
parents: 358
diff changeset
141 <listitem><para><ulink url="PhysicalKeyboard.html">Physical Keyboard</ulink></para></listitem>
395a16681ae1 add help files to the web documentation
Carl Byington <carl@five-ten-sg.com>
parents: 358
diff changeset
142 <listitem><para><ulink url="5250Keys.html">5250 Keys</ulink></para></listitem>
395a16681ae1 add help files to the web documentation
Carl Byington <carl@five-ten-sg.com>
parents: 358
diff changeset
143 <listitem><para><ulink url="ScreenGestures.html">Screen Gestures</ulink></para></listitem>
395a16681ae1 add help files to the web documentation
Carl Byington <carl@five-ten-sg.com>
parents: 358
diff changeset
144 <listitem><para><ulink url="VirtualKeyboard.html">Virtual Keyboard</ulink></para></listitem>
395a16681ae1 add help files to the web documentation
Carl Byington <carl@five-ten-sg.com>
parents: 358
diff changeset
145 </itemizedlist>
395a16681ae1 add help files to the web documentation
Carl Byington <carl@five-ten-sg.com>
parents: 358
diff changeset
146 </refsect1>
395a16681ae1 add help files to the web documentation
Carl Byington <carl@five-ten-sg.com>
parents: 358
diff changeset
147
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
148 <refsect1 id='monitor.1'>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
149 <title>Terminal Monitor</title>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
150 <para>
73
accf93be8c12 update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents: 0
diff changeset
151 For every terminal session (local, telnet, ssh or tn5250), this
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
152 terminal emulator also makes a connection to a terminal monitor
150
83bb2734b14c more setfield testing
Carl Byington <carl@five-ten-sg.com>
parents: 147
diff changeset
153 process, which can see cursor movement and screen contents, and can
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
154 inject characters to send to the host.
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
155 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
156
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
157 <para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
158 The terminal monitor is invoked by calling an android Intent
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
159 named "com.five_ten_sg.connectbot.monitor.MonitorService". That
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
160 ensures that the monitor process is running, and should then
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
161 be listening on TCP port 6001 for incoming connections. The terminal
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
162 emulator then connects to the terminal monitor on port 6001.
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
163 The native android Intent and Service communication mechanisms
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
164 are not used.
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
165 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
166
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
167 <para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
168 The messages exchanged between the terminal emulator and the
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
169 terminal monitor are arrays of uint16 values in network byte
463
6dff6933879c fixup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 453
diff changeset
170 order. Each message starts with a uint16 message length,
6dff6933879c fixup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 453
diff changeset
171 followed by that many uint16 values.
6dff6933879c fixup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 453
diff changeset
172 The next uint16 contains the message
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
173 command value, and the remaining uint16 values are the arguments
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
174 if any for that command.
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
175 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
176
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
177 <para>
470
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
178 Any arguments that are characters are represented as 16 bit
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
179 unicode. Note that the first 256 such characters are identical to the
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
180 ISO-8859-1 latin character set. There is no provision for handling
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
181 surrogate pairs as in UTF-16. Keystroke arguments (see DEPRESS) are
472
9ff443085f00 cleanup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 470
diff changeset
182 represented as Microsoft Virtual-Key codes, defined
470
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
183 <ulink url="https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes">here</ulink>.
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
184 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
185
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
186 <para>
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
187 The first message over the socket must be the INIT message
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
188 from the TE. This allows the terminal monitor to load any
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
189 required data.
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
190 </para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
191
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
192 <para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
193 That is followed by a pair of SCREENCHANGE/CURSORMOVE messages from
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
194 the TE whenever the screen contents have changed. The terminal monitor
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
195 may respond to the SCREENCHANGE message with a SCREENWATCH message to
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
196 restrict the part of the screen that is to be monitored for updates.
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
197 </para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
198
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
199 <para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
200 At any time, the terminal monitor may send GETFIELD or SETFIELD messages
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
201 to get or set the value of fields on the current screen. GETFIELD
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
202 messages from the terminal monitor must be followed by a FIELDVALUE
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
203 message from the TE.
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
204 </para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
205
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
206 <para>
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
207 INIT = 0 (TE -> Monitor). The argument is a string of uint16
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
208 characters. The meaning of these characters is defined by the
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
209 monitor. It might be a fully qualified path name, or some other
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
210 data used by the monitor to drive the monitoring of this
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
211 connection.
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
212 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
213
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
214 <para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
215 ACTIVATE = 1 (TE -> Monitor). The first argument is the
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
216 number of lines. The second argument is the number of columns.
463
6dff6933879c fixup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 453
diff changeset
217 That is followed by lines*columns uint16 character codes for
6dff6933879c fixup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 453
diff changeset
218 the current screen contents.
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
219 This connection is now the active connection. It is the
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
220 topmost (or only) window visible to the user - typed keystrokes
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
221 will be sent to the host on the other end of this connection.
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
222 The TE must reset the screen watch area to the entire screen.
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
223 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
224
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
225 <para>
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
226 Every ACTIVATEE message from the TE must be followed by a
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
227 CURSORMOVE message.
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
228 </para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
229
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
230
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
231 <para>
147
1350adb077b1 monitor key state tracking
Carl Byington <carl@five-ten-sg.com>
parents: 73
diff changeset
232 KEYSTATE = 2 (TE -> Monitor). The argument is a single uint16
1350adb077b1 monitor key state tracking
Carl Byington <carl@five-ten-sg.com>
parents: 73
diff changeset
233 value, 1 for key down, 0 for key up. The TE tracks a single special
1350adb077b1 monitor key state tracking
Carl Byington <carl@five-ten-sg.com>
parents: 73
diff changeset
234 key for the monitor, and reports key up/down state when it changes.
1350adb077b1 monitor key state tracking
Carl Byington <carl@five-ten-sg.com>
parents: 73
diff changeset
235 The actual key is configurable.
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
236 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
237
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
238 <para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
239 CURSORMOVE = 3 (TE -> Monitor).
229
594101a0876a add why argument on cursor updates
Carl Byington <carl@five-ten-sg.com>
parents: 225
diff changeset
240 The first argument is the line number (0..23),
594101a0876a add why argument on cursor updates
Carl Byington <carl@five-ten-sg.com>
parents: 225
diff changeset
241 the second argument is the column number (0..79), and the third
594101a0876a add why argument on cursor updates
Carl Byington <carl@five-ten-sg.com>
parents: 225
diff changeset
242 argument is the reason for sending this cursor update. REASON=0 is
514
947ea334735d update copyrights
Carl Byington <carl@five-ten-sg.com>
parents: 513
diff changeset
243 from a previous CURSORREQUEST message. REASON=1 is a cursor update
229
594101a0876a add why argument on cursor updates
Carl Byington <carl@five-ten-sg.com>
parents: 225
diff changeset
244 related to the previous SCREENCHANGE buffer update. REASON=2 is
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
245 a cursor update caused by user keystrokes or cursor movement
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
246 triggered by SETFIELD messages from the runtime.
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
247 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
248
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
249 <para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
250 SCREENCHANGE = 4 (TE -> Monitor). The first argument is the
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
251 number of lines. The second argument is the number of columns.
463
6dff6933879c fixup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 453
diff changeset
252 That is followed by lines*columns uint16 character codes for
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
253 the current screen contents. The TE must reset the screen
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
254 watch area to the entire screen.
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
255 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
256
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
257 <para>
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
258 Every SCREENCHANGE message from the TE must be followed by a
470
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
259 CURSORMOVE message.
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
260 </para>
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
261
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
262 <para>
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
263 When the TE sends the screen contents as a result of a previous screen
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
264 watch, the screen watch area is then reset to the entire screen. The
514
947ea334735d update copyrights
Carl Byington <carl@five-ten-sg.com>
parents: 513
diff changeset
265 monitor is then responsible for sending a SCREENWATCH message
947ea334735d update copyrights
Carl Byington <carl@five-ten-sg.com>
parents: 513
diff changeset
266 to set the watch area to something appropriate for that new
472
9ff443085f00 cleanup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 470
diff changeset
267 screen. Once the monitor has set the watch area to some part of a
9ff443085f00 cleanup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 470
diff changeset
268 single line, there is no mechanism for the monitor to reset it to
470
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
269 back to the entire screen. That reset only happens when the TE sends
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
270 the screen contents.
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
271 </para>
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
272
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
273 <para>
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
274 FIELDVALUE = 5 (TE -> Monitor).
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
275 SETFIELD = 5 (Monitor -> TE).
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
276 The first argument is the line number (0..23)
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
277 and the second argument is the column number (0..79).
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
278 That is followed by the field value, a sequence of uint16
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
279 character codes from the screen buffer. The field
463
6dff6933879c fixup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 453
diff changeset
280 covers N columns, where N = (message length - 4).
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
281 When sent from the monitor to the emulator, this causes
463
6dff6933879c fixup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 453
diff changeset
282 the emulator to send the field codes to the host (for async
6dff6933879c fixup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 453
diff changeset
283 modes) or to set the specified field contents (for block modes).
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
284 Note that the field length may be zero, in which case the
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
285 block mode field should cleared.
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
286 </para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
287
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
288 <para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
289 If either of the line or column numbers are -1 (0xffff), the field is
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
290 taken from the current cursor position.
470
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
291 </para>
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
292
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
293 <para>
463
6dff6933879c fixup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 453
diff changeset
294 This is also used as the reply message from the emulator to the
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
295 monitor for a previous GETFIELD from the monitor.
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
296 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
297
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
298 <para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
299 GETFIELD = 6 (Monitor -> TE).
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
300 The first argument is the line number (0..23)
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
301 and the second argument is the starting column number (0..79),
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
302 and the third argument is the field length in columns.
514
947ea334735d update copyrights
Carl Byington <carl@five-ten-sg.com>
parents: 513
diff changeset
303 This message causes the emulator to send a FIELDVALUE message
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
304 back to the monitor.
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
305 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
306
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
307 <para>
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
308 If either of the line or column numbers are -1
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
309 (0xffff), the block mode field is taken from the
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
310 current cursor position, the specified field length
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
311 should be ignored, and the entire field contents are
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
312 sent back in the FIELDVALUE reply message.
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
313 </para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
314
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
315 <para>
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
316 SCREENWATCH = 7 (Monitor -> TE).
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
317
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
318 The number of arguments must be a multiple of
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
319 three. The arguments form a sequence of triples, where
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
320 the first element is the line number (0..23), the
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
321 second element is the starting column number (0..79),
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
322 and the third element is the field length in columns
514
947ea334735d update copyrights
Carl Byington <carl@five-ten-sg.com>
parents: 513
diff changeset
323 This message causes the emulator to watch the
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
324 specified parts of the screen for updates. When any of
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
325 those parts of the screen are updated by the host
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
326 (even if the old and new characters are the same) ,
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
327 the emulator will send a SCREENCHANGE message back to
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
328 the monitor. The initial screen watch area is the
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
329 entire screen. The screen watch area is reset to the
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
330 entire screen whenever the TE sends an ACTIVATE or
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
331 SCREENCHANGE message.
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
332 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
333
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
334 <para>
470
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
335 Subsequent screenwatch requests replace the current one, so the TE
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
336 has only one watch area at any time.
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
337 </para>
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
338
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
339 <para>
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
340 DEPRESS = 8 (Monitor -> TE). The argument is a single
514
947ea334735d update copyrights
Carl Byington <carl@five-ten-sg.com>
parents: 513
diff changeset
341 uint16 value containing the vk_key value. This message
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
342 causes the emulator to simulate a keypress for that
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
343 key. This is used for the function keys and cursor
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
344 movement keys. See DEPRESSUNICODE for ascii control
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
345 characters. Note that the TE must convert these
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
346 virtual key codes into the appropriate escape sequence
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
347 used by the host protocol (VT320, 5250, 3270, etc).The
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
348 base codes are defined <ulink
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
349 url="https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes">here</ulink>.
160
4bccac50fd0b update version number and documentation
Carl Byington <carl@five-ten-sg.com>
parents: 150
diff changeset
350 </para>
4bccac50fd0b update version number and documentation
Carl Byington <carl@five-ten-sg.com>
parents: 150
diff changeset
351
4bccac50fd0b update version number and documentation
Carl Byington <carl@five-ten-sg.com>
parents: 150
diff changeset
352 <para>
4bccac50fd0b update version number and documentation
Carl Byington <carl@five-ten-sg.com>
parents: 150
diff changeset
353 SHOWURL = 9 (Monitor -> TE). The single argument is a sequence
4bccac50fd0b update version number and documentation
Carl Byington <carl@five-ten-sg.com>
parents: 150
diff changeset
354 of uint16 character codes forming a URL to be displayed.
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
355 Strings within the URL must be URL escaped, so all of the
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
356 characters in the argument are less than 128.
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
357 </para>
206
f60d4b1e8c39 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 160
diff changeset
358
f60d4b1e8c39 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 160
diff changeset
359 <para>
f60d4b1e8c39 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 160
diff changeset
360 SWITCHSESSION = 10 (Monitor -> TE). There are no arguments. The TE
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
361 should display the session associated with this socket.
206
f60d4b1e8c39 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 160
diff changeset
362 </para>
f60d4b1e8c39 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 160
diff changeset
363
f60d4b1e8c39 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 160
diff changeset
364 <para>
f60d4b1e8c39 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 160
diff changeset
365 CURSORREQUEST = 11 (Monitor -> TE). There are no arguments. The TE
f60d4b1e8c39 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 160
diff changeset
366 should send a CURSORMOVE update to the monitor. Cursor movement caused
514
947ea334735d update copyrights
Carl Byington <carl@five-ten-sg.com>
parents: 513
diff changeset
367 by SETFIELD or DEPRESS messages does not trigger CURSORMOVE updates
947ea334735d update copyrights
Carl Byington <carl@five-ten-sg.com>
parents: 513
diff changeset
368 in block mode (tn5250) sessions. Those messages do trigger CURSORMOVE
206
f60d4b1e8c39 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 160
diff changeset
369 updates in async mode (telnet, ssh) sessions.
f60d4b1e8c39 add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents: 160
diff changeset
370 </para>
463
6dff6933879c fixup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 453
diff changeset
371
6dff6933879c fixup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 453
diff changeset
372 <para>
6dff6933879c fixup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 453
diff changeset
373 SAYSTRING = 12 (TE -> Monitor). The first argument is nonzero if
6dff6933879c fixup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 453
diff changeset
374 any current speech should be flushed. The second argument is nonzero
6dff6933879c fixup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 453
diff changeset
375 if this speech should be synchronous. That is followed by uint16
470
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
376 character codes to be spoken. Note that the language is specified
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
377 by the monitor, not the TE.
463
6dff6933879c fixup documentation
Carl Byington <carl@five-ten-sg.com>
parents: 453
diff changeset
378 </para>
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
379
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
380 <para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
381 SETFOCUS = 13 (Monitor -> TE). The first argument is the
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
382 line number (-1..23) and the second argument is the column number
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
383 (-1..79). The TE should set the input focus to the specified field
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
384 position by moving the cursor.
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
385 </para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
386
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
387 <para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
388 KEYBOARD = 14 (Monitor -> TE). The argument is a single
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
389 uint16 value, 0 to hide the soft keyboard, 1 to show the soft keyboard.
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
390 </para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
391
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
392 <para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
393 DEPRESSUNICODE = 15 (Monitor -> TE). The argument is a
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
394 single uint16 value containing the unicode value. This message causes
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
395 the TE to send the keystroke to the host. This is used for ascii
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
396 control characters. Use DEPRESS for function and cursor movement
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
397 keys.
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
398 </para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
399
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
400 <para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
401 FOREGROUND = 16 (Monitor -> TE). There are no arguments.
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
402 This is sent to the TE whenever the terminal monitor may have become the
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
403 visible foreground application. The TE should now force itself to be
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
404 the visible foreground application.
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
405 </para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
406
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
407 </refsect1>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
408
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
409 <refsect1 id='todo.1'>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
410 <title>TODO</title>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
411 <para>
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
412 The tn5250 tls key storage should use the same storage mechanism
73
accf93be8c12 update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents: 0
diff changeset
413 as the base ssh key storage.
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
414 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
415 </refsect1>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
416
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
417 <refsect1 id='copyright.1'>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
418 <title>Copyright</title>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
419 <para>
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
420 Copyright (C) 2019-2023 by 510 Software Group &lt;carl@five-ten-sg.com&gt;
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
421 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
422 <para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
423 This program is free software; you can redistribute it and/or modify it
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
424 under the terms of the GNU General Public License as published by the
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
425 Free Software Foundation; either version 3, or (at your option) any
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
426 later version.
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
427 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
428 <para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
429 You should have received a copy of the GNU General Public License along
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
430 with this program; see the file COPYING. If not, please write to the
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
431 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
432 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
433 </refsect1>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
434
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
435 <refsect1 id='version.1'>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
436 <title>Version</title>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
437 <para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
438 @VERSION@
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
439 </para>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
440 </refsect1>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
441 </refentry>
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
442
268
2ce1ad6ffe6b fix xml syntax
Carl Byington <carl@five-ten-sg.com>
parents: 266
diff changeset
443 <refentry id="x@PACKAGE@.5">
262
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
444 <refentryinfo>
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
445 <date>2023-02-10</date>
262
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
446 <author>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
447 <firstname>Carl</firstname>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
448 <surname>Byington</surname>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
449 <affiliation><orgname>510 Software Group</orgname></affiliation>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
450 </author>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
451 </refentryinfo>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
452
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
453 <refmeta>
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
454 <refentrytitle>510Connectbot.connections</refentrytitle>
262
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
455 <manvolnum>5</manvolnum>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
456 <refmiscinfo>@PACKAGE@ @VERSION@</refmiscinfo>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
457 </refmeta>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
458
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
459 <refnamediv id='name.5'>
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
460 <refname>510Connectbot.connections</refname>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
461 <refpurpose>connections file for @PACKAGE@</refpurpose>
262
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
462 </refnamediv>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
463
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
464 <refsect1 id='description.5'>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
465 <title>Description</title>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
466
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
467 <para>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
468 The <command>510Connectbot.connections</command>
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
469 sample file is below. If this file exists in the
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
470 AccuSpeech/VoiceProjects directory or in the Downloads
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
471 directory, it is read, parsed, and optionally deleted.
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
472 Comments start with # and extend to the end of the line.
270
45d1fcc1a356 document deployment.connections usage
Carl Byington <carl@five-ten-sg.com>
parents: 268
diff changeset
473 </para>
262
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
474
466
12e2d9dd95df add delete_deployment and autolaunch keys to the deployment.connections file
Carl Byington <carl@five-ten-sg.com>
parents: 465
diff changeset
475 <para>
513
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
476 The connections file is deleted unless it contains
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
477 "delete_deployment=false" in the global options
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
478 section. In that case, the file remains, and it is read
13a922d1fc5c update docs
Carl Byington <carl@five-ten-sg.com>
parents: 509
diff changeset
479 and parsed every time the app is launched.
466
12e2d9dd95df add delete_deployment and autolaunch keys to the deployment.connections file
Carl Byington <carl@five-ten-sg.com>
parents: 465
diff changeset
480 </para>
12e2d9dd95df add delete_deployment and autolaunch keys to the deployment.connections file
Carl Byington <carl@five-ten-sg.com>
parents: 465
diff changeset
481
262
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
482 <literallayout class="monospaced"><![CDATA[
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
483 #
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
484 # available host keys:
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
485 #
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
486 # nickname (string)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
487 # color (string) ("red", "green", "blue", "gray")
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
488 # fontsize (float)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
489 # fixed_size (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
490 # fixed_width (integer)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
491 # fixed_height (integer)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
492 # pubkeyid (integer) (-2, -1) -2=none, -1=any
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
493 # useauthagent (string) ("no", "confirm", "yes")
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
494 # postlogin (string)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
495 # compression (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
496 # httpproxy (string)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
497 # wantsession (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
498 # stayconnected (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
499 # delkey (string) ("del", "backspace")
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
500 # encoding (string) ("UTF-8", etc)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
501 # username (string)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
502 # hostname (string)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
503 # port (integer)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
504 # monitor (string)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
505 # emulation (string) ("xterm-color", "xterm-256color", "xterm", "vt100", "ansi", "screen", or other answerback string)
509
2eb4fa13b9ef update 5250 encryption to allow TLS1.3, remove old SSLv2 and SSLv3 methods
Carl Byington <carl@five-ten-sg.com>
parents: 473
diff changeset
506 # encryption5250 (string) ("NONE", "TLSv1.2", "TLSv1.3")
262
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
507 # library5250 (string)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
508 # menu5250 (string)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
509 # program5250 (string)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
510 # wantx11forward (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
511 # x11host (string)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
512 # x11port (integer)
466
12e2d9dd95df add delete_deployment and autolaunch keys to the deployment.connections file
Carl Byington <carl@five-ten-sg.com>
parents: 465
diff changeset
513 # autolaunch (boolean)
262
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
514
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
515
466
12e2d9dd95df add delete_deployment and autolaunch keys to the deployment.connections file
Carl Byington <carl@five-ten-sg.com>
parents: 465
diff changeset
516 tn5250://pub400.com:23#battleship
262
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
517 encryption5250=NONE
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
518 fontsize=20
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
519 fixed_size=true
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
520 fixed_width=80
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
521 fixed_height=25
470
2cc170e3fc9b audible bell checkbox enables/disables bell volume setting; monitor init string is now a url socket://target/initstring
Carl Byington <carl@five-ten-sg.com>
parents: 466
diff changeset
522 monitor=socket://localhost/pub400
262
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
523
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
524
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
525 #
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
526 # global settings are under global:// tag
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
527 #
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
528 # available global keys:
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
529 #
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
530 # memkeys (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
531 # connPersist (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
532 # emulation (string) ("xterm-color", "xterm-256color", "xterm", "vt100", "ansi", "screen")
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
533 # scrollback (integer)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
534 # rotation (string) ("Default", "Force landscape", "Force portrait", "Automatic")
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
535 # shiftfkeys (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
536 # ctrlfkeys (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
537 # keymode (string) ("Use right-side keys", "Use left-side keys", "none")
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
538 # camera (string) ("CTRL", "Esc", "Tab", "Screen Capture", "Ctrl+A then Space", "Ctrl+A", "Esc+A", "Monitor Key", "Soft Function Keypad", "Increase Font Size", "Decrease Font Size", "None")
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
539 # volup (string) ("CTRL", "Esc", "Tab", "Screen Capture", "Ctrl+A then Space", "Ctrl+A", "Esc+A", "Monitor Key", "Soft Function Keypad", "Increase Font Size", "Decrease Font Size", "None")
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
540 # voldn (string) ("CTRL", "Esc", "Tab", "Screen Capture", "Ctrl+A then Space", "Ctrl+A", "Esc+A", "Monitor Key", "Soft Function Keypad", "Increase Font Size", "Decrease Font Size", "None")
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
541 # search (string) ("CTRL", "Esc", "Tab", "Screen Capture", "Ctrl+A then Space", "Ctrl+A", "Esc+A", "Monitor Key", "Soft Function Keypad", "Increase Font Size", "Decrease Font Size", "None")
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
542 # ptt (string) ("CTRL", "Esc", "Tab", "Screen Capture", "Ctrl+A then Space", "Ctrl+A", "Esc+A", "Monitor Key", "Soft Function Keypad", "Increase Font Size", "Decrease Font Size", "None")
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
543 # keepalive (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
544 # wifilock (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
545 # bumpyarrows (boolean)
379
aaf1599a8656 document eula key in deployment.connections
Carl Byington <carl@five-ten-sg.com>
parents: 361
diff changeset
546 # eula (boolean)
262
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
547 # extended_longpress (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
548 # ctrl_string (string)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
549 # picker_string (string)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
550 # picker_keep_open (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
551 # list_custom_keymap (string) ("none", "full", "asus_tf", "sgh_i927", "sgh_i927_ics", "se_xppro")
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
552 # bell (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
553 # bellVolume (float)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
554 # bellVibrate (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
555 # bellNotification (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
556 # screen_capture_folder (string)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
557 # screen_capture_popup (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
558 # file_dialog (string)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
559 # download_folder (string)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
560 # remote_upload_folder (string)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
561 # upload_dest_prompt (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
562 # background_file_transfer (boolean)
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
563 # debug_keycodes (boolean)
466
12e2d9dd95df add delete_deployment and autolaunch keys to the deployment.connections file
Carl Byington <carl@five-ten-sg.com>
parents: 465
diff changeset
564 # delete_deployment (boolean)
473
ece82b571900 add fg/bg color setting to global:// section of deployment.connections file
Carl Byington <carl@five-ten-sg.com>
parents: 472
diff changeset
565 # fg_color (integer) (1 based just as shown by color activity)
ece82b571900 add fg/bg color setting to global:// section of deployment.connections file
Carl Byington <carl@five-ten-sg.com>
parents: 472
diff changeset
566 # bg_color (integer) (1 based just as shown by color activity)
262
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
567 #
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
568
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
569 global://
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
570 emulation=xterm-256color
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
571 scrollback=200
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
572 rotation=Force landscape
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
573 camera=None
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
574 volup=Soft Function Keypad
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
575 voldn=Tab
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
576 search=None
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
577 ptt=Monitor Key
379
aaf1599a8656 document eula key in deployment.connections
Carl Byington <carl@five-ten-sg.com>
parents: 361
diff changeset
578 eula=true
473
ece82b571900 add fg/bg color setting to global:// section of deployment.connections file
Carl Byington <carl@five-ten-sg.com>
parents: 472
diff changeset
579 fg_color=11
ece82b571900 add fg/bg color setting to global:// section of deployment.connections file
Carl Byington <carl@five-ten-sg.com>
parents: 472
diff changeset
580 bg_color=1
262
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
581
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
582 #
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
583 # end
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
584 ]]></literallayout>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
585 </refsect1>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
586
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
587 <refsect1 id='version.5'>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
588 <title>Version</title>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
589 <para>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
590 @VERSION@
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
591 </para>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
592 </refsect1>
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
593
db26984b69f5 update version; add cursor movement keys to the soft function keypad
Carl Byington <carl@five-ten-sg.com>
parents: 258
diff changeset
594 </refentry>
0
0ce5cc452d02 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
595 </reference>