.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "osk-sdl" "5" "2023-02-12" "osk-sdl"
.P
.SH NAME
.P
OSK-SDL - configuration file
.P
.SH DESCRIPTION
.P
OSK-SDL expects a configuration file with options in the following format, with one option/value pair per line:
.P
.RS 4
<option> = <value>
.P
.RE
The default configuration file is at /etc/osk.\&conf, OSK-SDL will use this configuration file if present.\& If it is not
present, then an alternative configuration file must be specified on the command line when running OSK-SDL.\&
.P
.SH OPTIONS
.P
\fBwallpaper\fR = <color>
.RS 4
The background color of the application.\& Colors are specified in hex: #RRGGBB.\&
.P
.RE
\fBkeyboard-background\fR = <color>
.RS 4
The keyboard background color.\& Colors are specified in hex: #RRGGBB.\&
.P
.RE
\fBkeyboard-map\fR = us
.RS 4
Keyboard map layout, currently only '\&us'\& is supported.\&
.P
.RE
\fBkeyboard-font\fR = <TTF font file>
.RS 4
Path to the TTF font file to use for rendering keyboard caps.\& This must be an absolute path to the font file.\&
.P
.RE
\fBkeyboard-font-size\fR = <value>
.RS 4
Size of keyboard cap font, in points.\&
.P
.RE
\fBkey-foreground\fR = <color>
.RS 4
The keyboard key cap font color.\& Colors are specified in hex: #RRGGBB.\&
.P
.RE
\fBkey-foreground-highlighted\fR = <color>
.RS 4
The keyboard key font color when the key is tapped/pressed.\& Colors are specified in hex: #RRGGBB.\&
.P
.RE
\fBkey-background-letter\fR = <color>
.RS 4
The background color for letter key caps on the keyboard.\& Colors are specified in hex: #RRGGBB.\&
.P
.RE
\fBkey-background-return\fR = <color>
.RS 4
The background color for RETURN key cap on the keyboard.\& Colors are specified in hex: #RRGGBB.\&
.P
.RE
\fBkey-background-other\fR = <color>
.RS 4
The background color for the symbols/numbers key caps on the keyboard.\& Colors are specified in hex: #RRGGBB.\&
.P
.RE
\fBkey-background-highlighted\fR = <color>
.RS 4
The background color for key caps on the keyboard when they are tapped/pressed.\& Colors are specified in hex: #RRGGBB.\&
.P
.RE
\fBkey-radius\fR = <value>
.RS 4
Radius, in pixels, for rounding corners of keyboard key caps.\& A value of 0 disables rounded corners.\&
.P
.RE
\fBkey-vibrate-duration\fR = <value>
.RS 4
Duration, in milliseconds, for haptic vibration on key press.\&
.P
.RE
\fBkey-preview-popup\fR = true|false
.RS 4
Enables or disables the preview popup when a key on the keyboard is touched.\&
.P
.RE
\fBinputbox-foreground\fR = <color>
.RS 4
The font color for input box.\& Colors are specified in hex: #RRGGBB.\&
.P
.RE
\fBinputbox-foreground-error\fR = <color>
.RS 4
The font color for the input box when displaying an error.\& Colors are specified in hex: #RRGGBB.\&
.P
.RE
\fBinputbox-background\fR = <color>
.RS 4
The background color for the input box.\& Colors are specified in hex: #RRGGBB.\&
.P
.RE
\fBinputbox-background-error\fR = <color>
.RS 4
The background color for the input box when displaying an error.\& Colors are specified in hex: #RRGGBB.\&
.P
.RE
\fBinputbox-radius\fR = <value>
.RS 4
Radius, in pixels, for rounding corners of input box.\& A value of 0 disables rounded corners.\&
.P
.RE
\fBinputbox-dot-glyph\fR = <value>
.RS 4
Font character glyph to used to represent each character of the passphrase.\& Can be set to "none" (without quotes)
disable displaying information about passphrase length on screen, or set to a valid utf8 character from the
configured font.\&
.P
.RE
\fBinputbox-font-size\fR = <value>
.RS 4
Size of input box font, in points.\&
.P
.RE
\fBanimations\fR = true|false
.RS 4
Enables or disables animations in the application.\& Disabling animations might help with making the application
more responsive on certain devices.\&
.P
.RE
.SH SEE ALSO
.RS 4
\fBosk-sdl\fR(1)
.P
.RE
.SH AUTHORS
.P
\fBClayton Craft\fR <clayton@craftyguy.\&net>