tn3270(1) [bsd man page]
TN3270(1) General Commands Manual TN3270(1) NAME
tn3270 - full-screen remote login to IBM VM/CMS SYNOPSIS
tn3270 sysname DESCRIPTION
Tn3270 permits a full-screen, full-duplex connection from a VAX UNIX machine to an IBM machine running VM/CMS giving the appearance of being logged in directly to the remote machine on an IBM 3270 terminal. Of course you must have an account on the machine to which you wish to connect in order to log in. Tn3270 looks to the user in many respects like the Yale ASCII Terminal Communication System II. Tn3270 is actually a modification of the Arpanet TELNET user interface (see telnet(1)) that interprets and generates raw 3270 control streams. Emulation of the 3270 terminal is done in the Unix process. This emulation involves mapping 3270-style commands from the host into appro- priate sequences to control the user's terminal screen. Tn3270 uses curses(3x) and the /etc/termcap file to do this. The emulation also involves simulating the special 3270 keyboard keys (program function keys, etc.) by mapping sequences of keystrokes from the ASCII key- board into appropriate 3270 control strings. This mapping is terminal dependent and is specified in a description file, /usr/share/misc/map3270, (see map3270(5)) or in an environment variable MAP3270 (see mset(1)). Any special function keys on the ASCII key- board are used whenever possible. If an entry for the user's terminal is not found, tn3270 looks for an entry for the terminal type unknown. If this is not found, tn3270 uses a default keyboard mapping (see map3270(5)). The first character of each special keyboard mapping sequence is either an ASCII escape (ESC), a control character, or an ASCII delete (DEL). If the user types an unrecognized function key sequence, tn3270 sends an ASCII bell (BEL), or a visual bell if defined in the user's termcap entry, to the user's terminal and nothing is sent to the IBM host. If tn3270 is invoked without specifying a remote host system name, it enters local command mode, indicated by the prompt ``tn3270>''. In this mode, tn3270 accepts and executes the following commands: open connect to a remote host close close the current connection quit exit tn3270 z suspend tn3270 status print connection status ? print help information Other common telnet commands are not available in tn3270. Tn3270 command mode may also be entered, after connecting to a host, by typing a special escape character (typically control-C). While in command mode, any host login session is still alive but temporarily suspended. The host login session may be resumed by entering an empty line (press the RETURN key) in response to the command prompt. A session may be terminated by logging off the foreign host, or by typing ``quit'' or ``close'' while in local command mode. FILES
/etc/termcap /usr/share/misc/map3270 AUTHOR
Greg Minshall SEE ALSO
mset(1), telnet(1), termcap(3x), termcap(5), map3270(5), Yale ASCII Terminal Communication System II Program Description/Operator's Manual (IBM SB30-1911) BUGS
Performance is slow and uses system resources prodigiously. Not all 3270 functions are supported, nor all Yale enhancements. 4.3 Berkeley Distribution November 27, 1996 TN3270(1)
Check Out this Related Man Page
MAP3270(5) File Formats Manual MAP3270(5) NAME
map3270 - database for mapping ascii keystrokes into IBM 3270 keys SYNOPSIS
/usr/share/misc/map3270 DESCRIPTION
When emulating IBM-syle 3270 terminals under UNIX (see tn3270(1)), a mapping must be performed between sequences of keys hit on a user's (ascii) keyboard, and the keys that are available on a 3270. For example, a 3270 has a key labeled EEOF which erases the contents of the current field from the location of the cursor to the end. In order to accomplish this function, the terminal user and a program emulating a 3270 must agree on what keys will be typed to invoke the EEOF function. The requirements for these sequences are: 1.) that the first character of the sequence be outside of the standard ascii printable characters; 2.) that no one sequence be an initial part of another (although sequences may share initial parts). FORMAT
The file consists of entries for various terminals. The first part of an entry lists the names of the terminals which use that entry. These names should be the same as in /etc/termcap (see termcap(5)); note that often the terminals from various termcap entries will all use the same map3270 entry; for example, both 925 and 925vb (for 925 with visual bells) would probably use the same map3270 entry. After the names, separated by vertical bars (`|'), comes a left brace (`{'); the definitions; and, finally, a right brace (`}'). The definitions consist of a reserved keyword (see list below) which identifies the 3270 function (extended as defined below), followed by an equal sign (`='), followed by the various ways to generate this particular function, followed by a semi-colon (`;'). Each way is a sequence of strings of printable ascii characters enclosed inside single quotes (`''); various ways (options) are separated by vertical bars (`|'). Inside the single quotes, a few characters are special. A caret (`^') specifies that the next character is the ``control'' character of whatever the character is. So, `^a' represents control-a, ie: hexadecimal 1 (note that `^A' would generate the same code). To generate rubout, one enters `^?'. To represent a control character inside a file requires using the caret to represent a control sequence; simply typing control-A will not work. Note: the ctrl-caret sequence (to generate a hexadecimal 1E) is represented as `^^' (not `^^'). In addition to the caret, a letter may be preceeded by a backslash (`'). Since this has little effect for most characters, its use is usually not recommended. For the case of a single quote (`''), the backslash prevents that single quote from terminating the string. To have the backslash be part of the string, it is necessary to place two backslashes ('\') in the file. In addition, the following characters are special: `E' means an escape character; ` ' means newline; ` ' means tab; ` ' means carriage return. It is not necessary for each character in a string to be enclosed within single quotes. `EEE' means three escape characters. Comments, which may appear anywhere on a line, begin with a hash mark (`#'), and terminate at the end of that line. However, comments can- not begin inside a quoted string; a hash mark inside a quoted string has no special meaning. 3270 KEYS SUPPORTED The following is the list of 3270 key names that are supported in this file. Note that some of the keys don't really exist on a 3270. In particular, the developers of this file have relied extensively on the work at the Yale University Computer Center with their 3270 emulator which runs in an IBM Series/1 front end. The following list corresponds closely to the functions that the developers of the Yale code offer in their product. In the following list, the starred ("*") functions are not supported by tn3270(1). An unsupported function will cause tn3270(1) to send a bell sequence to the user's terminal. 3270 Key Name Functional description (*)LPRT local print DP dup character FM field mark character (*)CURSEL cursor select RESHOW redisplay the screen EINP erase input EEOF erase end of field DELETE delete character INSRT toggle insert mode TAB field tab BTAB field back tab COLTAB column tab COLBAK column back tab INDENT indent one tab stop UNDENT undent one tab stop NL new line HOME home the cursor UP up cursor DOWN down cursor RIGHT right cursor LEFT left cursor SETTAB set a column tab DELTAB delete a columntab SETMRG set left margin SETHOM set home position CLRTAB clear all column tabs (*)APLON apl on (*)APLOFF apl off (*)APLEND treat input as ascii (*)PCON xon/xoff on (*)PCOFF xon/xoff off DISC disconnect (suspend) (*)INIT new terminal type (*)ALTK alternate keyboard dvorak FLINP flush input ERASE erase last character WERASE erase last word FERASE erase field SYNCH we are in synch with the user RESET reset key-unlock keyboard MASTER_RESET reset, unlock and redisplay (*)XOFF please hold output (*)XON please give me output ESCAPE enter telnet command mode WORDTAB tab to beginning of next word WORDBACKTAB tab to beginning of current/last word WORDEND tab to end of current/next word FIELDEND tab to last non-blank of current/next unprotected (writable) field. PA1 program attention 1 PA2 program attention 2 PA3 program attention 3 CLEAR local clear of the 3270 screen TREQ test request ENTER enter key PFK1 program function key 1 PFK2 program function key 2 etc. etc. PFK36 program function key 36 A SAMPLE ENTRY
The following entry is used by tn3270(1) when unable to locate a reasonable version in the user's environment and in /usr/share/misc/map3270: name { # actual name comes from TERM variable clear = '^z'; flinp = '^x'; enter = '^m'; delete = '^d' | '^?'; # note that '^?' is delete (rubout) synch = '^r'; reshow = '^v'; eeof = '^e'; tab = '^i'; btab = '^b'; nl = '^n'; left = '^h'; right = '^l'; up = '^k'; down = '^j'; einp = '^w'; reset = '^t'; xoff = '^s'; xon = '^q'; escape = '^c'; ferase = '^u'; insrt = ' '; # program attention keys pa1 = '^p1'; pa2 = '^p2'; pa3 = '^p3'; # program function keys pfk1 = '1'; pfk2 = '2'; pfk3 = '3'; pfk4 = '4'; pfk5 = '5'; pfk6 = '6'; pfk7 = '7'; pfk8 = '8'; pfk9 = '9'; pfk10 = ' '; pfk11 = '-'; pfk12 = '='; pfk13 = ''; pfk14 = '@'; pfk15 = ' pfk17 = ''; pfk18 = ''; pfk19 = ''; pfk20 = '; pfk21 = ' pfk22 = ''; pfk23 = '_'; pfk24 = '+'; } IBM 3270 KEY DEFINITONS FOR AN ABOVE DEFINITION The charts below show the proper keys to emulate each 3270 function when using the default key mapping supplied with tn3270(1) and mset(1). Command Keys IBM 3270 Key Default Key(s) Enter RETURN Clear control-z Cursor Movement Keys New Line control-n or Home Tab control-i Back Tab control-b Cursor Left control-h Cursor Right control-l Cursor Up control-k Cursor Down control-j or LINE FEED Edit Control Keys Delete Char control-d or RUB Erase EOF control-e Erase Input control-w Insert Mode ESC Space End Insert ESC Space Program Function Keys PF1 ESC 1 PF2 ESC 2 ... ... PF10 ESC 0 PF11 ESC - PF12 ESC = PF13 ESC ! PF14 ESC @ ... ... PF24 ESC + Program Attention Keys PA1 control-p 1 PA2 control-p 2 PA3 control-p 3 Local Control Keys Reset After Error control-r Purge Input Buffer control-x Keyboard Unlock control-t Redisplay Screen control-v Other Keys Erase current field control-u FILES
/usr/share/misc/map3270 SEE ALSO
tn3270(1), mset(1), Yale ASCII Terminal Communication System II Program Description/Operator's Manual (IBM SB30-1911) AUTHOR
Greg Minshall BUGS
Tn3270 doesn't yet understand how to process all the functions available in map3270; when such a function is requested tn3270 will beep at you. The definition of "word" (for "word delete", "word tab") should be a run-time option. Currently it is defined as the kernel tty driver defines it (strings of non-blanks); more than one person would rather use the "vi" definition (strings of specials, strings of alphanu- meric). 4.3 Berkeley Distribution November 27, 1996 MAP3270(5)