3270 Keyboard Reference
tn3270.ttkeyboard file must be in UTF-8 format.
All lines in the
tn3270.ttkeyboard file must end in a line feed or a carriage return/line
feed pair. All settings are case-sensitive.
tn3270.ttkeyboard files are available for download:
These settings identify specific keyboard layouts and set off comments.
|+||Name keyboard layout and begin section. Also ends previous keyboard
layout if one is present. A period in the name identifies the layout as subordinate
to another layout with the same name, but without the dot extension. It also prevents the layout name from being
displayed in TinyTERM. For example,
|#||Comment line. These can be inserted anywhere in the
These settings can be placed anywhere in the
tn3270.ttkeyboard file, preceded with a
dash. They will affect all lines below them, until a new instance of the setting is found.
|fontSize||Maximum font size in points of main key labels. The label size will be
reduced automatically to fit the key if needed.
|keyHeight||Changes the default height of the keys, relative to a base value of 1.
|lineJustification||Sets the justification for rows of keys:
|margin||Minimum clear space on each edge – top, bottom, left and
right – of the keyboard.
|size||Changes the default width of keys, relative to a base value of 1.
|spacing||Minimum space between keys
When a key is defined within square brackets [ ], options may be added to the definition, set off by two semicolons. Many of the general settings can also be applied to individual keys, and so are repeated below with key-specific examples. Options are all case-sensitive.
When a semicolon is desired as a displayed character inside the brackets, such as for a label, separate it from the double semicolons by a space. Then use keyString to set the character, so the space isn't typed as part of the key:
|\||Escape character. Used for special characters
that have other uses without the \. Square brackets are not required for
|blank||When set to 1, prevents the key from being drawn. Used for creating
space between visible keys in addition to that specified by the
|capsKey||When set to 1, causes the key to act as a Caps Lock key,
regardless of other settings.
|hideKey||When set to 1, causes the key to hide the keyboard when tapped. Also
replaces any text with a keyboard graphic. The keyboard can be restored by
tapping the keyboard button in the title bar, or by double-tapping the screen.
|fontSize||Sets the font size for the primary label of the key.
|keyChar||Assigns a specific value to a key. Available values are
|keyHeight||Changes the height of the individual key, relative to a base value of 1.
|keyString||Assigns a multi-character string to a key.
This allows you to create custom key mappings with multi-byte
sequences on a single keystroke.
|printScreen||When set to 1, this key will print the current emulator screen. Defaults to 0.
|shiftId||Changes the identity of a shift key. By default, the ID for a given
|shiftTo||Selects a keyboard layout to display while key is held. The selected
layout will replace the current layout until the shift key is released.
|size||Changes the width of the individual key, relative to a base value of 1.
The following characters are created with the escape character \.
|\b||backspace (hex 08)||\\||backslash (hex 5c)|
|\[||left square bracket (hex 5b)||\]||right square bracket (hex 5d)|
|\r||carriage return (hex 0d)||\x||UTF-8 hexadecimal number; e.g., \x000d for carriage return|
|\t||horizontal tab (hex 09)||\0||octal constant; e.g., \011 for horizontal tab|
Note that all hexadecimal and octal values are for the ASCII character set for iOS compatibility. TinyTERM Enterprise for Android converts these to EBCDIC during communication with the mainframe system.
Special characters may be used in combination with the
option to create complex sequences:
The following values may be assigned to keys, using the
option. Values not listed have been reserved, and are not available.
|Value||Keyboard Key||Value||Keyboard Key|
|0-255||Equivalent ASCII character1||62560-62583||PF1 to PF24|
|8||Backspace ⌫||62584-62586||PA1 to PA3|
|63232||Up ↑||62589||Erase Input|
|63233||Down ↓||62590||Erase End of Field|
|63234||Left ←||62593||New Line|
Putting It All Together
As seen above, there are a variety of options for defining keyboard keys in TinyTERM. Combined, they can create just about any key design needed. Here are three examples from the QWERTY portrait layout. They all use these default values:
The first argument (here K) is always the key label.
causes the key to send a lower-case k. Without it, the key would send the
label instead, upper-case K. Labeling like this gives an appearance
like that of a physical keyboard.
This key uses
keyChar instead of
keyString to send a
non-printable ASCII 13, which is the carriage return ^M. The
fontSize argument makes the label text smaller than the default point size 15.
labelPosition=6 overrides the default value to left-justify the label string in the lower left
corner of the key. And
size makes the key even wider than the K
key described above.
This particular key comes from a shifted layout, rather than a main one.
shows which layout will be displayed when this key is tapped.
this key a unique identifier, so that it properly uses the default