Berkeley copyright notice
[unix-history] / usr / src / usr.bin / tn3270 / mset / mset.1
CommitLineData
70f58f09
KB
1.\" Copyright (c) 1986 The Regents of the University of California.
2.\" All rights reserved.
b5bef96d 3.\"
70f58f09
KB
4.\" Redistribution and use in source and binary forms are permitted
5.\" provided that the above copyright notice and this paragraph are
6.\" duplicated in all such forms and that any documentation,
7.\" advertising materials, and other materials related to such
8.\" distribution and use acknowledge that the software was developed
9.\" by the University of California, Berkeley. The name of the
10.\" University may not be used to endorse or promote products derived
11.\" from this software without specific prior written permission.
12.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
13.\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
14.\" WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
15.\"
16.\" @(#)mset.1 1.4 (Berkeley) %G%
b5bef96d
KM
17.\"
18.TH MSET 1 ""
19.UC 6
cb45d482
GM
20.SH NAME
21mset \- retrieve ASCII to IBM 3270 keyboard map
22.SH SYNOPSIS
23.B mset
24.SH DESCRIPTION
25.I Mset
26retrieves mapping information
27for the ASCII keyboard to IBM 3270 terminal
28special functions.
29Normally, these mappings are found
30in
31.I /etc/map3270
32(see
33.IR map3270 (5)).
34This information is used by the
35.I tn3270
36command (see
37.IR tn3270 (1)).
38.PP
39.I Mset
40can be used store the mapping information in the process environment
41in order to avoid scanning
42.I /etc/map3270
43each time
44.I tn3270
45is invoked.
46To do this, place the following command in your
47.I .login
48file:
49.ti 5n
50.sp
51 set noglob; setenv \s-1MAP3270\s0 "\(gamset\(ga"; unset noglob
52.PP
53.I Mset
54first determines the user's terminal type from the environment variable
55.BR TERM .
56Normally
57.I mset
58then uses the file
59.I /etc/map3270
60to find the keyboard mapping for that terminal.
61However, if the environment variable
62.B MAP3270
63exists and contains the entry for the specified terminal, then that
64definition is used.
65If the value of
66.B MAP3270
67begins with a slash (`/') then it is assumed to be the full pathname
68of an alternate mapping file and that file is searched first.
69In any case, if the mapping for the terminal is not found in
70the environment, nor in an alternate map file, nor in the standard map file,
71then the same search is performed for an entry for a terminal type of
72.B unknown.
73If that search also fails,
74then a default mapping
75is used.
76.SH FILES
77/etc/map3270 keyboard mapping for known terminals
78.SH SEE ALSO
79tn3270(1), map3270(5)
80.SH BUGS
81If the entry for the specific terminal
82exceeds 1024 bytes, \fIcsh\fR(1) will fail
83to set the environment variable.
84.I Mset
85should probably
86detect this case and
87output the path to the
88.I map3270
89file
90instead of the terminal entry.