UNIX Keyboard Reference
keys.ttkeyboard file must be in UTF-8 format.
All lines in the
keys.ttkeyboard file must end in a line feed or a carriage return/line
feed pair. All settings are case-sensitive.
keys.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.
Adding .P or .L to the end of the name limits display of the layout to portrait
or landscape mode respectively.
With that exception, 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 keys.ttkeyboard file.
These settings can be placed anywhere in the keys.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.
|keyboardHeight||Sets the height of the keyboard layout. The value is in pixels on first-
and second-generation iPads. On the new iPad with Retina display, this value is
half the number of pixels the layout will use. Defaults to 350
|keyboardWidth||Sets the width of the layout. Uses the same pixel values as
|keyHeight||Changes the default height of the keys, relative to a base value of 1.
Sets vertical position and horizontal justification of the main key label.
See image at right for the available values. Note that 0, 3 and 6 left-justify the
text; 2, 5 and 8 right-justify it; and 1, 4 and 7 center the label. Defaults to 4.
This option is only available on iPad.
|layout||Sets the position of the keyboard layout:
|lineJustification||Sets the justification for rows of keys:
|margin||Minimum number of pixels on each edge – top, bottom, left and
right – of the keyboard.
|orientation||Used only within layouts. Determines whether the
layout displays in portrait, landscape or both modes:
|shiftFontSize||Maximum font size in points of
|shiftLabelPosition||Starting position of the
|size||Changes the default width of keys, relative to a base value of 1.
|spacing||Minimum number of pixels 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 or
shiftLabel, separate it from the double semicolons by a
space for the display character, and use the hexadecimal value \x003b as the keyChar
for the value sent:
|\||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.
|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.
|labelPosition||Sets vertical position and horizontal justification of the main key label.
Defaults to 4. This option is only available on iPad.
|printScreen||When set to 1, this key will print the current emulator screen to the
currently selected printer. Defaults to 0.
|scanBarcode||When set to 1, causes the key to trigger a camera scan when tapped.
|shiftFontSize||Sets the font size for the
|shiftId||Changes the identity of a shift key. By default, the ID for a given
|shiftLabelPosition||Sets vertical position and horizontal justification of the
|shiftLabel||Displays the character as secondary on the keyboard key. Most often used
to show what character will be typed when the shift key is held. There is
no way to display more than two labels on a key. This option is only available on iPad.
|shiftTo||Selects a keyboard layout to switch to. Uses the
|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|
|\xf700||up arrow key ↑||\xf701||down arrow key ↓|
|\xf702||left arrow key ←||\xf703||right arrow key →|
|\xf704-\xf717||function keys F1-F20||\xf72b||End key|
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. Not all available values are listed. Standard Unicode values may be used
as well for a wide range of characters.
|Value||Keyboard Key||Value||Keyboard Key|
|0-255||Equivalent ASCII character1||61747||Ctrl-Page Down|
|63236-63255||Function keys F1-F20||61748||Ctrl-⌫|
|63234||Left ←||61751||Ctrl-Keypad -|
|63235||Right →||61752||Ctrl-Keypad +|
|61721-61730||Numeric Keypad 0-9||61754||Keypad *|
|61731||Keypad -||61755||Keypad +|
|61732||Keypad ,||61756||Keypad /|
|61733||Keypad .||61757||Num Lock|
|61734||Keypad Enter||61758||Scroll Lock|
|61743||Ctrl-←||61769-61788||Shift-F1 to Shift-F20|
|61744||Ctrl-Print Screen||61789-61808||Ctrl-F1 to Ctrl-F202|
|61745||Shift-Tab||61809-61828||Alt-F1 to Alt-F20|
|61746||Ctrl-Page Up||61829-61848||Ctrl-Shift-F1 to Ctrl-Shift-F20|
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 sample keyboard 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.
The last argument,
size, is used to widen the key. The larger size
makes the key easier to type on, and leaves less blank space to either side of the
keyboard. Note also that the K is centered, thanks to the default argument
This key uses
keyChar instead of
keyString to send a
non-printable ASCII 13, which is the carriage return ^M. (It's converted to an
EBCDIC enter in transmission.) 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 key was drawn from a layout section that uses a different
than the default listed above. It also shows a more complex labeling scheme,
shiftLabelPosition argument moving the shift label to the lower left.
This particular key comes from a shifted layout, rather than a main one.
shows which lahyout will be displayed when this key is tapped.
this key a unique identifier, so that it properly uses the default
Note also that in an actual keys.ttkeyboard file, this key definition would be on one line. It's broken in two here for ease of reading.