base/applications/network/telnet/doc/options.txt

   1 This file describes all the environment variables and options that are
   2 available in TELNET.INI.  If you are having problems with a terminal setting,
   3 this is the file you want to read first.  If this file does not help you,
   4 please send a bug report to Paul Brannan <pbranna@clemson.edu>.
   5
   6 Environment variables
   7 ---------------------
   8
   9 Before there was a telnet.ini file, all the options were controlled
  10 through environment variables.  These have been left in for compatibility
  11 with previous versions, and for specifying locations of files.  They
  12 override any values in telnet.ini.
  13
  14 TELNET_CFG      Specifies the location of the keys.cfg file
  15 TELNET_REDIR    Specifies whether file redirection needs to be supported
  16 INPUT_REDIR     Specicies only to redirect input
  17 OUTPUT_REDIR    Specifies only to redirect output
  18 TELNET_INI      Specifies the location of the telnet.ini file
  19
  20 Configuration options
  21 ---------------------
  22
  23 These are the options that you can specify in telnet.ini.  This file is in
  24 the same format as any normal Windows ini file.  You can also change some
  25 of these options using the SET command at the telnet> prompt.
  26
  27 [Terminal] section
  28
  29 Dumpfile
  30 Specifies the filename of a file to dump output to.  (Default = "")
  31
  32 Term
  33 The name of the terminal type to send to the server.  You
  34 can use this if Telnet is sending "ANSI" but you have a
  35 vt100 terminal.  If you use this options, please read about
  36 some of the other options below.  (Default = ansi)
  37
  38 EightBit_Ansi
  39 Some machines use the ASCII characters 128 to 155 for ANSI
  40 sequences.  These are usually the newer VAX systems.  Turning
  41 this option on may cause problems with certain foreign
  42 (non-American) character sets.  (Default = FALSE)
  43
  44 VT100_Mode
  45 This option turns on VT100 mode.  There are a few minor
  46 differences between ANSI terminals and DEC VT100 terminals.
  47 I recommend trying TERM=vt220 or TERM=vt102 before trying
  48 this option, but if you must have true VT100 emulation,
  49 this is the only way to get it.  (Default = FALSE)
  50
  51 Destructive_Backspace
  52 This will probably cause problems with most programs, but if you need the
  53 backspace to erase the previous character (as with some BBSes), use this
  54 option.  (Default = FALSE)
  55
  56 Speaker_Beep
  57 If you set this to true you will hear beeps through the PC speaker; setting
  58 it to false will play the default system beep sound through your sound
  59 card.  (Default = TRUE)
  60
  61 Beep
  62 Setting this to false turns off all beeps; setting this to true turns on
  63 all beeps.  (Default = TRUE)
  64
  65 Preserve_Colors
  66 This turns on color preservation for systems that require it (like SCO).
  67 (Default = FALSE)
  68
  69 Wrap_line
  70 This turns on/off line wrap.  (Default = TRUE)
  71
  72 Lock_linewrap
  73 Turning on this option disables the ability of the remote end to control
  74 line wrap, and "locks" it into whatever it is set to in the ini file.
  75 (Default = FALSE)
  76
  77 Fast_write
  78 This turns on/off fast screen write.  Turning it off allows you to see
  79 control characters if your application requires it.  (Default = TRUE)
  80
  81 Term_width
  82 Term_height
  83 These options specify the size of the terminal.  You can specify non-standard
  84 sizes if you are running telnet in a window.  You may want to specify
  85 a font size if you use these (using "Auto" can cause display problems).
  86 Specifying -1 means use the settings for the parent console.
  87 (Default = -1, -1)
  88
  89 Wide_enable
  90 This is to allow the ANSI parser to change the screen size when sent certain
  91 escape sequences.  This is for vt100 compatibility.  (Default = FALSE)
  92
  93 Buffer_size
  94 This is the size of the ANSI buffer used for parsing sequences.  Increasing
  95 this value speeds up the parser, and decreasing it allows the mouse to
  96 respond faster.  (Default = 2048)
  97
  98 Input_redir
  99 Output_redir
 100 These are for redirecting input and output.  (Default = 0, 0)
 101 Any value greater than 0 turns redir on.  Turn Output_redir on to bypass
 102 the Console Telnet screen writing and positioning functions and simply
 103 pass the data stream as received from the host straight through.
 104
 105 Strip_redir
 106 If enabled, this option will attempt to strip the stream before passing it on
 107 through redirected output.  This will have no effect on non-redirected output.
 108 (Default=FALSE)
 109
 110 [Colors] section
 111
 112 Setting the following to -1 disables them:
 113 Blink_bg                Background color to use for blink (default = -1)
 114 Blink_fg                Foreground color to use for blink (default = -1)
 115 Underline_bg            Background color to use for underline (default = -1)
 116 Underline_fg            Foreground color to use for underline (default = -1)
 117 UlBlink_bg              Background color to use for blink+uline (default = -1)
 118 UlBlink_fg              Foreground color to use for blink+uline (default = -1)
 119
 120 Setting the following to -1 uses colors detected at startup:
 121 Normal_bg               Normal text background color (default = -1)
 122 Normal_fg               Normal text foreground color (default = -1)
 123
 124 Please do not set these values to -1:
 125 Scroll_bg               Background color for scrollback mode (default = 0)
 126 Scroll_fg               Foreground color for scrollback mode (default = 7)
 127 Status_bg               Bg color of status line in scrollback (default = 1)
 128 Status_fg               Fg color of status line in scrollback (default = 15)
 129
 130 Here's a list of colors:
 131 0 - black, 1 - blue, 2 - green, 3 - cyan, 4 - red, 5 - magenta, 6 - brown
 132 7 - lt. grey (dk. white), 8 - dk. grey, 9 - bright blue, 10 - bright green,
 133 11 - bright cyan, 12 - bright red, 13 - bright magenta, 14 - yellow
 134 15 - bright white
 135
 136 [Mouse] section
 137
 138 Enable_Mouse
 139 Turns on mouse support.  (Default = TRUE)
 140
 141 [Printer] section
 142
 143 Printer_Name
 144 The DOS name for the printer.  (Default = LPT1)
 145
 146 [Keyboard] section
 147 Many of these options are also available from telnet.cfg.
 148
 149 Escape_key
 150 The key to break out of a telnet session.  (Default = ])
 151
 152 Scrollback_key
 153 The key for switching to scrollback mode.  (Default = [)
 154
 155 Dial_key
 156 You can start a new telnet session with this key.  (Default = \)
 157
 158 Alt_erase
 159 If you set this to true, it will swap backspace and delete.
 160 (Default = FALSE)
 161
 162 Keyboard_paste
 163 This option allows pasting to the screen via shift-insert.  (Default = FALSE)
 164
 165 Keyfile
 166 Selects an alternate telnet.cfg file.  (Default = TELNET.CFG)
 167
 168 Default_Config
 169 Selects a different keyboard definition.  All of these are defined in
 170 telnet.cfg.
 171
 172 [Scrollback] section
 173
 174 Scroll_Mode
 175 Selects the default mode for scrollback.  Valid selections are:
 176         HEX             Hex dump
 177         DUMP            Dump, control characters are shown as "."
 178         DUMPB           Binary dump
 179         TEXT            Text mode
 180 Note: you can press TAB in scrollback mode to cycle through these.
 181 (Default = DUMP)
 182
 183 Command-line Options
 184 --------------------
 185
 186 -d<filename>    Specifies the name of the dumpfile.
 187 -h              Gives a help screen.