| blob | 45b05ca265f1f8d94494861abbc7c6157d85c6cc |
1 .\" $NetBSD: map3270.5,v 1.11 2002/10/02 11:17:41 wiz Exp $
2 .\"
3 .\" Copyright (c) 1986 The Regents of the University of California.
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the University nor the names of its contributors
15 .\" may be used to endorse or promote products derived from this software
16 .\" without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\" from: @(#)map3270.5 4.5 (Berkeley) 7/31/91
31 .\" $NetBSD: map3270.5,v 1.11 2002/10/02 11:17:41 wiz Exp $
32 .\"
33 .TH MAP3270 5 "July 31, 1991"
34 .UC 6
35 .SH NAME
36 map3270 \- database for mapping ascii keystrokes into IBM 3270 keys
37 .SH SYNOPSIS
38 .B map3270
39 .SH DESCRIPTION
40 When emulating IBM-style 3270 terminals under \s-1UNIX\s0 (see \fItn3270\fR(1)),
41 a mapping must be performed between sequences of keys hit on
42 a user's (ascii) keyboard, and the keys that are
43 available on a 3270. For example, a 3270 has a key labeled
44 .B EEOF
45 which erases the contents of the current field from the
46 location of the cursor to the end.
47 In order to accomplish this function,
48 the terminal user and a program emulating a 3270 must
49 agree on what keys will be typed
50 to invoke the
51 .B EEOF
52 function.
53 .PP
54 The requirements for these sequences are:
55 .nf
56 .ta 4n 9n
57 .sp
58 1) that the first character of the sequence be outside of the
59 standard ascii printable characters;
60 .sp
61 2) that no sequence \fIbe\fR an initial part of another (although
62 sequences may \fIshare\fR initial parts).
63 .sp
64 .fi
65 .SH FORMAT
66 The file consists of entries for various keyboards. The first part
67 of an entry lists the names of the keyboards which use that entry.
68 These names will often be the same as in
69 .I /usr/share/misc/termcap
70 (see
71 .IR termcap (5));
72 however, note that often the terminals from various termcap entries will all
73 use the same
74 .I map3270
75 entry; for example, both 925 and 925vb (for
76 925 with visual bells) would probably use the same
77 .I map3270
78 entry.
79 Additionally, there are occasions when the terminal type defines
80 a window manager, and it will then be necessary to specify a
81 keyboard name (via the
82 .B KEYBD
83 environment variable) as the name of the entry.
84 After the names, separated by vertical bars (`|'), comes a left
85 brace (`{'); the definitions; and, finally, a right brace
86 (`}').
87 .PP
88 Each definition consists of a reserved keyword (see list below) which
89 identifies the 3270 function (extended as defined below), followed
90 by an equal sign (`='), followed by the various ways to generate
91 this particular function, followed by a semi-colon (`;').
92 Each way is a sequence of strings of
93 .I printable
94 ascii characters enclosed inside single quotes (`\(aa');
95 various ways (alternatives) are separated by vertical bars (`|').
96 .PP
97 Inside the single quotes, a few characters are special.
98 A caret
99 (`^') specifies that the next character is
100 the ``control'' character of whatever the character is.
101 So, `^a'
102 represents control-a, ie: hexadecimal 1
103 (note that `^A' would generate the same code).
104 To generate
105 .B rubout
106 (DEL),
107 one enters `^?'.
108 To represent a control character inside a file
109 requires using the caret to represent a control sequence;
110 simply typing control-A will not work.
111 Note: the ctrl-caret sequence
112 (to generate a hexadecimal 1E)
113 is represented as `^^' (not `^\e^').
114 .PP
115 In addition to the caret, a letter may be preceded by a backslash (`\e').
116 Since this has little effect for most characters,
117 its use is usually not recommended.
118 For the case of a single quote (`\(aa'), the backslash
119 prevents that single quote from terminating the string.
120 For the case of a caret (`^'), the backslash prevents
121 the caret from having its special meaning.
122 To have the backslash be part of the string, it is necessary to
123 place two backslashes ('\e\e') in the file.
124 .PP
125 In addition, the following characters are special:
126 .sp
127 .nf
128 .in +0.5i
129 `\eE' means an escape character;
130 `\en' means newline;
131 `\et' means tab;
132 `\er' means carriage return.
133 .in -0.5i
134 .fi
135 .sp
136 It is not necessary for each character in a string
137 to be enclosed within single quotes.
138 `\eE\eE\eE' means three escape characters.
139 .PP
140 Comments, which may appear anywhere on a line,
141 begin with a hash mark (`#'), and terminate
142 at the end of that line.
143 However, comments cannot begin inside a quoted string;
144 a hash mark inside a quoted string has no special meaning.
145 .PP
146 .SH 3270 KEYS SUPPORTED
147 The following is the list of 3270 key names that are supported in this file.
148 Note that some of the keys don't really exist on a 3270.
149 In particular, the developers of this file have relied
150 extensively on the work at the Yale University Computer Center with
151 their 3270 emulator which runs in an IBM Series/1 front end.
152 The following list corresponds closely to the functions
153 that the developers of the Yale code offer in their product.
154 .sp
155 .B In the following list, the
156 .B starred ("*")
157 .B functions are not supported by
158 .IR tn3270 (1).
159 An unsupported function will cause
160 .IR tn3270(1)
161 to send a (possibly visual) bell sequence to the user's terminal.
162 .sp
163 .nf
164 3270 Key Name Functional description
166 (*)LPRT local print
167 DP dup character
168 FM field mark character
169 CURSEL cursor select
170 CENTSIGN EBCDIC cent sign
171 RESHOW redisplay the screen
172 EINP erase input
173 EEOF erase end of field
174 DELETE delete character
175 INSRT toggle insert mode
176 TAB field tab
177 BTAB field back tab
178 COLTAB column tab
179 COLBAK column back tab
180 INDENT indent one tab stop
181 UNDENT undent one tab stop
182 NL new line
183 HOME home the cursor
184 UP up cursor
185 DOWN down cursor
186 RIGHT right cursor
187 LEFT left cursor
188 SETTAB set a column tab
189 DELTAB delete a columntab
190 SETMRG set left margin
191 SETHOM set home position
192 CLRTAB clear all column tabs
193 (*)APLON apl on
194 (*)APLOFF apl off
195 (*)APLEND treat input as ascii
196 (*)PCON xon/xoff on
197 (*)PCOFF xon/xoff off
198 DISC disconnect (suspend)
199 (*)INIT new terminal type
200 (*)ALTK alternative keyboard dvorak
201 FLINP flush input
202 ERASE erase last character
203 WERASE erase last word
204 FERASE erase field
205 SYNCH we are in synch with the user
206 RESET reset key-unlock keyboard
207 MASTER_RESET reset, unlock and redisplay
208 (*)XOFF please hold output
209 (*)XON please give me output
210 ESCAPE enter telnet command mode
211 WORDTAB tab to beginning of next word
212 WORDBACKTAB tab to beginning of current/last word
213 WORDEND tab to end of current/next word
214 FIELDEND tab to last non-blank of current/next
215 unprotected (writable) field.
217 PA1 program attention 1
218 PA2 program attention 2
219 PA3 program attention 3
221 CLEAR local clear of the 3270 screen
222 TREQ test request
223 ENTER enter key
225 PFK1 program function key 1
226 PFK2 program function key 2
227 etc. etc.
228 PFK36 program function key 36
229 .SH A SAMPLE ENTRY
230 The following entry is used by
231 tn3270(1) when unable to locate a reasonable version in the
232 user's environment and in /usr/share/misc/map3270:
233 .sp
234 .nf
235 name { # actual name comes from TERM variable
236 clear = '^z';
237 flinp = '^x';
238 enter = '^m';
239 delete = '^d' | '^?'; # note that '^?' is delete (rubout)
240 synch = '^r';
241 reshow = '^v';
242 eeof = '^e';
243 tab = '^i';
244 btab = '^b';
245 nl = '^n';
246 left = '^h';
247 right = '^l';
248 up = '^k';
249 down = '^j';
250 einp = '^w';
251 reset = '^t';
252 xoff = '^s';
253 xon = '^q';
254 escape = '^c';
255 ferase = '^u';
256 insrt = '\E ';
257 # program attention keys
258 pa1 = '^p1'; pa2 = '^p2'; pa3 = '^p3';
259 # program function keys
260 pfk1 = '\eE1'; pfk2 = '\eE2'; pfk3 = '\eE3'; pfk4 = '\eE4';
261 pfk5 = '\eE5'; pfk6 = '\eE6'; pfk7 = '\eE7'; pfk8 = '\eE8';
262 pfk9 = '\eE9'; pfk10 = '\eE0'; pfk11 = '\eE-'; pfk12 = '\eE=';
263 pfk13 = '\eE!'; pfk14 = '\eE@'; pfk15 = '\eE#'; pfk16 = '\eE$';
264 pfk17 = '\eE%'; pfk18 = '\eE'; pfk19 = '\eE\*[Am]'; pfk20 = '\eE*';
265 pfk21 = '\eE('; pfk22 = '\eE)'; pfk23 = '\eE_'; pfk24 = '\eE+';
266 }
267 .fi
268 .SH "IBM 3270 KEY DEFINITIONS FOR AN ABOVE DEFINITION"
269 The charts below show the proper keys to emulate
270 each 3270 function when using the default key mapping supplied
271 with
272 .IR tn3270 (1)
273 and
274 .IR mset (1).
275 .sp
276 .nf
277 Command Keys IBM 3270 Key Default Key(s)
278 Enter RETURN
279 Clear control-z
280 Cursor Movement Keys
281 New Line control-n or
282 Home
283 Tab control-i
284 Back Tab control-b
285 Cursor Left control-h
286 Cursor Right control-l
287 Cursor Up control-k
288 Cursor Down control-j or
289 LINE FEED
290 Edit Control Keys
291 Delete Char control-d or
292 RUB
293 Erase EOF control-e
294 Erase Input control-w
295 Insert Mode ESC Space
296 End Insert ESC Space
297 Program Function Keys
298 PF1 ESC 1
299 PF2 ESC 2
300 ... ...
301 PF10 ESC 0
302 PF11 ESC -
303 PF12 ESC =
304 PF13 ESC !
305 PF14 ESC @
306 ... ...
307 PF24 ESC +
308 Program Attention Keys
309 PA1 control-p 1
310 PA2 control-p 2
311 PA3 control-p 3
312 Local Control Keys
313 Reset After Error control-r
314 Purge Input Buffer control-x
315 Keyboard Unlock control-t
316 Redisplay Screen control-v
317 Other Keys
318 Erase current field control-u
319 .fi
320 .SH FILES
321 /usr/share/misc/map3270
322 .SH SEE ALSO
323 tn3270(1), mset(1), \fIYale ASCII Terminal Communication
324 System II Program Description/Operator's Manual\fR
325 (IBM SB30-1911)
326 .SH AUTHOR
327 Greg Minshall
328 .SH BUGS
329 .I Tn3270
330 doesn't yet understand how to process all the functions
331 available in
332 .I map3270;
333 when such a function is requested
334 .I tn3270
335 will beep at you.
336 .PP
337 The definition of "word" (for "word erase", "word tab") should be a run-time
338 option. Currently it is defined as the kernel tty driver defines it (strings
339 of non-whitespace); more than one person would rather use the "vi" definition
340 (strings of specials, strings of alphanumeric).