Name
Synopsis
Description
Options
Character Sets
NVT (ANSI) Mode
Toggles
Commands
File Transfer
Nested Scripts
Passthru
Proxy
Resources
See Also
Copyrights
Version
The full syntax for host is:
[prefix:]...[LUname@]hostname[:port]
Prepending a P: onto hostname causes the connection to go through the telnet-passthru service rather than directly to the host. See PASSTHRU below.
Prepending an S: onto hostname removes the "extended data stream" option reported to the host. See -tn below for further information.
Prepending an N: onto hostname turns off TN3270E support for the session.
Prepending an L: onto hostname causes tcl3270 to first create an SSL tunnel to the host, and then create a TN3270 session inside the tunnel. (This function is supported only if tcl3270 was built with SSL/TLS support). Note that TLS-encrypted sessions using the TELNET START-TLS option are negotiated with the host automatically; for these sessions the L: prefix should not be used.
A specific LU name to use may be specified by prepending it to the hostname with an `@'. Multiple LU names to try can be separated by commas. An empty LU can be placed in the list with an extra comma.
The hostname may optionally be placed inside square-bracket characters `[' and `]'. This will prevent any colon `:' characters in the hostname from being interpreted as indicating option prefixes or port numbers. This allows numeric IPv6 addresses to be used as hostnames.
On systems that support the forkpty library call, the hostname may be replaced with -e and a command string. This will cause tcl3270 to connect to a local child process, such as a shell.
The port to connect to defaults to telnet. This can be overridden with the -port option, or by appending a port to the hostname with a colon `:'. (For compatability with previous versions of tcl3270 and with tn3270(1), the port may also be specified as a second, separate argument.)
The first part is the base model, which is either 3278 or 3279. 3278 specifies a monochrome (green on black) 3270 display; 3279 specifies a color 3270 display.
The second part is the model number, which specifies the number of rows and columns. Model 4 is the default.
Note: Technically, there is no such 3270 display as a 3279-4 or 3279-5, but most hosts seem to work with them anyway.
The default model is 3278-4.
Some hosts are confused by the -E suffix on the terminal name, and will ignore the extra screen area on models 3, 4 and 5. Prepending an s: on the hostname, or setting the "tcl3270.extended" resource to "false", removes the -E from the terminal name when connecting to such hosts.
The name can also be specified with the "tcl3270.termName" resource.
The default character set is bracket, which is useful for common IBM hosts which use EBCDIC codes 0xAD and 0xBD for the `[' and `]' characters, respectively.
If the host later negotiates to stop functioning in 3270 mode, tcl3270 will return to ANSI emulation.
In NVT mode, tcl3270 supports both character-at-a-time mode and line mode operation. You may select the mode with a menu option. When in line mode, the special characters and operational characteristics are defined by resources:
Mode/Character | Resource | Default |
Translate CR to NL | tcl3270.icrnl | true |
Translate NL to CR | tcl3270.inlcr | false |
Erase previous character | tcl3270.erase | ^? |
Erase entire line | tcl3270.kill | ^U |
Erase previous word | tcl3270.werase | ^W |
Redisplay line | tcl3270.rprnt | ^R |
Ignore special meaning of next character | tcl3270.lnext | ^V |
Interrupt | tcl3270.intr | ^C |
Quit | tcl3270.quit | ^\ |
End of file | tcl3270.eof | ^D |
The names of the toggles for use with the -set and -clear options are as follows:
Option | Name |
Monocase | monoCase |
Blank Fill | blankFill |
Track Cursor | cursorPos |
Trace Data Stream | dsTrace |
Trace Events | eventTrace |
Save Screen(s) in File | screenTrace |
Wraparound | lineWrap |
These names are also used as the first parameter to the Toggle action.
Actions marked with an asterisk (*) may block, sending data to the host and possibly waiting for a response.
Ascii | return entire screen contents in ASCII |
Ascii length | return screen contents at cursor in ASCII |
Ascii row col length | return screen contents in ASCII |
Ascii row col rows cols | return screen region in ASCII |
AsciiField | return current field in ASCII |
*Attn | attention key |
BackSpace | move cursor left (or send ASCII BS) |
BackTab | tab to start of previous input field |
CircumNot | input "^" in NVT mode, or "¬" in 3270 mode |
*Clear | clear screen |
Cols | report screen size |
*Connect host | connect to host |
*CursorSelect | Cursor Select AID |
Delete | delete character under cursor (or send ASCII DEL) |
DeleteField | delete the entire field |
DeleteWord | delete the current or previous word |
*Disconnect | disconnect from host |
Down | move cursor down |
Dup | duplicate field |
Ebcdic | return entire screen contents in EBCDIC |
Ebcdic length | return screen contents at cursor in EBCDIC |
Ebcdic row col length | return screen contents in EBCDIC |
Ebcdic row col rows cols | return screen region in EBCDIC |
EbcdicField | return current field in EBCDIC |
*Enter | Enter AID (or send ASCII CR) |
Erase | erase previous character (or send ASCII BS) |
EraseEOF | erase to end of current field |
EraseInput | erase all input fields |
FieldEnd | move cursor to end of field |
FieldMark | mark field |
HexString hex_digits | insert control-character string |
Home | move cursor to first input field |
Insert | set insert mode |
*Interrupt | send TELNET IP to host |
Key keysym | insert key keysym |
Key 0xxx | insert key with ASCII code xx |
Left | move cursor left |
Left2 | move cursor left 2 positions |
MonoCase | toggle uppercase-only mode |
MoveCursor row col | move cursor to (row,col) |
Newline | move cursor to first field on next line (or send ASCII LF) |
NextWord | move cursor to next word |
*PA n | Program Attention AID (n from 1 to 3) |
*PF n | Program Function AID (n from 1 to 24) |
PreviousWord | move cursor to previous word |
Quit | exit tcl3270 |
Redraw | redraw window |
Reset | reset locked keyboard |
Right | move cursor right |
Right2 | move cursor right 2 positions |
ReadBuffer Ascii | dump screen buffer in ASCII |
ReadBuffer Ebcdic | dump screen buffer in EBCDIC |
Rows | report screen size |
Snap | same as Snap Save |
Snap Ascii | report saved screen data (see Ascii) |
Snap Cols | report saved screen size |
Snap Ebcdic | report saved screen data (see Ebcdic) |
Snap ReadBuffer | report saved screen data (see ReadBuffer) |
Snap Rows | report saved screen size |
Snap Save | save screen image |
Snap Status | report saved connection status |
*Snap Wait [timeout] Output | wait for host output and save screen image |
Status | report connection status |
*String string | insert string (simple macro facility) |
*SysReq | System Request AID |
Tab | move cursor to next input field |
set|clear]>Toggle option[ | toggle an option |
ToggleInsert | toggle insert mode |
ToggleReverse | toggle reverse-input mode |
*Transfer option=value... | file transfer |
Up | move cursor up |
*Wait [timeout] 3270mode | wait for 3270 mode |
*Wait [timeout] Disconnect | wait for host to disconnect |
*Wait [timeout] InputField | wait for valid input field |
*Wait [timeout] NVTMode | wait for NVT mode |
*Wait [timeout] Output | wait for more host output |
Because of the complexity and number of options for file transfer, the parameters to the Transfer command take the unique form of option=value, and can appear in any order. Note that if the value contains spaces (such as a VM/CMS file name), then the entire parameter must be quoted, e.g., "HostFile=xxx foo a". The options are:
Option | Required? | Default | Other Values |
Direction | No | send | receive |
HostFile | Yes | ||
LocalFile | Yes | ||
Host | No | tso | vm |
Mode | No | ascii | binary |
Cr | No | remove | add, keep |
Exist | No | keep | replace, append |
Recfm | No | fixed, variable, undefined | |
Lrecl | No | ||
Blksize | No | ||
Allocation | No | tracks, cylinders, avblock | |
PrimarySpace | No | ||
SecondarySpace | No | ||
BufferSize | No | 4096 |
The option details are as follows.
\b | Left |
\f | Clear* |
\n | Enter* |
\pan | PA(n)* |
\pfnn | PF(nn)* |
\r | Newline |
\t | Tab |
\T | BackTab |
Note: The strings are in ASCII and converted to EBCDIC, so beware of inserting control codes.
There is also an alternate form of the String command, HexString, which is used to enter non-printing data. The argument to HexString is a string of hexadecimal digits, two per character. A leading 0x or 0X is optional. In 3270 mode, the hexadecimal data represent EBCDIC characters, which are entered into the current field. In NVT mode, the hexadecimal data represent ASCII characters, which are sent directly to the host.
type:host[:port]The supported values for type are:
The special types socks4a and socks5d can also be used to force the proxy server to do the hostname resolution for the SOCKS protocol.
Resource | Default | Option | Purpose |
blankFill | False | -set blankFill | Blank Fill mode |
charset | bracket | -charset | EBCDIC character set |
charset.foo | Definition of character set foo | ||
dsTrace | False | -trace | Data stream tracing |
eof | ^D | NVT-mode EOF character | |
erase | ^H | NVT-mode erase character | |
extended | True | Use 3270 extended data stream | |
eventTrace | False | -trace | Event tracing |
ftCommand | ind$file | Host file transfer command | |
icrnl | False | Map CR to NL on NVT-mode input | |
inlcr | False | Map NL to CR in NVT-mode input | |
intr | ^C | NVT-mode interrupt character | |
kill | ^U | NVT-mode kill character | |
lineWrap | False | -set lineWrap | NVT line wrap mode |
lnext | ^V | NVT-mode lnext character | |
m3279 | (note 1) | -model | 3279 (color) emulation |
monoCase | False | -set monoCase | Mono-case mode |
numericLock | False | Lock keyboard for numeric field error | |
oerrLock | False | Lock keyboard for input error | |
oversize | -oversize | Oversize screen dimensions | |
port | telnet | -port | Non-default TCP port |
quit | ^\ | NVT-mode quit character | |
rprnt | ^R | NVT-mode reprint character | |
secure | False | Disable "dangerous" options | |
termName | (note 2) | -tn | TELNET terminal type string |
traceDir | /tmp | Directory for trace files | |
traceFile | (note 3) | -tracefile | File for trace output |
werase | ^W | NVT-mode word-erase character |
Note 1: m3279 defaults to False. It can be forced to True with the proper -model option.Note 2: The default terminal type string is constructed from the model number, color emulation, and extended data stream modes. E.g., a model 2 with color emulation and the extended data stream option would be sent as IBM-3279-2-E. Note also that when TN3270E mode is used, the terminal type is always sent as 3278, but this does not affect color capabilities.
Note 3: The default trace file is x3trc.pid in the directory specified by the traceDir resource.
If more than one -xrm option is given for the same resource, the last one on the command line is used.
Modifications and original code Copyright © 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 by Paul Mattes.
DFT File Transfer Code Copyright © October 1995 by Dick Altenbern.
RPQNAMES Code Copyright © 2004, 2005 by Don Russell.
Original X11 Port Copyright © 1990 by Jeff Sparkes.
Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation.Copyright © 1989 by Georgia Tech Research Corporation, Atlanta, GA 30332.
All Rights Reserved. GTRC hereby grants public use of this software. Derivative works based on this software must incorporate this copyright notice.