""
Schema version
Version of this configuration schema. Set on first start.
true
Use system defaults
If true, get configuration from system defaults first. This flag will be reset on first start.
''
Layout filename
Name of the file or basename of the current layout.
''
Theme filename
Name of the file or basename of the current theme.
true
Track changes of the current GTK-theme.
Switch onboard themes of matching basenames in sync with the current GTK-theme.
{'HighContrast' : 'HighContrast', 'HighContrastInverse' : 'HighContrastInverse', 'LowContrast' : 'LowContrast', 'ContrastHighInverse' : 'HighContrastInverse'}
System theme associations
List of encountered system themes (GTK-themes) and the Onboard themes they are linked to.
true
Show status icon instead of the classic minimize.
Display an icon in the notification area to hide and show onboard.
"auto"
Status icon provider
Choose between status icon implementations. AppIndicator shows Onboard on middle-click activation, GtkStatusIcon on left-click.
If unavailable, 'AppIndicator' falls back to GtkStatusIcon.
false
Start onboard with a minimized window.
Do not display the onboard window on start; start onboard minimized.
true
Show tooltips.
Show tooltips for certain buttons of the keyboard.
[ '0:Onboard\\nHome:https\\://launchpad.net/onboard', '1:Example:Create your macros here.' ]
Label and text for the snippet keys
Define labels and text lines for the snippet keys in the format index:label:text Allowed escape sequences are "\n" for newline, "\:" for a colon and "\\" for a backslash.
''
Default font of key labels
Default font of key labels. Applies to all themes which don't specify their font.'
[]
Default key label overrides
Optional key labels and and size groups that override the layouts' labels. Merged with current themes key_label_overrides. Format: ["key_id:label:group",...]. Colons and backslashes have to be escaped as "\:" and "\\".
0
Current settings page
Current tab page of onboard-settings.
false
Show onboard when unlocking the screen.
Make onboard appear in conjunction to the dialog to unlock the screen.
[0, 1.6]
Aspect range while embedded
Limits of the keyboard's aspect ratio when it is embedded, i.e. in unity-greeter, gnome-screensaver.
'#0000007F'
Background color when embedded
Color of the background bar that is rendered on top of the background image in unity-greeter and gnome-screensaver. If empty, the color is taken from the keyboard's current background color.'
true
Enable drawing background image when embedded
Enable drawing the current GNOME background image in unity-greeter and gnome-screensaver.
85.0
Horizontal position in unity-greeter
Maximum distance of the keyboard in unity-greeter in pixels from the left screen edge. Depending on the available width, the offset is gradually lowered. Negative values center the keyboard horizontally.
This key has no effect outside of unity-greeter.
false
Auto-show enabled
Auto-show Onboard for editable widgets. Requires gnome-accessibility (at-spi2).
"prevent-occlusion"
Auto-repositioning when keyboard is floating
The default method "prevent-occlusion" only moves the keyboard when it would otherwise cover the currently focused text entry. Set to "none" to disable repositioning.
"prevent-occlusion"
Auto-repositioning when keyboard is docked
The default method "prevent-occlusion" only moves the keyboard when it would otherwise cover the currently focused text entry. Set to "none" to disable repositioning.
(25.0, 55.0, 25.0, 40.0)
Widget clearance
Border to leave unoccluded around a focused text widget (left, top, right, bottom).
true
Hide on key-press
Hide Onboard when pressing any key on a physical keyboard.
1800.0
Auto-show pause after key-press.
Number of seconds auto-show remains paused after a physical key-press. -1.0 to pause forever.
true
Enable tablet/laptop mode detection
Enable listening to lock-key-code and unlock-key-code and lock/unlock auto-show in response.
0
Key-code to unlock auto-show
When this key-press is received, resume auto-show. A convertible device might signal entering tablet-mode that way.
0
Key-code to lock auto-show
When this key-press is received, stop auto-show indefinitely. A convertible device might signal entering laptop-mode that way.
''
Name of tablet mode state file
Path to a text file indicating whether tablet-mode is active or not, e.g. a sysfs path.
'1'
Pattern for tablet-mode-state-file
String to find in 'tablet-mode-state-file' in order to detect tablet-mode, e.g. 1.
false
Enable detection of keyboard devices
If enabled, auto-show will be paused while physical keyboard devices are connected.
[]
Keyboard devices to ignore
List of keyboard devices that should not pause auto-show.
false
Show click buttons
Show mouse click buttons.
0.0
Auto-release sticky keys
Time of inactivity in seconds until latched and locked modifiers and layer keys are released automatically. This applies no matter if the keyboard is hidden or visible, but when hidden, "sticky-key-release-on-hide-delay" may release the keys earlier. Leave at 0.0 to not automatically release them.
5.0
Auto-release sticky keys after hiding the keyboard
Time after hiding the keyboard in seconds until latched and locked modifiers and layer keys are released automatically. Leave at 0.0 to not automatically release them.
{'all' : 'cycle'}
Behavior of sticky keys
Controls the behavior of sticky keys, e.g. modifier and layer keys.
Groups of keys or single keys may be assigned individual behaviors.
Valid groups are 'all', 'modifiers' and 'layers'. Individual keys may be specified by their ids defined in the .layout files.
Valid behaviors are: 'cycle' (default), 'dblclick', 'latch', 'lock' as well as 'latch-lock-nocycle', 'dblclick-nocycle', 'latch-nocycle', 'lock-nocycle' and 'push'.
"delayed-stroke"
Default key action
The key action determines when key strokes are generated.
single-stroke: generate key-press on button down, key-release on button-up. If the system is configured to do so, holding the button down long enough initiates key repeats.
delayed-stroke: generate key-press and key-release on button-release, there is no support for key-repeat, but holding the button down long enough generates a long press.
"auto"
Key synthesizer
The key-stroke generator to use.
0.5
Long-press delay
Time to hold a key down until a long-press is detected.
"multi"
Touch input handling
Enable listening to single or multiple simultaneous touch events (multi-touch). Falls back to regular pointer events when there are no actual touch events coming in.
"XInput"
Input event source
Receive pointing device events from either GTK (safe) or XInput (recommended if it works).'XInput' gets around a number of pointer grab issues. In particular, it allows to freely type into text entries with pop-up windows, for example in the firefox URL-bar.
false
Touch feedback enabled
Show extra labels above currently pressed keys.
0
Touch-feedback size
Size of the touch-feedback popup in pixels. 0 to let Onboard guess it based on physical monitor size.
false
Audio feedback
Play a sound when a key is pressed.
false
Place audio feedback in space
Place audio feedback in space between speakers.
false
Show secondary labels
Show additional key labels of different modifier levels.
0.0
Delay between key-strokes
Delay in seconds between generated key-strokes when inserting word suggestions or snippets. Mainly meant to work around key-stroke losses in Firefox and other Gtk-2 applications. Has no effect on Gtk-3 applications.
1.0
Delay until external modifier changes become visible
Delay in seconds until most modifier changes from the outside become visible in Onboard. 0.0 for no delay. -1.0 to never show modifier changes.
{"button3" : "SHIFT"}
Auto-activate modifiers based on how a key was pressed
Format {trigger, modifier[|modifier [|...]]}. Triggers may be one of "button0"-"button32", "swipeup", or "swipedown".
Modifiers can only be "SHIFT" at the moment.
true
Always on visible workspace
Show keyboard and icon palette always on visible workspace.
false
Window decoration
Show window title bar and frame.
false
Force window to top
Try harder to keep the keyboard on top of other windows. Results depend very much on the behavior of the window manager. In Compiz/Unity it helps to keep Onboard above Dash.
false
Keep the window's aspect ratio'
Constrain the size of the main window to the layout's aspect ratio.
false
Transparent window background
Makes the background of the keyboard fully transparent.
0.0
Window transparency
Transparency of the keyboard window.
10
Background transparency
Transparency of the background of the keyboard window.
false
Inactive transparency change enabled
Change transparency to 'inactive-transparency' on inactivity.
50.0
Inactive window transparency
Transparency after leaving onboards window.
1.0
Inactive transparency delay
Delay in seconds from leaving Onboards window until the inactive transparency takes effect.
"E SE S SW W NW N NE M"
Window resize and move handles
Active resize and move handles, space separated.
false
Docking enabled
Enable docking of the keyboard window to screen edges. 'False' to leave the keaboard floating.
true
Shrink workarea when docked.
When docked, shrink the avaliable space for maximized windows.
"bottom"
Docking screen edge
Edge to dock the keyboard window to.
"active"
Docking monitor
Monitor where the keyboard docks.
[0.0, 2.0]
Aspect range while docked and expanded
Limits of the keyboard's aspect ratio when it is docked and expanded.
100
X position of the keyboard
Horizontal position of the keyboard window.
50
Y position of the keyboard
Vertical position of the keyboard window.
700
Window width
Width of the keyboard window.
205
Window height
Height of the keyboard window.
700
Docked window width
Width of the docked keyboard window.
205
Docked window height
Height of the docked keyboard window.
true
Docked expansion
Expand the keyboard to the edges of the workarea when docked.
100
X position of the keyboard
Horizontal position of the keyboard window.
50
Y position of the keyboard
Vertical position of the keyboard window.
600
Window width
Width of the keyboard window.
200
Window height
Height of the keyboard window..
600
Docked window width
Width of the docked keyboard window.
200
Docked window height
Height of the docked keyboard window.
true
Docked expansion
Expand the keyboard to the edges of the workarea when docked.
false
Show icon palette when onboard is minimized.
Display a floating icon when onboard is minimized. By clicking on it, onboard reappears.
"E SE S SW W NW N NE M"
Window resize and move handles
Active resize and move handles, space separated.
100
Horizontal position of the icon palette.
Horizontal position of the icon palette on the screen.
50
Vertical position of the icon palette.
Vertical position of the icon palette on the screen.
64
Width of the icon palette.
Width of the icon palette in pixels.
64
Height of the icon palette.
Height of the icon palette in pixels.
100
Horizontal position of the icon palette.
Horizontal position of the icon palette on the screen.
50
Vertical position of the icon palette.
Vertical position of the icon palette on the screen.
64
Width of the icon palette.
Width of the icon palette in pixels.
64
Height of the icon palette.
Height of the icon palette in pixels.
-1
Drag threshold
Accidental resize and move protection. Threshold is the distance in pixels the pointer has to travel before dragging begins. -1 for system drag threshold, 0 to disable and any positive integer as custom threshold.
true
Hide hover click click-type window
When Hover Click is enabled, hide the system-provided window for click type selection.
true
Enable click-type window on exit
Always enable the system provided window for click-type selection when exiting onboard.
This key is deprecated and has no effect with mousetweaks version 3.10.0 or later.
''
Color scheme filename
Name of the file with the color scheme.
0.0
Strength of the background gradient
Strength of the background gradient. Range 0-100%, with 0 for flat color.
'flat'
Key style
Drawing style of the keys. Valid values are currently "flat", "gradient" and "dish".
0.0
Roundness
Radius of rounded corners around the keys. Range 0-100%, with 0 for fully rectangular keys.
100.0
Key size
Size of all keys relative to the layout definition in percent.
100.0
Width of the key border
Width of the border in percent of the style default. Minimum width in screen coordinates is 1 pixel. A value of 0 turns the line off.
0.0
Strength of the fill gradient
Strength of the keys' fill gradient. Range 0-100%, with 0 for flat color.
0.0
Strength of the stroke gradient
Strength of the keys' outline gradient. Range 0-100%, with 0 for flat color.
0.0
Gradient direction
Direction of simulated incoming light. 0-360 degrees, where 0 stands for light from the top.
''
Font for key-labels
Font for key labels. May include the modifiers 'bold', 'italic', 'condensed', separated by spaces.
[]
Key label overrides
Optional key labels and and size groups that override the layouts labels. Format: ["key_id:label:group",...]. Colons and backslashes have to be escaped as "\:" and "\\".
0.0
Shadow strength
Strength of the keys' shadows. Range 0-100%, 0 turns shadows off.
0.0
Shadow size
Size and offset of the keys' shadows. Range 0-100%.
false
Disallow showing click helpers
Disallow showing click buttons.
false
Disable hover click button
Disable Onboard's hover click button. Hover click can still be turned on in gnome system settings.
false
Disable dwell-activation
Disable dwell-activation of all dwell-enabled buttons and the icon palette. This has no effect on the system-wide available hover click functionality.
false
Disallow opening preferences
Disallow opening Onboards preferences via button and status menu. Onboard-settings can still be started from the desktop shortcut and from command line.
false
Disallow quitting Onboard
Disallow quitting Onboard by pressing the quit button or choosing quit from the status menu. Onboard then only closes by sending SIGTERM, i.e. killing it.
false
Never show touch handles
Never show the enlarged move/resize handles for touch and hover click users.
[["CTRL", "LALT", "F[0-9]+"]]
Disable keys
Disable the key action for the listed key combinations. Entries consist of a regex pattern to match Onboard's key ids, preceeded by optional modifiers.
Available modifiers are: SHIFT, CTRL, LALT, RALT, LWIN, CAPS, NMLK
Example: [["LALT", "TAB"], ["LALT", "SHIFT", "TAB"], ["CTRL", "ALT", "F[0-9]+"]]
false
Enable scanner
Set Onboard to keyboard scanning mode.
"Autoscan"
Scan mode
The scan mode determines how the scanner moves between keys.
1.20
Scanning interval
The delay before the scanner selects the next key. (in seconds)
0.05
Fast scanning interval
The scanning interval used for forward progression in 'Overscan' mode. (in seconds)
2
Scannig cycles
The maximum number of keyboard cycles before the scanner stops.
5
Amount of backtracking
The number of keys the scanner will backtrack in 'Overscan' mode.
false
User scan
The scanner should only step while the switch is held down. ('Autoscan' mode)
false
Alternate actions
The scanner should swap switch actions after every key activation. ('Stepscan' mode)
"Default"
Input device name
The name of the input device used for scanning.
false
Detach input device
The input device should not control the system cursor/caret.
{}
Key mapping
Maps key values to scan actions. (Format: keyval:action)
{1:0,3:5}
Button mapping
Maps mouse buttons to scan actions. (Format: button:action)
true
Flash keys
Keys should flash when activated.
""
Active language.
Currently active language id for word prediction and spell checker. The format is ll[_CC] where ll is a ISO 639 two letter language code and CC a ISO 3166 country code, e.g. en_US, de_DE. Leave it empty for the system default language.
[]
Most recently used languages.
List of most recently used languages.
5
Maximum number of recently used languages.
The maximum number of recently used languages visible in the language menu.
"hunspell"
Backend
The spell checker backend.
false
Auto-capitalization enabled
Automatically capitalize words while typing.
false
Auto-correction enabled
Automatically correct words while typing.
false
Word suggestions enabled
Set to 'true' to enable word suggestions.
true
Spelling suggestions enabled
Set to 'true' to enable spelling suggestions for mispelled words at or before the cursor.
true
Enable automatic learning
Continuously improve word predictions with typed and inserted words.
false
Pause learning
Lock the button to pause learning.
"nothing"
Learning behavior when paused
Learning behavior while the "Pause learning" button is active.
With 'known-only', new words are rejected, but frequency and recency of already known words are still recorded.
true
Enable punctuation assistance
Add and remove spaces when inserting word suggestions followed by punctuation characters.
false
Insert word separators lazily
Experimental, not recommended.
false
Enable stealth mode
Stealth mode disables word prediction, auto learning and the typing history for secure password entry.
true
Accent insensitive
Enable accent insensitive word completion.
5
Maximum number of predictions.
Maximum number of predicted words shown in the word suggestion bar.
false
Show the context line
Display the currently edited text line in the keyboard.
["previous-predictions", "next-predictions", "language", "hide"]
Buttons visible in the word suggestion bar
Key ids and order of buttons visible in the word suggestion bar.