osk-sdl(5)

📦
version 0.67.1 · 4 versions
, in debian trixie, ubuntu questing

💖 osk-sdl(5) — the config file, bestie 💖

okay so this is the manual page for osk-sdl's configuration file, from the File Formats Manual section (section 5, iykyk). it's giving "let's make your on-screen keyboard look exactly how you want" energy, and honestly? we're obsessed. 🎀

✨ NAME ✨

OSK-SDL — configuration file 💅

🌸 DESCRIPTION 🌸

so here's the vibe: OSK-SDL is expecting a config file where every option gets its own line, one option/value pair per line, formatted exactly like this:

<option> = <value>

the default config file lives at /etc/osk.conf, and OSK-SDL will just... use it, if it's there. no drama. 🫶

but bestie, listen — if that file is not present, then you must specify an alternative configuration file on the command line when you run OSK-SDL. like, non-negotiable. the app needs its config, periodt. 😭

👑 OPTIONS 👑

every single one, no skips, we're thorough in this house:

  • wallpaper = <color> — the background color of the application. colors go in hex: #RRGGBB. 🌈
  • keyboard-background = <color> — the keyboard background color. colors go in hex: #RRGGBB.
  • keyboard-map = us — keyboard map layout. currently only us is supported, so that's the whole menu, sorry babe. 💀
  • keyboard-font = <TTF font file> — path to the TTF font file used for rendering keyboard caps. this must be an absolute path to the font file. no shortcuts, no relative paths. 🧚
  • keyboard-font-size = <value> — size of the keyboard cap font, in points.
  • key-foreground = <color> — the keyboard key cap font color. colors go in hex: #RRGGBB.
  • key-foreground-highlighted = <color> — the keyboard key font color for when the key is tapped/pressed. colors go in hex: #RRGGBB. the little glow-up moment ✨
  • key-background-letter = <color> — the background color for the letter key caps on the keyboard. colors go in hex: #RRGGBB.
  • key-background-return = <color> — the background color for the RETURN key cap on the keyboard. colors go in hex: #RRGGBB. the main character key, obviously. 👑
  • key-background-other = <color> — the background color for the symbols/numbers key caps on the keyboard. colors go in hex: #RRGGBB.
  • key-background-highlighted = <color> — the background color for key caps when they are tapped/pressed. colors go in hex: #RRGGBB.
  • key-radius = <value> — radius, in pixels, for rounding the corners of keyboard key caps. a value of 0 disables rounded corners entirely. (sharp corners era, if you're into that 💅)
  • key-vibrate-duration = <value> — duration, in milliseconds, for haptic vibration on key press.
  • key-preview-popup = true|false — enables or disables the preview popup when a key on the keyboard is touched. 🙈
  • inputbox-foreground = <color> — the font color for the input box. colors go in hex: #RRGGBB.
  • inputbox-foreground-error = <color> — the font color for the input box when it's displaying an error. colors go in hex: #RRGGBB. 🚨
  • inputbox-background = <color> — the background color for the input box. colors go in hex: #RRGGBB.
  • inputbox-background-error = <color> — the background color for the input box when it's displaying an error. colors go in hex: #RRGGBB.
  • inputbox-radius = <value> — radius, in pixels, for rounding the corners of the input box. a value of 0 disables rounded corners.
  • inputbox-dot-glyph = <value> — the font character glyph used to represent each character of the passphrase. you can set it to "none" (without the quotes) to disable displaying info about passphrase length on screen, or set it to a valid utf8 character from the configured font. 🍓
  • inputbox-font-size = <value> — size of the input box font, in points.
  • animations = true|false — enables or disables animations in the application. lowkey important: disabling animations might help make the application more responsive on certain devices. 🔥

🦋 SEE ALSO 🦋

💜 AUTHORS 💜

Clayton Craft <clayton@craftyguy.net> — thank you for your service, king 🫶

no cap, that's the whole config. go make your keyboard cute. 💖

okay byeee, this page was osk-sdl version dated 2025-02-23 — catch you on the flip side, bestie ✨🌸

📦 where this page comes from