buffybox/man/buffyboard.conf.5.scd

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

## Keyboard
*haptic_feedback* = <true|false>
	Enable or disable vibrations when pressing keys.
	Default: true.

*sticky_shift* = <true|false>
	Changes shift key behavior. When true, the keyboard remains in uppercase mode
	until the shift key is pressed again (sticky). When false, the keyboard switches
	back to lowercase mode and the shift key deactivates after a non-modifier key is
	pressed.
	Default: true.

## 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.

*ignore_unused_terminals* = <true|false>
	If true, buffyboard won't automatically update the layout of a new terminal and
	draw the keyboard, if the terminal is not opened by any process. In this case
	SIGUSR1 should be sent to buffyboard to update the layout. This quirk was introduced to resolve a race between buffyboard and systemd-logind according to the following scenario:
	- A user switches to a new virtual terminal
	- Buffyboard opens the terminal and changes the number of rows
	- systemd-logind sees that the terminal is opened by some other process and don't start getty@.service

	The race is resolved by enabling this option and installing a drop-in file
	for getty@.service that sends SIGUSR1 to buffyboard. Default: true.

# SEE ALSO
	*buffyboard*(1)

# AUTHORS

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