unify build systems of buffyboard and unl0kr
This commit is contained in:
Vladimir Stoiakin
parent
20b084c0b4
commit
ec21e5ead9
14 changed files with 120 additions and 147 deletions
65
man/buffyboard.1.scd
Normal file
65
man/buffyboard.1.scd
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
buffyboard(1) "buffyboard"
|
||||
|
||||
# NAME
|
||||
|
||||
BUFFYBOARD - Touch-enabled framebuffer keyboard (not only) for vampire slayers.
|
||||
|
||||
# SYNOPSIS
|
||||
|
||||
buffyboard [OPTION]
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
Buffyboard is a touch-enabled on-screen keyboard running on the Linux
|
||||
framebuffer. It's primarily intended for vampire hunting but you can
|
||||
also use it as a general purpose keyboard.
|
||||
|
||||
Buffyboard uses LVGL for input processing and rendering. Key events are
|
||||
forwarded directly to the kernel via a uinput device. Since the latter
|
||||
emulates a hardware keyboard, the terminal keymap must match with
|
||||
buffyboard's layout or else on-screen keys might not produce the correct
|
||||
result.
|
||||
|
||||
# OPTIONS
|
||||
|
||||
## Optional
|
||||
|
||||
*-C, --config-override*
|
||||
Path to a config override file. Can be supplied multiple times. Config
|
||||
files are merged in the following order:
|
||||
- /usr/share/buffyboard/buffyboard.conf
|
||||
- /usr/share/buffyboard/buffyboard.conf.d/\* (alphabetically)
|
||||
- /etc/buffyboard.conf
|
||||
- /etc/buffyboard.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.
|
||||
*-r, --rotate=[0-3]*
|
||||
Rotate the UI to the given orientation. The
|
||||
values match the ones provided by the kernel in
|
||||
/sys/class/graphics/fbcon/rotate.
|
||||
* 0 - normal orientation (0 degree)
|
||||
* 1 - clockwise orientation (90 degrees)
|
||||
* 2 - upside down orientation (180 degrees)
|
||||
* 3 - counterclockwise orientation (270 degrees)
|
||||
*-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
|
||||
|
||||
*Execute Buffyboard using the default config*
|
||||
buffyboard
|
||||
|
||||
# SEE ALSO
|
||||
*buffyboard.conf*(5)
|
||||
|
||||
# AUTHORS
|
||||
|
||||
*Undef* <debian@undef.tools>
|
||||
54
man/buffyboard.conf.5.scd
Normal file
54
man/buffyboard.conf.5.scd
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
buffyboard(5) "buffyboard"
|
||||
|
||||
# NAME
|
||||
|
||||
BUFFYBOARD - configuration file
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
BUFFYBOARD expects a configuration file with options in the following format, with
|
||||
one option/value pair per line:
|
||||
|
||||
```
|
||||
[section]
|
||||
<option>=<value>
|
||||
```
|
||||
|
||||
On launch, BUFFYBOARD searches for configuration files in various locations and
|
||||
successively merges all files together into a single configuration. Files are searched
|
||||
for and, if found, merged in the following order:
|
||||
- /usr/share/buffyboard/buffyboard.conf
|
||||
- /usr/share/buffyboard/buffyboard.conf.d/ (alphabetically)
|
||||
- /etc/buffyboard.conf
|
||||
- /etc/buffyboard.conf.d/ (alphabetically)
|
||||
- Override files (in supplied order)
|
||||
|
||||
# OPTIONS
|
||||
|
||||
## Theme
|
||||
*default* = <adwaita-light|adwaita-dark|breezy-light|breezy-dark|nord-light|nord-dark|pmos-light|pmos-dark>
|
||||
Selects the default theme on boot. Can be changed at runtime to the
|
||||
alternative theme. Default: breezy-dark.
|
||||
|
||||
## Input
|
||||
*pointer* = <true|false>
|
||||
Enable or disable the use of a hardware mouse or other pointing device.
|
||||
Default: true.
|
||||
|
||||
*touchscreen* = <true|false>
|
||||
Enable or disable the use of the touchscreen.
|
||||
Default: true.
|
||||
|
||||
## Quirks
|
||||
*fbdev_force_refresh* = <true|false>
|
||||
If true and using the framebuffer backend, this triggers a display refresh
|
||||
after every draw operation. This has a negative performance impact.
|
||||
Default: false.
|
||||
|
||||
# SEE ALSO
|
||||
*buffyboard*(1)
|
||||
|
||||
# AUTHORS
|
||||
|
||||
*Undef* <debian@undef.tools>
|
||||
*Johannes Marbach* <n0-0ne@mailbox.org>
|
||||
21
man/meson.build
Normal file
21
man/meson.build
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
progscdoc = depscdoc.get_variable(pkgconfig: 'scdoc')
|
||||
|
||||
foreach file : [
|
||||
'buffyboard.1',
|
||||
'buffyboard.conf.5',
|
||||
'unl0kr.1',
|
||||
'unl0kr.conf.5'
|
||||
]
|
||||
|
||||
section = file.split('.')[-1]
|
||||
|
||||
custom_target(file,
|
||||
command: progscdoc,
|
||||
feed: true,
|
||||
capture: true,
|
||||
input: file + '.scd',
|
||||
output: file,
|
||||
install: true,
|
||||
install_dir: get_option('mandir') / 'man' + section
|
||||
)
|
||||
endforeach
|
||||
54
man/unl0kr.1.scd
Normal file
54
man/unl0kr.1.scd
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
unl0kr(1) "unl0kr"
|
||||
|
||||
# NAME
|
||||
|
||||
UNL0KR - LVGL based initramfs disk unlocker
|
||||
|
||||
# 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:
|
||||
- /usr/share/unl0kr/unl0kr.conf
|
||||
- /usr/share/unl0kr/unl0kr.conf.d/\* (alphabetically)
|
||||
- /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* <debian@undef.tools>
|
||||
102
man/unl0kr.conf.5.scd
Normal file
102
man/unl0kr.conf.5.scd
Normal file
|
|
@ -0,0 +1,102 @@
|
|||
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]
|
||||
<option>=<value>
|
||||
```
|
||||
|
||||
On launch, UNL0KR searches for configuration files in various locations and
|
||||
successively merges all files together into a single configuration. Files are searched
|
||||
for and, if found, merged in the following order:
|
||||
- /usr/share/unl0kr/unl0kr.conf
|
||||
- /usr/share/unl0kr/unl0kr.conf.d/ (alphabetically)
|
||||
- /etc/unl0kr.conf
|
||||
- /etc/unl0kr.conf.d/ (alphabetically)
|
||||
- Override files (in supplied order)
|
||||
|
||||
# OPTIONS
|
||||
|
||||
## General
|
||||
*animations* = <true|false>
|
||||
Enable or disable animations. Useful for slower devices. Default: false.
|
||||
|
||||
*backend* = <fbdev|drm>
|
||||
The rendering backend to use. Default: fbdev.
|
||||
|
||||
*timeout* = <value>
|
||||
The time in seconds before unl0kr will consider the entry a failure
|
||||
and shutdown. Setting timeout to 0 disables this feature. Default: 0.
|
||||
|
||||
## Keyboard
|
||||
*autohide* = <true|false>
|
||||
Whether to automatically hide the keyboard when a hardware keyboard
|
||||
is detected on launch. Default: true.
|
||||
|
||||
*layout* = <us|de|fr|...>
|
||||
The default layout to use. Can be changed from the UI at runtime.
|
||||
The available options are defined by the available keyboards at build time.
|
||||
Default: us.
|
||||
|
||||
*popovers* = <true|false>
|
||||
Enable or disable key press popovers showing the selected key.
|
||||
default: true.
|
||||
|
||||
## Textarea
|
||||
*obscured* = <true|false>
|
||||
Whether the password in the text entry box can be read. Selectable in
|
||||
the UI at runtime. Default: true.
|
||||
|
||||
*bullet* = <value>
|
||||
The character that will be used to obscure the password. Default: bullet.
|
||||
|
||||
## Theme
|
||||
*default* = <adwaita-light|adwaita-dark|breezy-light|breezy-dark|nord-light|nord-dark|pmos-light|pmos-dark>
|
||||
Selects the default theme on boot. Can be changed at runtime to the
|
||||
alternative theme. Default: breezy-dark.
|
||||
|
||||
*alternative* = <breezy-light|breezy-dark|pmos-light|pmos-dark>
|
||||
Selects the alternative theme which the user can then choose on boot.
|
||||
Default: breezy-light.
|
||||
|
||||
## Input
|
||||
*keyboard* = <true|false>
|
||||
Enable or disable the use of hardware keyboards. Default: true
|
||||
|
||||
*pointer* = <true|false>
|
||||
Enable or disable the use of a hardware mouse or other pointing device.
|
||||
Default: true.
|
||||
|
||||
*touchscreen* = <true|false>
|
||||
Enable or disable the use of the touchscreen.
|
||||
Default: true.
|
||||
|
||||
## Quirks
|
||||
*fbdev_force_refresh* = <true|false>
|
||||
If true and using the framebuffer backend, this triggers a display refresh
|
||||
after every draw operation. This has a negative performance impact.
|
||||
Default: false.
|
||||
|
||||
*terminal_prevent_graphics_mode* = <true|false>
|
||||
If true, this avoids setting the terminal into graphics mode. This will
|
||||
show the terminal command prompt. Default: false.
|
||||
|
||||
*terminal_allow_keyboard_input* = <true|false>
|
||||
If true, this avoids turning off terminal keyboard input. This will show
|
||||
your password on the terminal. Default: false.
|
||||
|
||||
# SEE ALSO
|
||||
*unl0kr*(1)
|
||||
|
||||
# AUTHORS
|
||||
|
||||
*Undef* <debian@undef.tools>
|
||||
*Johannes Marbach* <n0-0ne@mailbox.org>
|
||||
Loading…
Add table
Add a link
Reference in a new issue