.\" 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" "1" "2023-02-12" "osk-sdl"
.P
.SH NAME
.P
OSK-SDL - Disk encryption initramfs on screen keyboard
.P
.SH SYNOPSIS
.P
osk-sdl -d DISK -n NAME [OPTION]
.P
.SH DESCRIPTION
.P
OSK-SDL is a lightweight on screen keyboard used to unlock encrypted root partitions on mobile devices.\&
.P
.SH OPTIONS
.P
.SS Mandatory
.P
\fB-t, --testmode\fR
.RS 4
Run in test mode, do not attempt to initialise the whole screen.\&
.P
.RE
\fB-d <path>\fR
.RS 4
Decrypt this disk.\& This argument is mandatory unless -t is used.\&
.P
.RE
\fB-n <name>\fR
.RS 4
Name of the decrypted disk.\&
.P
.P
.RE
.SS Optional
.P
\fB-h\fR
.RS 4
Show help options
.P
.RE
\fB-c <path>\fR
.RS 4
Locaton of the osk-sdl config file.\& Defaults to "/etc/osk.\&conf".\&
.P
.RE
\fB-o <path>\fR
.RS 4
Locaton of the osk-sdl config override file.\& Does not cause a failure if it couldn'\&t be loaded.\&
.P
.RE
\fB-v, --verbose\fR
.RS 4
Enable verbose output
.P
.RE
\fB-k, --keyscript\fR
.RS 4
Enable keyscript mode.\& Password will be output to STDOUT for use with another program such as cryptsetup-initramfs.\&
.P
.RE
\fB-G, --no-gles\fR
.RS 4
Do not use OpenGL ES driver unless it is the default driver.\& This is the default behavior when using DirectFB.\&
.P
.RE
\fB-x, --no-keyboard\fR
.RS 4
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"
.P
.RE
\fB-s, --show-keyboard\fR
.RS 4
Show the osk by default, even if a physical keyboard is connected.\&
.P
.RE
.SH EXAMPLES
.P
\fBDecrypt /dev/sda1 to name "root"\fR
.RS 4
osk-sdl -d /dev/sda1 -n root -c /etc/osk.\&conf
.P
.RE
.SH SEE ALSO
.RS 4
\fBosk.\&conf\fR(5)
.P
.RE
.SH AUTHORS
.P
\fBUndef\fR <debian@undef.\&tools>