Add documentation for using the real-time signal

This commit is contained in:
Brandon Doornbos 2022-06-13 20:33:28 +02:00 committed by Maarten van Gompel
parent 1b7f5c4968
commit 07b9f293c0

View File

@ -21,7 +21,7 @@ new features.
- Support for 'Copy' keys which are not on the keymap - Support for 'Copy' keys which are not on the keymap
- Emoji support - Emoji support
- Compose key for character variants (e.g. diacritics) - Compose key for character variants (e.g. diacritics)
- Show/hide keyboard on signals (SIGUSR1 = hide, SIGUSR2 = show) - Show/hide keyboard on signals (SIGUSR1 = hide, SIGUSR2 = show, SIGRTMIN = toggle)
- Automatic portrait/landscape detection and subsequent layout switching - Automatic portrait/landscape detection and subsequent layout switching
@ -60,8 +60,8 @@ want a subset of the available layers, you can define which wants you want and i
them using the `-l` parameter. This takes takes a ordered comma separated list of them using the `-l` parameter. This takes takes a ordered comma separated list of
layout names that are defined in your layout set. layout names that are defined in your layout set.
The keyboard can be hidden by sending it a `SIGUSR1` signal and shown again by sending it `SIGUSR2`. This saves some The keyboard can be hidden by sending it a `SIGUSR1` signal, shown again by sending it `SIGUSR2` or toggled by sending it `SIGRTMIN`.
start up time and may be appropriate in some low-resource environments. This saves some start up time and may be appropriate in some low-resource environments.
Wvkbd has an output mode `-o` that will echo its output to standard output. This facility can be used if users want Wvkbd has an output mode `-o` that will echo its output to standard output. This facility can be used if users want
audio/haptic feedback, a feature explicitly out of scope for wvkbd. To achieve this, simply pipe wvkbd's output through the external tool audio/haptic feedback, a feature explicitly out of scope for wvkbd. To achieve this, simply pipe wvkbd's output through the external tool