KMKB0060: Keyman Desktop and Keyman Engine registry keys

Tavultesoft Keyman keys

The table below lists most of the common Keyman Desktop and Keyman Engine registry settings. This is intended for use as reference only, and changes should not be made directly to these settings in most circumstances; instead use the Keyman Desktop Configuration tool to change settings.

HKCU\Software\Tavultesoft\Keyman Engine\7.0
root keyboard user pathREG_SZ Path where Keyman Engine installs keyboard files for current user.  If left blank, Keyman Engine will install keyboard files in %AppData%\Tavultesoft\Keyman Engine 7.0\Keyboard\
debugREG_DWORD If set to 1, Keyman Engine will write debug log files to %Desktop%\keymanlog.  These files can grow large quickly and capture every keystroke typed, so it is not recommended to leave debugging off unless specifically requested by Tavultesoft Support, for both privacy and performance reasons.  This setting can be changed in Keyman Configuration.
simulate altgrREG_DWORD If set to 1, Keyman Engine will recognise Ctrl+Alt as equivalent to AltGr (right alt).  This is useful on notebooks without an AltGr key.  This setting can be changed in Keyman Configuration.
hotkeys are togglesREG_DWORD If set to 1, keyboard hotkeys will toggle activation of Keyman Desktop keyboards, otherwise the hotkey will only switch the keyboard on.  This setting can be changed in Keyman Configuration.
release shift keys after key pressREG_DWORD If set to 1, pressing a key on the On Screen Keyboard will subsequently release the Shift/Ctrl/Alt modifier keys on the On Screen Keyboard, otherwise these modifiers must be switched off manually.  This setting can be changed in Keyman Configuration.
test keyman functioningREG_DWORD Checks if Keyman is correctly trapping keystrokes when starting up - this is used to work around other software that traps keystrokes and does not correctly pass keystroke messages on.  This should usually be left set to 1.  The default, if missing, is 1.  This setting can be changed in Keyman Configuration.
auto open oskREG_DWORD If 1, open the On Screen Keyboard whenever a Keyman Desktop keyboard is selected.  This setting can be changed in Keyman Configuration.
auto switch osk pagesREG_DWORD If 1, switch between the On Screen Keyboard and Usage Pages according to the settings of the selected keyboard, automatically.  This setting can be changed in Keyman Configuration.
switch language with keyboardREG_DWORD If 1, switch the Windows language as appropriate when a Keyman Desktop keyboard is selected.  This setting can be changed in Keyman Configuration.
switch language for all applicationsREG_DWORD Not currently implemented
enable hintsREG_DWORD Enable hint messages throughout Keyman Desktop.  This setting can be changed in Keyman Configuration.
HKCU\Software\Tavultesoft\Keyman Engine\7.0\Diag
HKCU\Software\Tavultesoft\Keyman Engine\7.0\Hotkeys
HKCU\Software\Tavultesoft\Keyman Engine\7.0\On Screen Keyboard
show visual keyboardREG_DWORD If 1, displays the On Screen Keyboard when Keyman Desktop starts
fade visual keyboardREG_DWORD If 1, makes the On Screen Keyboard partially transparent when the mouse cursor is not over it.  This option can be changed by right-clicking on the On Screen Keyboard.
active pageREG_DWORD 0 = On Screen Keyboard
1 = Character Map
2 = Entry Helper (not supported)
3 = Keyboard Usage
4 = Font Helper
positionREG_SZ 4 comma separated numbers indicating the last pixel position of the On Screen Keyboard
show toolbarREG_DWORD If 1, show the toolbar at the top of the On Screen Keyboard.  Defaults to 1.  This option can be changed by right-clicking on the On Screen Keyboard.
HKCU\Software\Tavultesoft\Keyman Engine\7.0\On Screen Keyboard\Character Map
cell sizeREG_DWORD Height of each cell in the character map.  This can be changed by dragging the slider at the bottom right of the character map.
characterREG_DWORD Last selected character in the character map.
filterREG_SZ Filter string.  This can be changed by clicking the Filter box in the Character Map.
fontREG_SZ Last selected display font for the Character Map.  Can be changed by right-clicking the Character Map.
insert modeREG_DWORD 0 = Code
1 = Character
2 = Name
3 = Text (default)
4 = Default
5 = Custom
qualityREG_DWORD 0 = Default Quality
1 = Draft Quality
2 = Proof Quality
3 = Non Antialiased
4 = Antialiased
5 = Cleartype (default)
HKLM\Software\Tavultesoft\Keyman Engine\7.0
root pathREG_SZ Installed path for Keyman Engine
root keyboard admin pathREG_SZ Path where Keyman Engine installs keyboard files for local machine.  If left blank, Keyman Engine will install keyboard files in %CommonAppData%\Tavultesoft\Keyman Engine 7.0\Keyboard\
HKCU\Software\Tavultesoft\Keyman Engine\7.0\Product Options\product
configuration stateREG_SZ String saving the state, e.g. selected page, etc, of the Configuration window.
saved licence numberREG_SZ Licence number saved for future display.
HKLM\Software\Tavultesoft\Keyman Engine\7.0\Product Options\product
product charmap source dataREG_SZ Path where unicodedata.txt can be found.  Optional.
available languagesREG_SZ CRLF separated list of display language codes installed.  Can be changed through Keyman Configuration / UI Languages
current languageREG_SZ Currently selected display language.  Can be changed through Keyman Configuration / UI Languages
show startupREG_DWORD If set to 1, shows the splash screen when the product starts.  Can be changed through Keyman Configuration.  This option will be ignored if the product is in evaluation mode, and the splash screen will always be shown.
show welcomeREG_DWORD If set to 1, shows the welcome screen after the product starts.  Can be changed through Keyman Configuration.
proxy serverREG_SZ Proxy server for online updates and keyboard downloads.  Can be set in Keyman Configuration, Support tab.
proxy portREG_DWORD Proxy server port for online updates and keyboard downloads.  Can be set in Keyman Configuration, Support tab.
proxy loginREG_SZ Encrypted string with proxy username and password.  Can be set in Keyman Configuration, Support tab.
HKCU\Software\Tavultesoft\Keyman Engine\7.0\Product Options\product\Hints
KH_CLOSEOSKREG_DWORD If 1, shows a hint message when the On Screen Keyboard is closed.  Will be ignored if global EnableHints is 0.
KH_EXITPRODUCTREG_DWORD If 1, shows a hint message when the product is about to exit.  Will be ignored if global EnableHints is 0.
KH_OSKHINTBARREG_DWORD If 1, shows hint messages at the bottom of the On Screen Keyboard.  Will be ignored if global EnableHints is 0.
KH_TUTORIALFINISHEDREG_DWORD If 1, shows a hint message when the user closes the Text Editor.  Will be ignored if global EnableHints is 0.
HKCU\Software\Tavultesoft\Keyman Engine\7.0\Installed Products\product
HKLM\Software\Tavultesoft\Keyman Engine\7.0\Installed Products\product
product file nameREG_SZ Full path and filename of product pxx file
product idREG_DWORD Unique identifier for product assigned by Tavultesoft
product install dirREG_SZ Full install path of product
HKLM\Software\Tavultesoft\Keyman Engine\7.0\Add-ins\addinname
addin nameREG_SZ Descriptive name of add-in
addin file nameREG_SZ Full path and filename of addin .kma file
HKCU\Software\Tavultesoft\Keyman Engine\7.0\Active Keyboards\keyboardname
keyman active hotkey STRING Hotkey integer to switch keyboard on.
keyman idREG_SZ Identifier for the keyboard assigned by Keyman when keyboard is installed
keyman installed languageREG_SZ Hex language identifier for associated Windows keyboard that Keyman installed when this keyboard was installed
HKCU\Software\Tavultesoft\Keyman Engine\7.0\Active Languages
HKCU\Software\Tavultesoft\Keyman Engine\7.0\Language Hotkeys
HKCU\Software\Tavultesoft\Keyman Engine\7.0\Installed Keyboards\keyboard
HKLM\Software\Tavultesoft\Keyman Engine\7.0\Installed Keyboards\keyboard
keyman default hotkeyREG_SZ Default hotkey in hotkey integer format
keyman fileREG_SZ Full path and filename of installed keyboard
keyman keyboard idREG_SZ Hex language identifier for associated system shadow keyboard.
package nameREG_SZ Name of package if installed as part of a package
default language idREG_SZ Hex language identifier of language this keyboard should be associated with
visual keyboardREG_SZ Full path and filename of on screen keyboard file, if installed.
HKCU\Software\Tavultesoft\Keyman Engine\7.0\Installed Packages\package
HKLM\Software\Tavultesoft\Keyman Engine\7.0\Installed Packages\package
package descriptionREG_SZ Descriptive name of package
package inf fileREG_SZ Full path and filename of package installed .inf file

Applies to:

  • Keyman Desktop Corporate 7.0
  • Keyman Desktop Light 7.0
  • Keyman Desktop Professional 7.0

KB article KMKB0060 created on 01 Jun 2009

Browse all knowledge base articles