1MAP3270(5) File Formats Manual MAP3270(5)
2
6 map3270 - database for mapping ascii keystrokes into IBM 3270 keys
7
9 /usr/share/misc/map3270
10
12 When emulating IBM-syle 3270 terminals under UNIX (see tn3270(1)), a
13 mapping must be performed between sequences of keys hit on a user's
14 (ascii) keyboard, and the keys that are available on a 3270. For exam‐
15 ple, a 3270 has a key labeled EEOF which erases the contents of the
16 current field from the location of the cursor to the end. In order to
17 accomplish this function, the terminal user and a program emulating a
18 3270 must agree on what keys will be typed to invoke the EEOF function.
19 The requirements for these sequences are:
21 1.) that the first character of the sequence be outside of the
23 standard ascii printable characters;
24 2.) that no one sequence be an initial part of another (although
26 sequences may share initial parts).
27
30 The file consists of entries for various terminals. The first part of
31 an entry lists the names of the terminals which use that entry. These
32 names should be the same as in /etc/termcap (see termcap(5)); note that
33 often the terminals from various termcap entries will all use the same
34 map3270 entry; for example, both 925 and 925vb (for 925 with visual
35 bells) would probably use the same map3270 entry. After the names,
36 separated by vertical bars (`|'), comes a left brace (`{'); the defini‐
37 tions; and, finally, a right brace (`}').
38 The definitions consist of a reserved keyword (see list below) which
40 identifies the 3270 function (extended as defined below), followed by
41 an equal sign (`='), followed by the various ways to generate this par‐
42 ticular function, followed by a semi-colon (`;'). Each way is a
43 sequence of strings of printable ascii characters enclosed inside sin‐
44 gle quotes (`´'); various ways (options) are separated by vertical bars
45 (`|').
46 Inside the single quotes, a few characters are special. A caret (`^')
48 specifies that the next character is the ``control'' character of what‐
49 ever the character is. So, `^a' represents control-a, ie: hexadecimal
50 1 (note that `^A' would generate the same code). To generate rubout,
51 one enters `^?'. To represent a control character inside a file
52 requires using the caret to represent a control sequence; simply typing
53 control-A will not work. Note: the ctrl-caret sequence (to generate a
54 hexadecimal 1E) is represented as `^^' (not `^\^').
55 In addition to the caret, a letter may be preceeded by a backslash
57 (`\'). Since this has little effect for most characters, its use is
58 usually not recommended. For the case of a single quote (`´'), the
59 backslash prevents that single quote from terminating the string. To
60 have the backslash be part of the string, it is necessary to place two
61 backslashes ('\\') in the file.
62 In addition, the following characters are special:
64 `\E' means an escape character;
66 `\n' means newline;
67 `\t' means tab;
68 `\r' means carriage return.
69 It is not necessary for each character in a string to be enclosed
71 within single quotes. `\E\E\E' means three escape characters.
72 Comments, which may appear anywhere on a line, begin with a hash mark
74 (`#'), and terminate at the end of that line. However, comments cannot
75 begin inside a quoted string; a hash mark inside a quoted string has no
76 special meaning.
77
79 The following is the list of 3270 key names that are supported in this
80 file. Note that some of the keys don't really exist on a 3270. In
81 particular, the developers of this file have relied extensively on the
82 work at the Yale University Computer Center with their 3270 emulator
83 which runs in an IBM Series/1 front end. The following list corre‐
84 sponds closely to the functions that the developers of the Yale code
85 offer in their product.
86 In the following list, the starred ("*") functions are not supported by
88 tn3270(1). An unsupported function will cause tn3270(1) to send a bell
89 sequence to the user's terminal.
90 3270 Key Name Functional description
92 (*)LPRT local print
94 DP dup character
95 FM field mark character
96 (*)CURSEL cursor select
97 RESHOW redisplay the screen
98 EINP erase input
99 EEOF erase end of field
100 DELETE delete character
101 INSRT toggle insert mode
102 TAB field tab
103 BTAB field back tab
104 COLTAB column tab
105 COLBAK column back tab
106 INDENT indent one tab stop
107 UNDENT undent one tab stop
108 NL new line
109 HOME home the cursor
110 UP up cursor
111 DOWN down cursor
112 RIGHT right cursor
113 LEFT left cursor
114 SETTAB set a column tab
115 DELTAB delete a columntab
116 SETMRG set left margin
117 SETHOM set home position
118 CLRTAB clear all column tabs
119 (*)APLON apl on
120 (*)APLOFF apl off
121 (*)APLEND treat input as ascii
122 (*)PCON xon/xoff on
123 (*)PCOFF xon/xoff off
124 DISC disconnect (suspend)
125 (*)INIT new terminal type
126 (*)ALTK alternate keyboard dvorak
127 FLINP flush input
128 ERASE erase last character
129 WERASE erase last word
130 FERASE erase field
131 SYNCH we are in synch with the user
132 RESET reset key-unlock keyboard
133 MASTER_RESET reset, unlock and redisplay
134 (*)XOFF please hold output
135 (*)XON please give me output
136 ESCAPE enter telnet command mode
137 WORDTAB tab to beginning of next word
138 WORDBACKTAB tab to beginning of current/last word
139 WORDEND tab to end of current/next word
140 FIELDEND tab to last non-blank of current/next
141 unprotected (writable) field.
142 PA1 program attention 1
144 PA2 program attention 2
145 PA3 program attention 3
146 CLEAR local clear of the 3270 screen
148 TREQ test request
149 ENTER enter key
150 PFK1 program function key 1
152 PFK2 program function key 2
153 etc. etc.
154 PFK36 program function key 36
155
157 The following entry is used by tn3270(1) when unable to locate a rea‐
158 sonable version in the user's environment and in
159 /usr/share/misc/map3270:
160 name { # actual name comes from TERM variable
162 clear = '^z';
163 flinp = '^x';
164 enter = '^m';
165 delete = '^d' | '^?'; # note that '^?' is delete (rubout)
166 synch = '^r';
167 reshow = '^v';
168 eeof = '^e';
169 tab = '^i';
170 btab = '^b';
171 nl = '^n';
172 left = '^h';
173 right = '^l';
174 up = '^k';
175 down = '^j';
176 einp = '^w';
177 reset = '^t';
178 xoff = '^s';
179 xon = '^q';
180 escape = '^c';
181 ferase = '^u';
182 insrt = ' ';
183 # program attention keys
184 pa1 = '^p1'; pa2 = '^p2'; pa3 = '^p3';
185 # program function keys
186 pfk1 = '1'; pfk2 = '2'; pfk3 = '3'; pfk4 = '4';
187 pfk5 = '5'; pfk6 = '6'; pfk7 = '7'; pfk8 = '8';
188 pfk9 = '9'; pfk10 = ' '; pfk11 = '-'; pfk12 = '=';
189 pfk13 = ''; pfk14 = '@'; pfk15 = ' pfk17 = ''; pfk18 = '´; pfk19 = ''; pfk20 = ';
190 pfk21 = ' pfk22 = ''; pfk23 = '_'; pfk24 = '+';
191 }
192
194 The charts below show the proper keys to emulate each 3270 function
195 when using the default key mapping supplied with tn3270(1) and mset(1).
196 Command Keys IBM 3270 Key Default Key(s)
198 Enter RETURN
199 Clear control-z
200 Cursor Movement Keys
201 New Line control-n or
202 Home
203 Tab control-i
204 Back Tab control-b
205 Cursor Left control-h
206 Cursor Right control-l
207 Cursor Up control-k
208 Cursor Down control-j or
209 LINE FEED
210 Edit Control Keys
211 Delete Char control-d or
212 RUB
213 Erase EOF control-e
214 Erase Input control-w
215 Insert Mode ESC Space
216 End Insert ESC Space
217 Program Function Keys
218 PF1 ESC 1
219 PF2 ESC 2
220 ... ...
221 PF10 ESC 0
222 PF11 ESC -
223 PF12 ESC =
224 PF13 ESC !
225 PF14 ESC @
226 ... ...
227 PF24 ESC +
228 Program Attention Keys
229 PA1 control-p 1
230 PA2 control-p 2
231 PA3 control-p 3
232 Local Control Keys
233 Reset After Error control-r
234 Purge Input Buffer control-x
235 Keyboard Unlock control-t
236 Redisplay Screen control-v
237 Other Keys
238 Erase current field control-u
239
241 /usr/share/misc/map3270
242
244 tn3270(1), mset(1), Yale ASCII Terminal Communication System II Program
245 Description/Operator's Manual (IBM SB30-1911)
246
248 Greg Minshall
249
251 Tn3270 doesn't yet understand how to process all the functions avail‐
252 able in map3270; when such a function is requested tn3270 will beep at
253 you.
254 The definition of "word" (for "word delete", "word tab") should be a
256 run-time option. Currently it is defined as the kernel tty driver
257 defines it (strings of non-blanks); more than one person would rather
258 use the "vi" definition (strings of specials, strings of alphanumeric).
2594.3 Berkeley Distribution November 27, 1996 MAP3270(5)