unl0kr(5)

πŸ’– UNL0KR πŸ’–

okay bestie, so this is the manual page for unl0kr(5) β€” the File Formats Manual girlies β€” and it's literally all about the UNL0KR configuration file ✨ buckle up πŸŽ€


✨ NAME ✨

UNL0KR β€” the configuration file, and yes she ate πŸ’…


🌸 DESCRIPTION 🌸

ngl, UNL0KR is so chill about this. She expects a config file where every option sits on its own little line, one option/value pair per line, in exactly this format:

[section]
<option>=<value>

that's it. that's the whole vibe. πŸ¦‹

so here's the tea on launch β˜•: UNL0KR goes hunting for config files in a bunch of locations, and then β€” this is the important part β€” she successively merges all of them together into one single configuration. like a group chat merging into one giant huddle πŸ«‚

files are searched for, and if found, merged in this exact order:

  • /usr/share/unl0kr/unl0kr.conf
  • /usr/share/unl0kr/unl0kr.conf.d/ (alphabetically, bestie β€” she's organized)
  • /etc/unl0kr.conf
  • /etc/unl0kr.conf.d/ (alphabetically again πŸ’…)
  • Override files (in supplied order β€” your order, main character energy πŸ‘‘)
lowkey important: the merge order matters. later files win. iykyk.

πŸ‘‘ OPTIONS πŸ‘‘

πŸ’« General

  • animations = <true|false> β€” turn animations on or off. super useful for slower devices, no cap. Default: false.
  • backend = <fbdev|drm|sdl> β€” which rendering backend you wanna use. Default: the first compiled backend from that list above, so it depends on how she was built 🧚
  • timeout = <value> β€” how many seconds before unl0kr decides the entry is a failure and shuts down 😭 set timeout to 0 to disable this whole feature. Default: 0.

⌨️ Keyboard

  • autohide = <true|false> β€” whether to automatically hide the keyboard when a hardware keyboard gets detected on launch. Default: true.
  • layout = <us|de|fr|...> β€” the default layout to use. you can change it from the UI at runtime, so don't stress πŸ’… the available options are defined by the available keyboards at build time. Default: us.
  • popovers = <true|false> β€” enable or disable key press popovers that show you which key you selected. 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 actually be read πŸ‘€ selectable in the UI at runtime. Default: true.
  • bullet = <value> β€” the character 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> β€” picks 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> β€” picks 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 you're using the framebuffer backend, this triggers a display refresh after every single draw operation. heads up: 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, bestie, fr fr. Default: false.

πŸ”₯ SEE ALSO πŸ”₯


πŸ’œ AUTHORS πŸ’œ

Undef <debian@undef.tools> Johannes Marbach <n0-0ne@mailbox.org>


and that's the whole page, slay πŸ’…βœ¨ this little legend is filed under unl0kr(5) from the unl0kr source, dated 2026-06-20 β€” go forth and configure, icon, you've got this πŸŽ€πŸ¦‹πŸ’–

πŸ“¦ where this page comes from