Mercurial > 510Connectbot
annotate xml/510connectbot.in @ 175:2a7199ad90be
send cursor movement caused by user keystrokes to the monitor
| author | Carl Byington <carl@five-ten-sg.com> |
|---|---|
| date | Wed, 02 Jul 2014 10:13:15 -0700 |
| parents | 4bccac50fd0b |
| children | f60d4b1e8c39 |
| 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 | |
| 71 <refsect1 id='monitor.1'> | |
| 72 <title>Terminal Monitor</title> | |
| 73 <para> | |
|
73
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
74 For every terminal session (local, telnet, ssh or tn5250), this |
| 0 | 75 terminal emulator also makes a connection to a terminal monitor |
| 150 | 76 process, which can see cursor movement and screen contents, and can |
| 0 | 77 inject characters to send to the host. |
| 78 </para> | |
| 79 | |
| 80 <para> | |
| 81 The terminal monitor is invoked by calling an android Intent | |
| 82 named "com.five_ten_sg.connectbot.monitor.MonitorService". That | |
| 83 ensures that the monitor process is running, and should then | |
| 84 be listening on TCP port 6000 for incoming connections. The terminal | |
| 85 emulator then connects to the terminal monitor on port 6000. | |
| 86 The native android Intent and Service communication mechanisms | |
| 87 are not used. | |
| 88 </para> | |
| 89 | |
| 90 <para> | |
| 91 The messages exchanged between the terminal emulator and the | |
| 92 terminal monitor are arrays of uint16 values in network byte | |
| 93 order. Each message starts with a uint16 message byte length, | |
| 94 followed by that many bytes of data. Note that the message length | |
| 95 will always be even. The next uint16 contains the message | |
| 96 command value, and the remaining uint16 values are the arguments | |
| 97 if any for that command. | |
| 98 </para> | |
| 99 | |
| 100 <para> | |
| 101 Any arguments that are keystrokes or characters are represented | |
| 102 as 16 bit unicode. Note that the first 256 such characters are | |
| 103 identical to the ISO-8859-1 latin character set. | |
| 104 </para> | |
| 105 | |
| 106 <para> | |
| 107 INIT = 0 (TE -> Monitor). The argument is a string of uint16 | |
| 108 characters. The meaning of these characters is defined by the | |
| 109 monitor. It might be a fully qualified path name, or some other | |
| 110 data used by the monitor to drive the monitoring of this | |
| 111 connection. | |
| 112 </para> | |
| 113 | |
| 114 <para> | |
| 115 ACTIVATE = 1 (TE -> Monitor). The first argument is the | |
| 116 number of lines. The second argument is the number of columns. | |
| 117 That is followed by lines*columns uint16 character codes. | |
| 118 This connection is now the active connection. It is the | |
| 119 topmost (or only) window visible to the user - typed keystrokes | |
| 120 will be sent to the host on the other end of this connection. | |
| 121 </para> | |
| 122 | |
| 123 <para> | |
|
147
1350adb077b1
monitor key state tracking
Carl Byington <carl@five-ten-sg.com>
parents:
73
diff
changeset
|
124 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
|
125 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
|
126 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
|
127 The actual key is configurable. |
| 0 | 128 </para> |
| 129 | |
| 130 <para> | |
| 131 CURSORMOVE = 3 (TE -> Monitor). | |
| 132 The first argument is the line number (0..23) | |
| 133 and the second argument is the column number (0..79). | |
| 134 </para> | |
| 135 | |
| 136 <para> | |
| 137 SCREENCHANGE = 4 (TE -> Monitor). The first argument is the | |
| 138 number of lines. The second argument is the number of columns. | |
| 139 That is followed by lines*columns uint16 character codes. | |
| 140 </para> | |
| 141 | |
| 142 <para> | |
| 143 FIELDVALUE = 5 (TE -> Monitor). | |
| 144 SETFIELD = 5 (Monitor -> TE). | |
| 145 The first argument is the line number (0..23) | |
| 146 and the second argument is the column number (0..79). | |
| 147 That is followed by the field value, a sequence of uint16 | |
| 148 character codes from the screen buffer. The field | |
| 149 covers N columns, where N = (message length - 4) / 2. | |
| 150 When sent from the monitor to the emulator, this causes | |
| 151 the emulator to send the field codes to the host. This is | |
| 152 also used as the reply message from the emulator to the | |
| 153 monitor for a previous GETFIELD from the monitor. | |
| 154 </para> | |
| 155 | |
| 156 <para> | |
| 157 GETFIELD = 6 (Monitor -> TE). | |
| 158 The first argument is the line number (0..23) | |
| 159 and the second argument is the starting column number (0..79), | |
| 160 and the third argument is the field length in columns. | |
| 161 This command causes the emulator to send a FIELDVALUE message | |
| 162 back to the monitor. | |
| 163 </para> | |
| 164 | |
| 165 <para> | |
| 166 SCREENWATCH = 7 (Monitor -> TE). | |
| 167 The first argument is the line number (0..23) | |
| 168 and the second argument is the starting column number (0..79), | |
| 169 and the third argument is the field length in columns. | |
| 170 This command causes the emulator to watch the specified | |
| 171 part of the screen for changes. When that part of the screen | |
| 172 changes, the emulator will send a SCREENCHANGE message back | |
| 173 to the monitor. | |
| 174 </para> | |
| 175 | |
| 176 <para> | |
| 177 DEPRESS = 8 (Monitor -> TE). The argument is a single uint16 | |
| 178 value containing the vk_key value. This command causes the emulator | |
| 179 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
|
180 <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
|
181 </para> |
|
4bccac50fd0b
update version number and documentation
Carl Byington <carl@five-ten-sg.com>
parents:
150
diff
changeset
|
182 |
|
4bccac50fd0b
update version number and documentation
Carl Byington <carl@five-ten-sg.com>
parents:
150
diff
changeset
|
183 <para> |
|
4bccac50fd0b
update version number and documentation
Carl Byington <carl@five-ten-sg.com>
parents:
150
diff
changeset
|
184 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
|
185 of uint16 character codes forming a URL to be displayed. |
| 0 | 186 </para> |
| 187 </refsect1> | |
| 188 | |
| 189 <refsect1 id='todo.1'> | |
| 190 <title>TODO</title> | |
| 191 <para> | |
|
73
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
192 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
|
193 as the base ssh key storage. |
| 0 | 194 </para> |
| 195 </refsect1> | |
| 196 | |
| 197 <refsect1 id='copyright.1'> | |
| 198 <title>Copyright</title> | |
| 199 <para> | |
| 200 Copyright (C) 2014 by 510 Software Group <carl@five-ten-sg.com> | |
| 201 </para> | |
| 202 <para> | |
| 203 This program is free software; you can redistribute it and/or modify it | |
| 204 under the terms of the GNU General Public License as published by the | |
| 205 Free Software Foundation; either version 3, or (at your option) any | |
| 206 later version. | |
| 207 </para> | |
| 208 <para> | |
| 209 You should have received a copy of the GNU General Public License along | |
| 210 with this program; see the file COPYING. If not, please write to the | |
| 211 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
| 212 </para> | |
| 213 </refsect1> | |
| 214 | |
| 215 <refsect1 id='credits.1'> | |
| 216 <title>Credits</title> | |
| 217 <para> | |
| 218 Based on VX Connectbot provided under the Apache | |
| 219 License, Version 2.0. Copyright (C) 2012 Martin | |
| 220 Matuska http://connectbot.vx.sk | |
| 221 </para> | |
| 222 <para> | |
| 223 Based on Irssiconnectbot provided under the Apache | |
| 224 License, Version 2.0. Copyright (C) 2013 | |
| 225 Iiro Uusitalo and Ville Kerminen | |
| 226 https://github.com/irssiconnectbot/irssiconnectbot | |
| 227 </para> | |
| 228 <para> | |
| 229 Based on ConnectBot provided under the Apache License, | |
| 230 Version 2.0. Copyright (C) 2007-2008 Kenny Root | |
| 231 http://the-b.org and Jeffrey Sharkey http://jsharkey.org | |
| 232 </para> | |
| 233 <para> | |
| 234 Based on the Trilead SSH2 client provided | |
| 235 under a BSD-style license. Copyright (C) 2007 Trilead | |
| 236 AG. http://www.trilead.com | |
| 237 </para> | |
| 238 <para> | |
| 239 Based on JTA Telnet/SSH client provided under the | |
| 240 GPLv2 license. Copyright (C) 1996-2005 Matthias L. Jugel and | |
| 241 Marcus Meiner. http://www.javassh.org | |
| 242 </para> | |
| 243 <para> | |
|
73
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
244 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
|
245 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
|
246 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
|
247 </para> |
|
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
248 <para> |
| 0 | 249 Includes the JSOCKS library, provided |
| 250 under the GNU LGPL license. http://jsocks.sourceforge.net | |
| 251 </para> | |
| 252 <para> | |
| 253 Includes JZlib provided under a BSD-style | |
| 254 license. Copyright (C) 2000-2004 JCraft, Inc. | |
| 255 http://www.jcraft.com | |
| 256 </para> | |
| 257 <para> | |
| 258 Includes the ssh-agent service developed by Roberto | |
| 259 Tyley https://github.com/rtyley | |
| 260 </para> | |
| 261 <para> | |
| 262 SCP file transfer support is based on | |
| 263 https://github.com/staktrace/connectbot/commits/filetransfer | |
| 264 modifications by Kartikaya Gupta. | |
| 265 </para> | |
|
73
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
266 <para> |
|
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
267 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
|
268 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
|
269 license. |
|
accf93be8c12
update documentation; use xterm-256color as default terminal type
Carl Byington <carl@five-ten-sg.com>
parents:
0
diff
changeset
|
270 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
|
271 </para> |
| 0 | 272 </refsect1> |
| 273 | |
| 274 <refsect1 id='version.1'> | |
| 275 <title>Version</title> | |
| 276 <para> | |
| 277 @VERSION@ | |
| 278 </para> | |
| 279 </refsect1> | |
| 280 </refentry> | |
| 281 | |
| 282 </reference> |