usr.bin/tn3270/mset/mset.1

   1 .\" Copyright (c) 1986, 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)mset.1      8.1 (Berkeley) 6/6/93
  33 .\"
  34 .Dd June 6, 1993
  35 .Dt MSET 1
  36 .Os BSD 4.3
  37 .Sh NAME
  38 .Nm mset
  39 .Nd retrieve
  40 .Tn ASCII
  41 to
  42 .Tn IBM
  43 3270 keyboard map
  44 .Sh SYNOPSIS
  45 .Nm mset
  46 .Op Fl picky
  47 .Op Fl shell
  48 .Op Ar keyboardname
  49 .Sh DESCRIPTION
  50 .Nm Mset
  51 retrieves mapping information
  52 for the
  53 .Tn ASCII
  54 keyboard to
  55 .Tn IBM
  56 3270 terminal
  57 special functions.
  58 Normally, these mappings are found
  59 in
  60 .Pa /usr/share/misc/map3270
  61 (see
  62 .Xr map3270  5  ) .
  63 This information is used by the
  64 .Xr tn3270
  65 command (see
  66 .Xr tn3270  1  ) .
  67 .Pp
  68 The default
  69 .Nm mset
  70 output can be used to store the mapping information in the process environment
  71 in order to avoid scanning
  72 .Nm map3270
  73 each time
  74 .Nm tn3270
  75 is invoked.
  76 To do this, place the following command in your
  77 .Pa .login
  78 file:
  79 .Bd -literal -offset indent
  80 set noglob; setenv MAP3270 "\(gamset\(ga"; unset noglob
  81 .Ed
  82 .Pp
  83 If the
  84 .Ar keyboardname
  85 argument is not supplied,
  86 .Nm mset
  87 attempts to determine the name of the keyboard the user is using,
  88 by checking the
  89 .Ev KEYBD
  90 environment variable.
  91 If the
  92 .Ev KEYBD
  93 environment variable is not set, then
  94 .Nm mset
  95 uses the user's terminal type from the environment variable
  96 .Ev TERM
  97 as the keyboard name.
  98 Normally,
  99 .Nm mset
 100 then uses the file
 101 .Xr map3270 5
 102 to find the keyboard mapping for that terminal.
 103 However, if the environment variable
 104 .Ev MAP3270
 105 exists and contains the entry for the specified keyboard, then that
 106 definition is used.
 107 If the value of
 108 .Ev MAP3270
 109 begins with a slash (`/') then it is assumed to be the full pathname
 110 of an alternate mapping file and that file is searched first.
 111 In any case, if the mapping for the keyboard is not found in
 112 the environment, nor in an alternate map file, nor in the standard map file,
 113 then the same search is performed for an entry for a keyboard with the name
 114 .Ar unknown  .
 115 If that search also fails,
 116 then a default mapping
 117 is used.
 118 .Pp
 119 The arguments to
 120 .Nm mset
 121 are:
 122 .Pp
 123 .Bl -tag -width Fl
 124 .It Fl picky
 125 When processing the various
 126 .Pa map3270
 127 entries (for the user's keyboard,
 128 and all those encountered before the one for the user's keyboard),
 129 .Nm mset
 130 normally will not complain about entries for unknown functions (like
 131 .Dq PFX1 ;
 132 the
 133 .Fl picky
 134 argument causes
 135 .Nm mset
 136 to issue warning messages about these unknown entries.
 137 .It Fl shell
 138 If the
 139 .Pa map3270
 140 entry is longer than the shell's 1024 environmental variable
 141 length limit, the default
 142 .Nm mset
 143 output cannot be used to store the mapping information in the process
 144 environment to avoid scanning
 145 .Pa map3270
 146 each time
 147 .Nm tn3270
 148 is invoked.
 149 The
 150 .Fl shell
 151 argument causes
 152 .Nm mset
 153 to generate shell commands to set the environmental variables
 154 .Ev MAP3270  ,
 155 .Ev MAP3270A ,
 156 and so on, breaking up the entry to fit within the shell environmental
 157 variable length limit.
 158 To set these variables, place the following command in your
 159 .Pa .login
 160 file:
 161 .Bd -literal -offset indent
 162 mset -shell > tmp ; source tmp ; /bin/rm tmp
 163 .Ed
 164 .It Ar keyboardname
 165 When searching for the
 166 .Pa map3270
 167 entry that matches the user's keyboard,
 168 .Nm mset
 169 will use
 170 .Ar keyboardname
 171 instead of determining the keyboard name from the
 172 .Ev KEYBD
 173 or
 174 .Ev TERM
 175 environmental variables.
 176 .Sh FILES
 177 .Bl -tag -width /usr/share/misc/map3270 -compact
 178 .It Pa /usr/share/misc/map3270
 179 keyboard mapping for known keyboards
 180 .El
 181 .Sh SEE ALSO
 182 .Xr tn3270 1 ,
 183 .Xr map3270 5
 184 .Sh HISTORY
 185 The
 186 .Nm mset
 187 command appeared in
 188 .Bx 4.3 .