1840f10f62
The framebuffer is a legacy backend and we know that at least OpenSUSE disabled it in the kernel configuration, so let's make it optional.
106 lines
3.1 KiB
Markdown
106 lines
3.1 KiB
Markdown
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|sdl>
|
|
The rendering backend to use. Default: the first compiled backend from the list above.
|
|
|
|
*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.
|
|
|
|
*haptic_feedback* = <true|false>
|
|
Enable or disable vibrations when pressing keys.
|
|
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>
|