usr.bin/tn3270/mset/mset.1

   1 .\"     $NetBSD: mset.1,v 1.10 2002/02/08 01:36:35 ross Exp $
   2 .\"
   3 .\" Copyright (c) 1986, 1990 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: @(#)mset.1        4.6 (Berkeley) 7/27/91
  31 .\"     $NetBSD: mset.1,v 1.10 2002/02/08 01:36:35 ross Exp $
  32 .\"
  33 .Dd July 27, 1991
  34 .Dt MSET 1
  35 .Os
  36 .Sh NAME
  37 .Nm mset
  38 .Nd retrieve
  39 .Tn ASCII
  40 to
  41 .Tn IBM
  42 3270 keyboard map
  43 .Sh SYNOPSIS
  44 .Nm mset
  45 .Op Fl picky
  46 .Op Fl shell
  47 .Op Ar keyboardname
  48 .Sh DESCRIPTION
  49 .Nm
  50 retrieves mapping information
  51 for the
  52 .Tn ASCII
  53 keyboard to
  54 .Tn IBM
  55 3270 terminal
  56 special functions.
  57 Normally, these mappings are found
  58 in
  59 .Pa /usr/share/misc/map3270
  60 (see
  61 .Xr map3270  5  ) .
  62 This information is used by the
  63 .Ic tn3270
  64 command (see
  65 .Xr tn3270  1  ) .
  66 .Pp
  67 The default
  68 .Nm
  69 output can be used to store the mapping information in the process environment
  70 in order to avoid scanning
  71 .Pa map3270
  72 each time
  73 .Ic tn3270
  74 is invoked.
  75 To do this, place the following command in your
  76 .Pa .login
  77 file:
  78 .Bd -literal -offset indent
  79 set noglob; setenv MAP3270 "\(gamset\(ga"; unset noglob
  80 .Ed
  81 .Pp
  82 If the
  83 .Ar keyboardname
  84 argument is not supplied,
  85 .Nm
  86 attempts to determine the name of the keyboard the user is using,
  87 by checking the
  88 .Ev KEYBD
  89 environment variable.
  90 If the
  91 .Ev KEYBD
  92 environment variable is not set, then
  93 .Nm
  94 uses the user's terminal type from the environment variable
  95 .Ev TERM
  96 as the keyboard name.
  97 Normally,
  98 .Nm
  99 then uses the file
 100 .Xr map3270 5
 101 to find the keyboard mapping for that terminal.
 102 However, if the environment variable
 103 .Ev MAP3270
 104 exists and contains the entry for the specified keyboard, then that
 105 definition is used.
 106 If the value of
 107 .Ev MAP3270
 108 begins with a slash (`/') then it is assumed to be the full pathname
 109 of an alternative mapping file and that file is searched first.
 110 In any case, if the mapping for the keyboard is not found in
 111 the environment, nor in an alternative map file, nor in the standard map file,
 112 then the same search is performed for an entry for a keyboard with the name
 113 .Ar unknown  .
 114 If that search also fails,
 115 then a default mapping
 116 is used.
 117 .Pp
 118 The arguments to
 119 .Nm
 120 are:
 121 .Pp
 122 .Bl -tag -width Fl
 123 .It Fl picky
 124 When processing the various
 125 .Pa map3270
 126 entries (for the user's keyboard,
 127 and all those encountered before the one for the user's keyboard),
 128 .Nm
 129 normally will not complain about entries for unknown functions (like
 130 .Dq PFX1 ) ;
 131 the
 132 .Fl picky
 133 argument causes
 134 .Nm
 135 to issue warning messages about these unknown entries.
 136 .It Fl shell
 137 If the
 138 .Pa map3270
 139 entry is longer than the shell's 1024 environmental variable
 140 length limit, the default
 141 .Nm
 142 output cannot be used to store the mapping information in the process
 143 environment to avoid scanning
 144 .Pa map3270
 145 each time
 146 .Ic tn3270
 147 is invoked.
 148 The
 149 .Fl shell
 150 argument causes
 151 .Nm
 152 to generate shell commands to set the environmental variables
 153 .Ev MAP3270  ,
 154 .Ev MAP3270A ,
 155 and so on, breaking up the entry to fit within the shell environmental
 156 variable length limit.
 157 To set these variables, place the following command in your
 158 .Pa .login
 159 file:
 160 .Bd -literal -offset indent
 161 mset -shell \*[Gt] tmp ; source tmp ; /bin/rm tmp
 162 .Ed
 163 .It Ar keyboardname
 164 When searching for the
 165 .Pa map3270
 166 entry that matches the user's keyboard,
 167 .Nm
 168 will use
 169 .Ar keyboardname
 170 instead of determining the keyboard name from the
 171 .Ev KEYBD
 172 or
 173 .Ev TERM
 174 environmental variables.
 175 .El
 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
 187 command appeared in
 188 .Bx 4.3 .