diff --git a/doc/unl0kr.1.scd b/doc/unl0kr.1.scd new file mode 100644 index 0000000..2fd0ffe --- /dev/null +++ b/doc/unl0kr.1.scd @@ -0,0 +1,52 @@ +unl0kr(1) "unl0kr" + +# NAME + +UNL0KR + +# SYNOPSIS + +unl0kr [OPTION] + +# DESCRIPTION + +UNL0KR is a disk unlocker for the initramfs based on LVGL. By using LVGL and +rendering directly to the framebuffer it can work without relying on GPU +hardware acceleration. This makes for much more managable initramfs sizes. + +Unl0kr utilises the CRYPTTAB_TRIED variable. Upon completion, the entered +password is printed to STDOUT. All other output happens on STDERR. + +# OPTIONS + +## Optional + +*-C, --config-override* + Path to a config override file. Can be supplied multiple times. Config + files are merged in the following order: + - /etc/unl0kr.conf + - /etc/unl0kr.conf.d/\* (alphabetically) + - Override files (in supplied order) +*-g, --geometry=NxM[@X,Y]* + Force a display size of N horizontal times M vertical pixels, offset + horizontally by X pixels and vertically by Y pixels. +*-d --dpi=N* + Override the display's DPI value. +*-h, --help* + Print this message and exit. +*-v, --verbose* + Enable more detailed logging output on STDERR. +*-V, --version* + Print the unl0kr version and exit. + +# EXAMPLES + +*Decrypt /dev/sda1 to name "root"* + CRYPTTAB_SOURCE="/dev/sda1" CRYPTTAB_TRIED="0" unl0kr | cryptsetup --perf-no_read_workqueue --perf-no_write_workqueue open "/dev/sda1" root - + +# SEE ALSO + *unl0kr.conf*(5) + +# AUTHORS + +*Undef* diff --git a/doc/unl0kr.conf.5.scd b/doc/unl0kr.conf.5.scd new file mode 100644 index 0000000..f2a6560 --- /dev/null +++ b/doc/unl0kr.conf.5.scd @@ -0,0 +1,95 @@ +unl0kr(5) "unl0kr" + +# NAME + +UNL0KR - configuration file + +# DESCRIPTION + +UNL0KR expects a configuration file with options in the following format, with +one option/value pair per line: + +``` +[section] +