osk-sdl(1)

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

💖 OSK-SDL — ok so, the manual but make it make sense 💖

bestie. you are reading the manual page for osk-sdl, which lives in the General Commands Manual section, and it is genuinely the little icon that could: a tiny on-screen keyboard that unlocks your encrypted stuff. let's get into it 🎀

✨ NAME ✨

OSK-SDL — Disk encryption initramfs on screen keyboard 💅

🦋 SYNOPSIS 🦋

osk-sdl -d DISK -n NAME [OPTION]

that's the whole vibe. two things are basically required (-d and -n), and then everything else is seasoning 🧂

🌸 DESCRIPTION 🌸

so basically, OSK-SDL is a lightweight on screen keyboard that you use to unlock encrypted root partitions on mobile devices 📱🔓

that's it. that's the whole job. it's the little keyboard that pops up when your phone boots and is like "hey girl, type the password" 💖

👑 OPTIONS 👑

okay this is the part you actually came for, no cap.

💜 Mandatory (yes you literally need these)

  • -t, --testmode — run in test mode, and do not attempt to initialise the whole screen. lowkey the chill mode 🧘
  • -d <path> — decrypt this disk. this argument is mandatory unless you're using -t. no disk, no party, sorry 🫶
  • -n <name> — the name of the decrypted disk. give it a cute name, it deserves one ⭐

🌈 Optional (the fun extras)

  • -h — show help options. when in doubt, ask for help, bestie 💅
  • -c <path> — the location of the osk-sdl config file. defaults to "/etc/osk.conf" 🍓
  • -o <path> — the location of the osk-sdl config override file. and here's the nice part: if it couldn't be loaded, that does not cause a failure. she's forgiving like that 🙈
  • -v, --verbose — enable verbose output. turn this on when you want the tea ☕
  • -k, --keyscript — enable keyscript mode. the password gets output to STDOUT so another program can use it, like cryptsetup-initramfs. it's giving teamwork 🤝
  • -G, --no-gles — do not use the OpenGL ES driver unless it is the default driver. heads up: this is the default behavior when using DirectFB 🎀
  • -x, --no-keyboard — do not display the keyboard, only the input box. this is only useful on devices with a physical keyboard that want to use osk-sdl as a prettier prompt than "cryptsetup open" 😌✨
  • -s, --show-keyboard — show the osk by default, even if a physical keyboard is connected. stubborn? no, iconic 👑

⭐ EXAMPLES ⭐

decrypt /dev/sda1 to the name "root":

osk-sdl -d /dev/sda1 -n root -c /etc/osk.conf

see? -d for the disk, -n for the name, -c for the config. three little flags, one unlocked partition. slay 🔥

🫶 SEE ALSO 🫶

go read that one too, iykyk 💖

💀 AUTHORS 💀

Undef <debian@undef.tools>

okay that's the whole page, you're officially certified 🎓✨ this was osk-sdl, version 2025-02-23, dated 2025-02-23, straight from the osk-sdl(1) manual — love you, bye, go unlock something 💜🎀🦋

📦 where this page comes from