swaylock

swaylock is a screen locking utility for Wayland compositors. It is compatible with any Wayland compositor which implements the following Wayland protocols:

• wlr-layer-shell + wlr-input-inhibitor, or ext-session-lock-v1
• xdg-output

See the man page, swaylock(1), for instructions on using swaylock.

Changes from upstream

• Added a flat indicator style that is a better fit for touchscreens
• Added a keypad for entering numeric pins (currently with fixed layout)

The file sway_test_config can be used for trying out the new features, it will contains the command a new feature was mainly tested with.

Installation

From Packages

Swaylock is available in many distributions. Try installing the "swaylock" package for yours.

Compiling from Source

Install dependencies:

• meson *
• wayland
• wayland-protocols *
• libxkbcommon
• cairo
• gdk-pixbuf2 **
• pam (optional)
• scdoc (optional: man pages) *
• git *

* Compile-time dep
** Optional: required for background images other than PNG

Run these commands:

meson build
ninja -C build
sudo ninja -C build install

On systems without PAM, you need to suid the swaylock binary:

sudo chmod a+s /usr/local/bin/swaylock

Swaylock will drop root permissions shortly after startup.