osk-sdl(1)

osk-sdl1

Disk encryption initramfs on screen keyboard

Usage

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

Overview

OSK-SDL is a lightweight on screen keyboard used to unlock encrypted root partitions on mobile devices.

Options

Mandatory

-t, --testmode

Run in test mode, do not attempt to initialise the whole screen.

-d <path>

Decrypt this disk. This argument is mandatory unless -t is used.

-n <name>

Name of the decrypted disk.

Optional

-h

Show help options

-c <path>

Locaton of the osk-sdl config file. Defaults to "/etc/osk.conf".

-o <path>

Locaton of the osk-sdl config override file. Does not cause a failure if it couldn't be loaded.

-v, --verbose

Enable verbose output

-k, --keyscript

Enable keyscript mode. Password will be output to STDOUT for use with another program such as cryptsetup-initramfs.

-G, --no-gles

Do not use OpenGL ES driver unless it is the default driver. 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.

Examples

Decrypt /dev/sda1 to name "root"

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

Releases

3 releases since Debian 11 (Bullseye); the text changed 2 times.

  1. 11
  2. 12
  3. 13

--no-keyboard since Debian 12 (Bookworm); --show-keyboard since Debian 12 (Bookworm); -o since Debian 12 (Bookworm); -s since Debian 12 (Bookworm); -x since Debian 12 (Bookworm).

Authors

Undef <[email protected]>

From osk-sdl 0.67.1-4 in Debian 13 (Trixie). Parsed by carta from the page's man source.