kminit(1M) MISC. REFERENCE MANUAL PAGES kminit(1M)
NAME
kminit - compile a keyboard mapping source
file for EXPRESS TN3270-C
SYNOPSIS
kminit [FilePrefix [ ... FilePrefix]]
[-k InputFile [ ... -k InputFile]]
[-i [-if NewSourceFile] [-o OutputFile] [-r [ReportFile]]
DESCRIPTION
The keyboard mapping utility (kminit) compiles a 3270 key-
board configuration using information defined in one or more
source files. The configuration is used by tn3270c(1) for
3270 host and local sessions. The keyboard mapping source
files may be augmented or overridden by additional defini-
tions entered directly from the keyboard at compile time.
The kminit utility can also produce a report with a complete
listing of the resulting keyboard map.
When invoked, kminit has default definitions for all keys
with logical ASCII defaults, such as the alphanumeric keys.
All other keys are undefined. The kminit utility modifies
the keyboard definitions using the keyboard mapping source
file(s). Additionally, an interactive feature permits a user
at a terminal to define the keyboard by typing in the physi-
cal key sequence in response to the prompt for a 3270 key.
Depending upon the specified command line parameters, the
kminit utility generates up to four forms of output:
o the compiled keyboard mapping file (used by the Session
Manager) (Default suffix is .k)
o the keyboard mapping table (Default suffix is .kp)
o a report file listing the keyboard mappings defined
through kminit (Default suffix is .rep)
o messages generated for various kminit conditions
OPTIONS
FilePrefix
is used as a shorthand method for specifying a related
set of source, output, and report file names. FilePre-
fix is a position-dependent parameter, which must occur
first if it is supplied. It changes the default source
file name to FilePrefix.km, the default output file
name to FilePrefix.k, and the default report file name
to FilePrefix.rep. If FilePrefix occurs multiple times,
the effect is to specify multiple keyboard mapping
source files. The multiple occurrences of FilePrefix
are concatenated to produce a single output file (and
single report file) name.
Last change: 4/13/95 1
kminit(1M) MISC. REFERENCE MANUAL PAGES kminit(1M)
For example the command:
kminit x y z
is equivalent to specifying:
kminit -k x.km -k y.km -k z.km -o xyz.k
Explicitly specifying a file name with the -k or -o
parameter takes precedence. For example, specifying:
kminit x y z -o outfile
is equivalent to specifying:
kminit -k x.km -k y.km -k z.km -o outfile
-k InputFile
specifies the name of a keyboard mapping source file.
If an InputFile is not specified in the kminit command,
FilePrefix is used to determine an input file name. If
FilePrefix also is not specified, the value of the
environment variable KMI3279 is used. If this is unde-
fined, the default name std.km is used. The compiler
searches for this file first in the current working
directory and then in $COMMLINK/adm/3270. If not
found, kminit exits without creating a keyboard map-
ping. If -k InputFile occurs multiple times, the effect
is to specify multiple input files. Definitions from
all these source files are used to build the keyboard
mapping. If the same key is defined more than once, the
last definition overrides previous definitions. This is
useful for creating a mapping with a few keys different
from the standard without changing the standard source
file.
-i specifies an interactive kminit session, allowing you
to make logical key definitions directly from the phy-
sical keyboard, as well as from the keyboard mapping
source file and kminit defaults. Interactive defini-
tions override keyboard mapping source file defini-
tions. If this parameter is omitted, key definitions
are made solely through the input description file.
Since interactive kminit runs in raw mode, it is not
possible to abort the program by hitting the Del or
Quit keys. The only way to abort the program is by
entering the "cancel" character (defined at the start
of interactive kminit) twice at the start of a defini-
tion.
-if NewSourceFile
specifies the keyboard mapping source file created by
the interactive kminit session. The interactive session
creates, in addition to the two expected output files,
a new keyboard mapping source file containing the
results of kminit. This new file may be edited and used
for future invocations of kminit. If the -if parameter
is omitted, the keyboard mapping source file is called
inter.km, and is written to the same directory as the
Last change: 4/13/95 2
kminit(1M) MISC. REFERENCE MANUAL PAGES kminit(1M)
output file. The -i parameter must be used if the -if
parameter is used.
-o OutputFile
specifies to kminit the name of the two output keyboard
mapping files. The compiled keyboard mapping file is
the configuration file used by the Session Manager for
3270 keyboard emulation. If this parameter is omitted,
FilePrefix is used to determine the file name (see
above). If FilePrefix is not specified on the command
line, the environment variable KM3279 is used to obtain
the compiled keyboard mapping file name. If no such
variable is defined, the default name std.k is used.
The pathname $COMMLINK/adm/3270 is appended to the
beginning of the file name unless the name starts with
"/" or "./". For this compiled keyboard mapping file to
be available, you must place it in the directory
$COMMLINK/adm/3270 and give it a .k suffix.
The Keyboard Mapping Report is also generated and indi-
cates to EXPRESS TN3270-C users which physical keys
emulate 3270 keys, defined control keys, or national
language keys. The file name of the report consists of
the compiled keyboard mapping file name plus the letter
p. So if the compiled keyboard mapping file name is
std.k, then the Keyboard Mapping Report file name is
std.kp. If the length of the compiled keyboard mapping
file name is the maximum for your system, then the Key-
board Mapping Report file name may be truncated, and
become identical to the compiled keyboard mapping file
name.
-r ReportFile
directs kminit to create a report of the key defini-
tions being compiled. If ReportFile is specified, the
keyboard mapping report is written to that destination.
If -r appears without ReportFile, the name
ReportFile.rep is used for the report file.
For example, the command:
kminit x -r
would generate a report file named x.rep, while
kminit x y z -r
would generate a report file named xyz.rep, and
kminit -r
would generate a report file named std.rep by default.
BUILDING THE KEYBOARD MAPPING SOURCE FILE
The importance of becoming thoroughly familiar with the tar-
get terminal cannot be over-emphasized. First, identify the
codes sent by the various function and cursor movement keys
Last change: 4/13/95 3
kminit(1M) MISC. REFERENCE MANUAL PAGES kminit(1M)
of the terminal. Then perform the following steps to build
the keyboard mapping source file:
1. Identify the 3270 keyboard features which must be
implemented. Typically, all 3270 functions are imple-
mented, but some may be omitted if there are physical
limitations. The EXPRESS TN3270-C Administrator's
Reference Guide contains a list of the features which
may be defined.
2. Identify the kminit utility keystroke defaults, if any,
which are not appropriate for the terminal. The EXPRESS
TN3270-C Administrator's Reference Guide contains a
complete list of the defaults. Ensure that there are no
conflicts among the keyboard definitions. An example of
a conflict is a terminal whose cursor-down function
code is "^J", which matches the new-line key (KM_NEWL)
default. In this case, KM_NEWL must be reassigned.
3. Make a copy of an existing EXPRESS keyboard mapping
source file that includes defintions similar to your
needs. Use this copy as a starting point for the new
keyboard mapping source file.
4. Redefine physical key sequences for all 3270 keys that
have invalid or inappropriate defaults. No physical key
sequence may generate more than 20 characters nor be a
substring of any other physical key sequence. For exam-
ple, "ES" and "ESI" may not both be used. When defining
the logical 3270 keys, care should be taken to have a
close semantic association between a logical 3270 key
and its selected physical key sequence. Also, determine
which 3270 features are likely to be used most fre-
quently and assign to those the simplest keystroke
sequences. The designation of "^R" for the logical
KM_RESET key is a good example of a simple, semantic
key definition.
5. Designate the key descriptions you want users to see
when using tn3270c(1). For example, if users must
press ^E followed by C to denote the cent sign, you can
choose whether to denote this in the on-line chart as
^EC or Ctrl E C.
Keyboard mapping source files can use either termcap or
terminfo syntax. Mappings may be specified in the
source file using termcap names and/or terminfo names,
regardless of whether your system uses termcap or ter-
minfo. Both termcap and terminfo syntax are discussed
below.
Last change: 4/13/95 4
kminit(1M) MISC. REFERENCE MANUAL PAGES kminit(1M)
termcap SYNTAX
In standard termcap description files, capability descrip-
tions are separated by colons. All description lines except
the first must start with white space and a colon. The last
description line must end with a colon. All description
lines except the last must end with a colon, backslash, and
newline. Any line can be designated as a comment by placing
a number sign (#) in the first non-whitespace position of
the line. The syntax of a termcap-style keyboard mapping
source file is as follows:
FileDescription:\
:KeyDescription:\
.
.
.
:KeyDescription:\
:KeyDescription:
FileDescription is a character string, used to identify the
file (for example, StandardKeyboard).
KeyDescription is a key description, which has the following
format:
Mnemonic=String [== KeyName]
Mnemonic is one of the key mnemonics listed in the EXPRESS
TN3270-C Administrator's Reference Guide.
String is one or more characters which are the mapping
string for the associated key.
KeyName is the name of the physical key or keys associated
with the mapping string. The keyboard mapping menu in the
Control Mode of tn3270c(1) creates a table of 3270 key func-
tion by KeyName for user reference. If KeyName is absent,
the String is used instead. KeyName should be used whenever
a labeled key or key combination, such as BackSpace, F1,
Alt-F4, or PF4 F12, is associated with a Mnemonic. Usage of
KeyName is probably unnecessary when String is a simple con-
trol key sequence like Ctrl D or Ctrl A2. The KeyName must
not exceed 16 characters. Blanks are accepted. If not speci-
fied, KeyName is null.
terminfo SYNTAX
In standard terminfo description files, capability descrip-
tions are separated by commas. Whitespace (including new-
lines) between a comma and the start of the next capability
description is ignored. Any line can be designated as a com-
ment by placing a number sign (#) in the first non-
whitespace position of the line. The syntax of a terminfo-
Last change: 4/13/95 5
kminit(1M) MISC. REFERENCE MANUAL PAGES kminit(1M)
style keyboard mapping source file is as follows:
FileDescription,
KeyDescription,
.
.
.
KeyDescription,
KeyDescription
FileDescription and KeyDescription have the same meanings as
described above.
FILES
The following keyboard mapping files are located in
$COMMLINK/adm/3270:
AT.km Source file for IBM PC/AT keyboards
AT386.km Source file for IBM PC/AT enhanced keyboards
a5.km Source file for Altos V keyboards (excluding
national language)
a7.km Source file for Altos VII keyboards
a7pc.km Source file for Altos VII Enhanced PC-style
keyboards
d410.km Source file for Data General D410 terminal
keyboards
d230c.km Source file for Data General Dasher D230c
color terminals
hds3.km Source file for Honeywell HDS3 keyboards
ibm.km Source file for IBM consoles
ibm3151.km Source file for IBM 3151 keyboards
ibm5151.km Source file for IBM 5151 keyboards
lnk220.km Source file for LINK MC 5/Wyse 99-GT (ANSI)
keyboards
nl.km Source file for all IBM national language keys
prolg.km Source file for Bull Questar 705 keyboards in
Prolog mode
scocon.km Source file for SCO keyboards
Last change: 4/13/95 6
kminit(1M) MISC. REFERENCE MANUAL PAGES kminit(1M)
std.km Source file for all universal 3270 keys (i.e.,
keys that are common to all 3270 keyboards
sun-cmd.km Source file for Sun keyboards
tm3100.km Source file for Motorola tm3100 keyboards
tm3200.km Source file for Motorola tm3200 keyboards
xterm24dg.km Source file for Data General AViiON system
keyboards used with DG/UX X Window System for
AViiON systems
For each source file, a keyboard mapping report and a com-
piled version of the file are also provided with EXPRESS
TN3270-C. The filenames for the keyboard mapping reports end
in "kp" rather than "km" and the filenames for the compiled
versions end with "k".
SEE ALSO
tn3270c(1), dcinit(1M), neinit(1M), prinit(1M), tn3270c(4),
TN3270-C Administrator's Reference Guide
Last change: 4/13/95 7