Mercurial > 510Connectbot
annotate xml/510connectbot.in @ 222:13a3bd77881a
Added tag stable-1.8.4 for changeset 70ecbf70eadb
author | Carl Byington <carl@five-ten-sg.com> |
---|---|
date | Tue, 08 Jul 2014 11:16:30 -0700 |
parents | 70ecbf70eadb |
children | c6157535e180 |
rev | line source |
---|---|
0 | 1 <reference> |
2 <title>@PACKAGE@ - Version @VERSION@</title> | |
3 <partintro> | |
4 <title>Packages</title> | |
5 | |
6 <para> | |
7 The various source and binary packages are available at <ulink | |
8 url="http://www.five-ten-sg.com/@PACKAGE@/packages/">http://www.five-ten-sg.com/@PACKAGE@/packages/</ulink>. | |
9 The most recent documentation is available at <ulink | |
10 url="http://www.five-ten-sg.com/@PACKAGE@/">http://www.five-ten-sg.com/@PACKAGE@/</ulink>. | |
11 </para> | |
12 | |
13 <para> | |
14 A <ulink url="http://www.selenic.com/mercurial/wiki/">Mercurial</ulink> source | |
15 code repository for this project is available at <ulink | |
16 url="http://hg.five-ten-sg.com/@PACKAGE@/">http://hg.five-ten-sg.com/@PACKAGE@/</ulink>. | |
17 </para> | |
18 | |
19 <para> | |
20 A companion terminal monitor project is available at <ulink | |
21 url="http://www.five-ten-sg.com/510ConnectbotMonitor">http://www.five-ten-sg.com/510ConnectbotMonitor</ulink> | |
22 </para> | |
23 </partintro> | |
24 | |
25 <refentry id="x@PACKAGE@.1"> | |
26 <refentryinfo> | |
150 | 27 <date>2014-06-22</date> |
0 | 28 <author> |
29 <firstname>Carl</firstname> | |
30 <surname>Byington</surname> | |
31 <affiliation><orgname>510 Software Group</orgname></affiliation> | |
32 </author> | |
33 </refentryinfo> | |
34 | |
35 <refmeta> | |
36 <refentrytitle>@PACKAGE@</refentrytitle> | |
37 <manvolnum>1</manvolnum> | |
38 <refmiscinfo>@PACKAGE@ @VERSION@</refmiscinfo> | |
39 </refmeta> | |
40 | |
41 <refnamediv id='name.1'> | |
42 <refname>@PACKAGE@</refname> | |
73
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
43 <refpurpose>an android vt320/tn5250 terminal emulator for telnet/ssh connections</refpurpose> |
0 | 44 </refnamediv> |
45 | |
46 <refsect1 id='build.1'> | |
47 <title>Build method</title> | |
48 <para> | |
49 This is an android project with native code, so | |
50 "ndk-build clean; ndk-build; android update project -p . -t android-16; ant debug" | |
51 should build cleanly. | |
52 </para> | |
53 </refsect1> | |
54 | |
55 <refsect1 id='introduction.1'> | |
56 <title>Introduction</title> | |
57 <para> | |
58 I belive that the previous connectbot projects are improperly licensed. | |
59 They contain a mix of Apache 2.0 and GPLv2+ code, and those two licenses | |
60 are incompatible. I have relicensed this as GPLv3+, since that is | |
61 compatible with the licenses of all the sub-parts. | |
62 </para> | |
63 <para> | |
73
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
64 This fork extends previous connectbot projects in two ways. It includes |
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 | 68 </para> |
69 </refsect1> | |
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'> |
4fdf6b5a6f43
update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents:
206
diff
changeset
|
72 <title>Changes from previous Connectbots</title> |
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> |
220
4fdf6b5a6f43
update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents:
206
diff
changeset
|
75 The soft function keypad can generate all 24 function keys |
4fdf6b5a6f43
update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents:
206
diff
changeset
|
76 for 5250 emulation. A hardware button can be configured to |
4fdf6b5a6f43
update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents:
206
diff
changeset
|
77 display that function keypad. |
221
70ecbf70eadb
document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents:
220
diff
changeset
|
78 </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
|
79 |
221
70ecbf70eadb
document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents:
220
diff
changeset
|
80 <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
|
81 A deployment.connections text file is read (and deleted) on |
4fdf6b5a6f43
update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents:
206
diff
changeset
|
82 startup. This may be used to preconfigure the global options |
4fdf6b5a6f43
update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents:
206
diff
changeset
|
83 and to create an initial set of host connections. |
221
70ecbf70eadb
document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents:
220
diff
changeset
|
84 </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
|
85 |
221
70ecbf70eadb
document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents:
220
diff
changeset
|
86 <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
|
87 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
|
88 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
|
89 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
|
90 </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
|
91 </itemizedlist> |
4fdf6b5a6f43
update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents:
206
diff
changeset
|
92 </refsect1> |
4fdf6b5a6f43
update to 1.8.4; document changes from previous forks
Carl Byington <carl@five-ten-sg.com>
parents:
206
diff
changeset
|
93 |
0 | 94 <refsect1 id='monitor.1'> |
95 <title>Terminal Monitor</title> | |
96 <para> | |
73
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
97 For every terminal session (local, telnet, ssh or tn5250), this |
0 | 98 terminal emulator also makes a connection to a terminal monitor |
150 | 99 process, which can see cursor movement and screen contents, and can |
0 | 100 inject characters to send to the host. |
101 </para> | |
102 | |
103 <para> | |
104 The terminal monitor is invoked by calling an android Intent | |
105 named "com.five_ten_sg.connectbot.monitor.MonitorService". That | |
106 ensures that the monitor process is running, and should then | |
107 be listening on TCP port 6000 for incoming connections. The terminal | |
108 emulator then connects to the terminal monitor on port 6000. | |
109 The native android Intent and Service communication mechanisms | |
110 are not used. | |
111 </para> | |
112 | |
113 <para> | |
114 The messages exchanged between the terminal emulator and the | |
115 terminal monitor are arrays of uint16 values in network byte | |
116 order. Each message starts with a uint16 message byte length, | |
117 followed by that many bytes of data. Note that the message length | |
118 will always be even. The next uint16 contains the message | |
119 command value, and the remaining uint16 values are the arguments | |
120 if any for that command. | |
121 </para> | |
122 | |
123 <para> | |
124 Any arguments that are keystrokes or characters are represented | |
125 as 16 bit unicode. Note that the first 256 such characters are | |
126 identical to the ISO-8859-1 latin character set. | |
127 </para> | |
128 | |
129 <para> | |
130 INIT = 0 (TE -> Monitor). The argument is a string of uint16 | |
131 characters. The meaning of these characters is defined by the | |
132 monitor. It might be a fully qualified path name, or some other | |
133 data used by the monitor to drive the monitoring of this | |
134 connection. | |
135 </para> | |
136 | |
137 <para> | |
138 ACTIVATE = 1 (TE -> Monitor). The first argument is the | |
139 number of lines. The second argument is the number of columns. | |
140 That is followed by lines*columns uint16 character codes. | |
141 This connection is now the active connection. It is the | |
142 topmost (or only) window visible to the user - typed keystrokes | |
143 will be sent to the host on the other end of this connection. | |
144 </para> | |
145 | |
146 <para> | |
147
1350adb077b1
monitor key state tracking
Carl Byington <carl@five-ten-sg.com>
parents:
73
diff
changeset
|
147 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
|
148 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
|
149 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
|
150 The actual key is configurable. |
0 | 151 </para> |
152 | |
153 <para> | |
154 CURSORMOVE = 3 (TE -> Monitor). | |
155 The first argument is the line number (0..23) | |
156 and the second argument is the column number (0..79). | |
157 </para> | |
158 | |
159 <para> | |
160 SCREENCHANGE = 4 (TE -> Monitor). The first argument is the | |
161 number of lines. The second argument is the number of columns. | |
162 That is followed by lines*columns uint16 character codes. | |
163 </para> | |
164 | |
165 <para> | |
166 FIELDVALUE = 5 (TE -> Monitor). | |
167 SETFIELD = 5 (Monitor -> TE). | |
168 The first argument is the line number (0..23) | |
169 and the second argument is the column number (0..79). | |
170 That is followed by the field value, a sequence of uint16 | |
171 character codes from the screen buffer. The field | |
172 covers N columns, where N = (message length - 4) / 2. | |
173 When sent from the monitor to the emulator, this causes | |
174 the emulator to send the field codes to the host. This is | |
175 also used as the reply message from the emulator to the | |
176 monitor for a previous GETFIELD from the monitor. | |
177 </para> | |
178 | |
179 <para> | |
180 GETFIELD = 6 (Monitor -> TE). | |
181 The first argument is the line number (0..23) | |
182 and the second argument is the starting column number (0..79), | |
183 and the third argument is the field length in columns. | |
184 This command causes the emulator to send a FIELDVALUE message | |
185 back to the monitor. | |
186 </para> | |
187 | |
188 <para> | |
189 SCREENWATCH = 7 (Monitor -> TE). | |
190 The first argument is the line number (0..23) | |
191 and the second argument is the starting column number (0..79), | |
192 and the third argument is the field length in columns. | |
193 This command causes the emulator to watch the specified | |
194 part of the screen for changes. When that part of the screen | |
195 changes, the emulator will send a SCREENCHANGE message back | |
196 to the monitor. | |
197 </para> | |
198 | |
199 <para> | |
200 DEPRESS = 8 (Monitor -> TE). The argument is a single uint16 | |
201 value containing the vk_key value. This command causes the emulator | |
202 to simulate a keypress for that key. The codes are defined | |
160
4bccac50fd0b
update version number and documentation
Carl Byington <carl@five-ten-sg.com>
parents:
150
diff
changeset
|
203 <ulink url="http://msdn.microsoft.com/en-us/library/windows/desktop/dd375731">here</ulink>. |
4bccac50fd0b
update version number and documentation
Carl Byington <carl@five-ten-sg.com>
parents:
150
diff
changeset
|
204 </para> |
4bccac50fd0b
update version number and documentation
Carl Byington <carl@five-ten-sg.com>
parents:
150
diff
changeset
|
205 |
4bccac50fd0b
update version number and documentation
Carl Byington <carl@five-ten-sg.com>
parents:
150
diff
changeset
|
206 <para> |
4bccac50fd0b
update version number and documentation
Carl Byington <carl@five-ten-sg.com>
parents:
150
diff
changeset
|
207 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
|
208 of uint16 character codes forming a URL to be displayed. |
0 | 209 </para> |
206
f60d4b1e8c39
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
160
diff
changeset
|
210 |
f60d4b1e8c39
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
160
diff
changeset
|
211 <para> |
f60d4b1e8c39
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
160
diff
changeset
|
212 SWITCHSESSION = 10 (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
|
213 should display this session. |
f60d4b1e8c39
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
160
diff
changeset
|
214 </para> |
f60d4b1e8c39
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
160
diff
changeset
|
215 |
f60d4b1e8c39
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
160
diff
changeset
|
216 <para> |
f60d4b1e8c39
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
160
diff
changeset
|
217 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
|
218 should send a CURSORMOVE update to the monitor. Cursor movement caused |
f60d4b1e8c39
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
160
diff
changeset
|
219 by SETFIELD or DEPRESS commands does not trigger CURSORMOVE updates |
f60d4b1e8c39
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
160
diff
changeset
|
220 in block mode (tn5250) sessions. Those commands do trigger CURSORMOVE |
f60d4b1e8c39
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
160
diff
changeset
|
221 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
|
222 </para> |
0 | 223 </refsect1> |
224 | |
225 <refsect1 id='todo.1'> | |
226 <title>TODO</title> | |
227 <para> | |
73
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
228 The tn5250 ssl/tls key storage should use the same storage mechanism |
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
229 as the base ssh key storage. |
0 | 230 </para> |
231 </refsect1> | |
232 | |
233 <refsect1 id='copyright.1'> | |
234 <title>Copyright</title> | |
235 <para> | |
236 Copyright (C) 2014 by 510 Software Group <carl@five-ten-sg.com> | |
237 </para> | |
238 <para> | |
239 This program is free software; you can redistribute it and/or modify it | |
240 under the terms of the GNU General Public License as published by the | |
241 Free Software Foundation; either version 3, or (at your option) any | |
242 later version. | |
243 </para> | |
244 <para> | |
245 You should have received a copy of the GNU General Public License along | |
246 with this program; see the file COPYING. If not, please write to the | |
247 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
248 </para> | |
249 </refsect1> | |
250 | |
251 <refsect1 id='credits.1'> | |
252 <title>Credits</title> | |
253 <para> | |
254 Based on VX Connectbot provided under the Apache | |
255 License, Version 2.0. Copyright (C) 2012 Martin | |
256 Matuska http://connectbot.vx.sk | |
257 </para> | |
258 <para> | |
259 Based on Irssiconnectbot provided under the Apache | |
260 License, Version 2.0. Copyright (C) 2013 | |
261 Iiro Uusitalo and Ville Kerminen | |
262 https://github.com/irssiconnectbot/irssiconnectbot | |
263 </para> | |
264 <para> | |
265 Based on ConnectBot provided under the Apache License, | |
266 Version 2.0. Copyright (C) 2007-2008 Kenny Root | |
267 http://the-b.org and Jeffrey Sharkey http://jsharkey.org | |
268 </para> | |
269 <para> | |
270 Based on the Trilead SSH2 client provided | |
271 under a BSD-style license. Copyright (C) 2007 Trilead | |
272 AG. http://www.trilead.com | |
273 </para> | |
274 <para> | |
275 Based on JTA Telnet/SSH client provided under the | |
276 GPLv2 license. Copyright (C) 1996-2005 Matthias L. Jugel and | |
277 Marcus Meiner. http://www.javassh.org | |
278 </para> | |
279 <para> | |
73
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
280 Based on TN5250J terminal emulator provided under the GPLv2 |
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
281 license. Copyright (C) 2001 Kenneth J. Pouncey. |
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
282 http://tn5250j.sourceforge.net/ |
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
283 </para> |
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
284 <para> |
0 | 285 Includes the JSOCKS library, provided |
286 under the GNU LGPL license. http://jsocks.sourceforge.net | |
287 </para> | |
288 <para> | |
289 Includes JZlib provided under a BSD-style | |
290 license. Copyright (C) 2000-2004 JCraft, Inc. | |
291 http://www.jcraft.com | |
292 </para> | |
293 <para> | |
294 Includes the ssh-agent service developed by Roberto | |
295 Tyley https://github.com/rtyley | |
296 </para> | |
297 <para> | |
298 SCP file transfer support is based on | |
299 https://github.com/staktrace/connectbot/commits/filetransfer | |
300 modifications by Kartikaya Gupta. | |
301 </para> | |
73
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
302 <para> |
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
303 Internal file selection dialog is based on Android File |
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
304 Dialog by Alexander Ponomarev, provided under a BSD-style |
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
305 license. |
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
306 http://code.google.com/p/android-file-dialog |
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
307 </para> |
0 | 308 </refsect1> |
309 | |
310 <refsect1 id='version.1'> | |
311 <title>Version</title> | |
312 <para> | |
313 @VERSION@ | |
314 </para> | |
315 </refsect1> | |
316 </refentry> | |
317 | |
318 </reference> |