xref: /original-bsd/usr.bin/tn3270/mset/mset.1 (revision b7261a4b)
1.\" Copyright (c) 1986, 1990 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" %sccs.include.redist.man%
5.\"
6.\"     @(#)mset.1	4.3 (Berkeley) 06/11/90
7.\"
8.Dd
9.Dt MSET 1
10.Os BSD 4.3
11.Sh NAME
12.Nm mset
13.Nd retrieve ASCII to IBM 3270 keyboard map
14.Sh SYNOPSIS
15.Nm mset
16.Op Fl picky
17.Op Fl shell
18.Op Ar keyboardname
19.Sh DESCRIPTION
20.Nm Mset
21retrieves mapping information
22for the ASCII keyboard to IBM 3270 terminal
23special functions.
24Normally, these mappings are found
25in
26.Pa /usr/share/misc/map3270
27(see
28.Xr map3270  5  ) .
29This information is used by the
30.Xr tn3270
31command (see
32.Xr tn3270  1  ) .
33.Pp
34The default
35.Nm mset
36output can be used to store the mapping information in the process environment
37in order to avoid scanning
38.Nm map3270
39each time
40.Nm tn3270
41is invoked.
42To do this, place the following command in your
43.Pa .login
44file:
45.Pp
46.Dl set noglob; setenv MAP3270 "\(gamset\(ga"; unset noglob
47.Pp
48If the
49.Ar keyboardname
50argument is not supplied,
51.Nm mset
52attempts to determine the name of the keyboard the user is using,
53by checking the
54.Ev KEYBD
55environment variable.
56If the
57.Ev KEYBD
58environment variable is not set, then
59.Nm mset
60uses the user's terminal type from the environment variable
61.Ev TERM
62as the keyboard name.
63Normally,
64.Nm mset
65then uses the file
66.Xr map3270 5
67to find the keyboard mapping for that terminal.
68However, if the environment variable
69.Ev MAP3270
70exists and contains the entry for the specified keyboard, then that
71definition is used.
72If the value of
73.Ev MAP3270
74begins with a slash (`/') then it is assumed to be the full pathname
75of an alternate mapping file and that file is searched first.
76In any case, if the mapping for the keyboard is not found in
77the environment, nor in an alternate map file, nor in the standard map file,
78then the same search is performed for an entry for a keyboard with the name
79.Ar unknown  .
80If that search also fails,
81then a default mapping
82is used.
83.Pp
84The arguments to
85.Nm mset
86are:
87.Pp
88.Tw Fl
89.Tp Fl picky
90When processing the various
91.Pa map3270
92entries (for the user's keyboard,
93and all those encountered before the one for the user's keyboard),
94.Nm mset
95normally will not complain about entries for unknown functions (like
96.Dq PFX1 ;
97the
98.Fl picky
99argument causes
100.Nm mset
101to issue warning messages about these unknown entries.
102.Tp Fl shell
103If the
104.Pa map3270
105entry is longer than the shell's 1024 environmental variable
106length limit, the default
107.Nm mset
108output cannot be used to store the mapping information in the process
109environment to avoid scanning
110.Pa map3270
111each time
112.Nm tn3270
113is invoked.
114The
115.Fl shell
116argument causes
117.Nm mset
118to generate shell commands to set the environmental variables
119.Ev MAP3270  ,
120.Ev MAP3270A ,
121and so on, breaking up the entry to fit within the shell environmental
122variable length limit.
123To set these variables, place the following command in your
124.Pa .login
125file:
126.Pp
127.Dl mset -shell > tmp ; source tmp ; /bin/rm tmp
128.Tp Ar keyboardname
129When searching for the
130.Pa map3270
131entry that matches the user's keyboard,
132.Nm mset
133will use
134.Ar keyboardname
135instead of determining the keyboard name from the
136.Ev KEYBD
137or
138.Ev TERM
139environmental variables.
140.Sh FILES
141.Dw /usr/share/misc/map3270
142.Di L
143.Dp Pa /usr/share/misc/map3270
144keyboard mapping for known keyboards
145.Dp
146.Sh ENVIRONMENT
147.Sh SEE ALSO
148.Xr tn3270 1 ,
149.Xr map3270 5
150.Sh HISTORY
151.Nm mset
152appeared in 4.3 BSD.
153