reactos/base/applications/network/telnet/doc/readme.txt

   1               **************************************************
   2               ** Console Telnet v2.1b2 README.TXT 16 Oct 2000 **
   3               **************************************************
   4
   5                                RELEASE NOTES:
   6                                --------------
   7
   8 This release of TELNET is a beta one. This means that it is working as far
   9 as it is tested, and has a few bugs. Hopefully this will be a stable
  10 version.  Please send comments and bug reports to me at
  11 pbranna@clemson.edu, or to the mailing list (see below).  See file
  12 CHANGES.TXT for a detailed log of changes.  See file BUGS.TXT for known
  13 bugs.
  14
  15                                 DESCRIPTION:
  16                                 ------------
  17
  18 This is a telnet client with full color ANSI support for Windows NT/95
  19 console. You can use this program from the Win95 command line (MsDos) and
  20 run it in full screen text mode. You may also redirect the telnet session
  21 to STDIN and STDOUT for use with other programs.  Telnet will communicate
  22 the number of lines and rows to the host, and can operate in any console
  23 mode.  Most of it's options are customizable.
  24
  25
  26                          COPYRIGHT/LICENSE/WARRANTY
  27                          --------------------------
  28
  29 Telnet Win32, Copyright (C) 1996-1997, Brad Johnson <jbj@nounname.com>
  30 Copyright (C) 1998 I.Ioannou, Copyright (C) 1999-2000 Paul Brannan.  Telnet
  31 is a free project released under the GNU public license.  This program comes
  32 with ABSOLUTELY NO WARRANTY.  This is free software, and you are welcome
  33 to redistribute it under the licence contitions.  See LICENSE.TXT for
  34 details.
  35
  36                                 REQUIREMENTS:
  37                                 -------------
  38
  39 This program requires a Microsoft Win32 enviroment (Windows 95/98/NT) with
  40 Winsock TCP/IP.  16 bit Win3.x or Win32s are not supported.
  41
  42                                   FEATURES:
  43                                   ---------
  44
  45 Full ANSI colors and (almost) complete ANSI emulation.
  46 User configurable options via telnet.ini.
  47 User configurable key bindings with alternative keyboards.
  48 Icoming character translations.
  49 Redirection of telnet session.
  50 Telnet output can be dumped to a file.
  51 Local printer support.
  52 Basic scrollback support.
  53 Basic VT emulation.
  54 Mouse support.
  55 Clipboard (cut-and-paste) support.
  56 Support for multiple screen sizes.
  57
  58                               WHERE TO GET IT:
  59                               ----------------
  60
  61 Since version 2.0, Console Telnet's new home page is
  62 http://www.musc.edu/~brannanp/telnet/.  You can get the latest version from
  63 ftp://argeas.cs-net.gr/Telnet-Win32 or from the web page.  Telnet is
  64 available as full project (sources included) or as binaries only.  If you
  65 would like to help to the development check the /devel directory on the ftp
  66 site for a recent alpha version.
  67
  68                                 MAILING LIST:
  69                                 -------------
  70
  71 Telnet has it's own mailing list for announcements, bug reports, support,
  72 suggestions etc. To subscribe send e-mail to majordomo@argeas.cs-net.gr
  73 with empty Subject, and the word subscribe in the body. List's address is
  74 telnet-win32@argeas.cs-net.gr You can find the old archives at
  75 http://www.cs-net.gr/lists
  76
  77 If you are only interested in announcements, follow the above procedures to
  78 subscribe to telnet-win32-announce.  The development list is
  79 telnet-win32-devel.
  80
  81                                 HOW TO HELP:
  82                                 ------------
  83
  84 Telnet is a free project made from volunteers. If you know C/C++ and would
  85 like to help in the development you are welcome :-)  Just contact
  86 pbranna@clemson.edu, and/or subscribe to the mailing list.  Check
  87 ftp://argeas.cs-net.gr/Telnet-Win32/devel for a recent alpha version.
  88
  89
  90                                 INSTALLATION
  91                                 ------------
  92
  93 Just copy telnet.exe, telnet.ico, telnet.ini and keys.cfg to a directory.
  94 I prefer a directory included in the PATH (such as C:\WINDOWS, but this will
  95 overwrite the telnet that comes with Windows -- which is not necessarily a
  96 bad thing). If you are upgrading from a previous version please look below
  97 (Key file definitions) : the keys.cfg file has changed a bit. Also look at
  98 the Configuration section below, TELNET now has a ini file.
  99
 100                                    USAGE:
 101                                    -------
 102
 103   TELNET
 104     Begins telnet and enters telnet> command line.
 105
 106   TELNET [params][host [port]]
 107     Connects to port on host. Port defaults to 23 for TELNET.
 108
 109     params    -d FILENAME.EXT    Dumps all incoming data to FILENAME.EXT
 110                                  Note lowercase 'd'.
 111               --variable=value   Overrides ini variable to be set to value.
 112
 113     host                         Host name or IP to connect to
 114     port                         Service port to open connection on
 115                                  (default is telnet port 23).
 116
 117   TELNET -?
 118     Gives usage information.
 119
 120 Pressing the escape key (default ALT-]) will break out of a telnet session and
 121 return you to the telnet> prompt. Pressing return will resume your session.
 122 All the options are available from the telnet> prompt. Type ? to get help.
 123
 124 Pressing the scrollback key (default ALT-[) will give you a basic scrollback
 125 view. Pressing ESC will resume your session.
 126
 127                                    BUGS:
 128                                    -----
 129
 130 There are :-). Hopefully this version is more stable than the previous. See
 131 BUGS.TXT, and grep for FIX ME's in the sources. Any help ?
 132
 133                                    NOTES:
 134                                    ------
 135
 136 If the environment variable LANG has a valid value (e.g. LANG=de for German
 137 characters) and the file LOCALE.DLL is installed somewhere along the PATH
 138 TELNET will not ignore local characters.
 139
 140 If you have problems with paste under Win 95 try unchecking the fast paste
 141 option in the MsDos properties. The paste function works correctly under NT.
 142 This is a Microsoft bug :-)
 143
 144                                 CONFIGURATION
 145                                 -------------
 146
 147 The configuration is made through telnet.ini and keys.cfg. These files (at
 148 least telnet.ini) must be in the same directory which telnet.exe is.  The
 149 basic options are loaded from the file telnet.ini. If you are having problems
 150 with a terminal setting, check the file OPTIONS.TXT for configuration
 151 information.
 152
 153
 154 Key file definitions (telnet.cfg)
 155 -------------------------------
 156
 157 Use the key file (telnet.cfg) to define the characters that telnet is sending
 158 to the host.  From version 2b5 you can configure the output keys (KEYMAP
 159 sections), the input character translations (CHARMAP sections) and you can
 160 combine all to as many configurations as you like (CONFIG sections). You
 161 can also have alternative keymaps in a configuration, and keys to switch
 162 between them.  See the comments in keys.cfg for details.
 163
 164 NOTE: if you are upgrading from a previous version you must put your old keys
 165 in the KEYMAP sections.
 166 Please send any national specific keymaps / charmaps / configurations to be
 167 included to the next version.
 168
 169
 170                               HOW TO COMPILE IT
 171                              -------------------
 172
 173 Telnet compiles with a variety of compilers.  You will need at least
 174 Borland 4.x or newer compiler, or MSVC 2.0 or newer, or download a version
 175 of gcc for Win32 (see http://www.musc.edu/~brannanp/telnet/gccwin32.html).
 176 Copy the files from the directories BORLAND or MSVC to the main directory,
 177 change them to fit to your system, and recompile.  The project comes with
 178 IDE files and makefiles.
 179
 180 Follow the instructions for your compiler to compile telnet.  A Makefile
 181 for use with mingw32 or other gcc variants has been included, so if you have
 182 gcc, you can just type "make" at the command line.
 183
 184                                SPECIAL THANKS:
 185                                ---------------
 186
 187 Many people have worked for this project. Please forgive me (and let me
 188 know!) if I have forgotten anyone. We all thank them :-)
 189
 190 Igor Milavec <igor.milavec@uni-lj.si>
 191         Original Author of version 1.1
 192         Igor wrote the basic telnet program and released it to public.
 193
 194 Brad Johnson <jbj@nounname.com>  http://nounname.com
 195         Author of versions 2.0b to 2b4. Brad has wrote plenty of code for
 196         telnet like ansi colors, emulation, scrollback option, and many
 197         others.
 198
 199 Titus_Boxberg@public.uni-hamburg.de
 200         Ansi emulation improvements
 201         German keyboard configuration
 202
 203 I.Ioannou roryt@hol.gr
 204         KeyTranslator class (version 2b3)
 205         Maintainer (since version 2b5)
 206
 207 Andrei V. Smilianets <smile@head.aval.kiev.ua> (version 2b5)
 208         KeyTranslator class (version 2b5)
 209         Prompt improvments
 210
 211 Paul Brannan <pbranna@clemson.edu>
 212         Telnet.ini author, MSVC port, speed improvements, VT support,
 213         and many others.
 214         Maintainer (since version 2b6)
 215
 216 Leo Leibovici <leo.leibovici@nouveau.co.uk>
 217         Fixed some crashes in the ANSI parser
 218         Wrote UK keymap
 219
 220 Dmitry Lapenkov <dl@bis.msk.su>
 221         Wrote AT386 keymaps
 222         Improved telnet icon
 223
 224 Thomas Briggs <tbriggs@qmetric.com>
 225         Fixed problem with Ctrl-Break
 226         Added suspend and fast quit options to the command line
 227         Error messages for unable to load ini file
 228         Fixed bug w/ getting name of executable
 229
 230 BK Oxley
 231         Fixed TELNET_INI environment variable
 232
 233 Sam Robertson
 234         Fixed compilation problems with MSVC6
 235         Bugfix with telnet crashing at exit
 236
 237 Vassili Bourdo <vassili_bourdo@softhome.net>
 238         Keyboard initialization improvements
 239
 240 Craig Davidson <crn@ozemail.com.au>
 241         Bugfixes for telnet prompt
 242         Added suspend telnet option
 243         Set port number using name rather than number
 244
 245 Pedro Gutierrez <paag@coppi.tid.es>
 246         Save/restore console title
 247         Bugfix w/ character mapping
 248
 249 Daniel Straub <Daniel.Straub@nbgm.siemens.de>
 250         Bugfix with telnet crashing at exit
 251
 252 Jose Cesar Otero Rodriguez <jcotero@las.es>
 253         Spanish Keyboard definition
 254         Cursor size sequences
 255
 256 Bryan Montgomery <monty@english.net>
 257         Added CtrlBreak_as_CtrlC option
 258         Added Scroll_Enable option
 259
 260 Adi Seiker
 261         Added Set_Title ini file option
 262
 263 Craig Nellist
 264         Updated Winsock error messages
 265         Sleeping while thread paused, to give up CPU time
 266         Command-line history
 267
 268 Jakub Sterba
 269         Czech keyboard definition
 270
 271 Ziglio Frediano
 272         MTE (Meridian Terminal) Support
 273
 274 Mark Miesfield
 275         Fixed redirection
 276         Wrote documentation for redirection
 277
 278 ---
 279
 280 Paul Brannan <pbranna@clemson.edu>