~ifreund/waylock

[mirror] A small screenlocker for Wayland compositors
ci: restore FreeBSD builds
ci: use mirror for zig tarball downloads
build: bump version to 1.3.0-dev

clone

read-only
https://git.sr.ht/~ifreund/waylock
read/write
git@git.sr.ht:~ifreund/waylock

You can also use your local clone with git send-email.

#waylock

Waylock is a small screenlocker for Wayland compositors implementing ext-session-lock-v1. The ext-session-lock-v1 protocol is significantly more robust than previous client-side Wayland screen locking approaches. Importantly, the screenlocker crashing does not cause the session to be unlocked.

Install from your package manager

The main repository is on codeberg, which is where the issue tracker may be found and where contributions are accepted.

Read-only mirrors exist on sourcehut and github.

#Building

Note: If you are packaging waylock for distribution, see PACKAGING.md.

To compile waylock first ensure that you have the following dependencies installed:

  • zig 0.13.0
  • wayland
  • wayland-protocols
  • xkbcommon
  • pam
  • pkg-config
  • scdoc (optional, but required for man page generation)

Then run, for example:

zig build -Doptimize=ReleaseSafe --prefix /usr install

Note that PAM will only use configuration files in the system directory, likely /etc/pam.d by default. Therefore care must be taken if installing to a prefix other than /usr to ensure the configuration file pam.d/waylock is found by PAM.

#Usage

See the waylock(1) man page or the output of waylock -h for an overview of the command line options.

Run the waylock executable to lock the session. All monitors will be blanked with the -init-color. Typing causes the color to change to the -input-color. Esc or Ctrl-U clears all current input, while backspace deletes the last UTF-8 codepoint.

To unlock the session, type your password and press Enter. If the password is correct, waylock will unlock the session and exit. Otherwise, the color will change to the -fail-color and you may try again.

In order to automatically run waylock after a certain amount of time with no input or before sleep, the swayidle utility or a similar program may be used. See the swayidle(1) man page for details.

#Licensing

Waylock is released under the ISC License.