oersen / swaylock

Screen locker for Wayland

swaylock

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

• ext-session-lock-v1, or
• wlr-layer-shell and wlr-input-inhibitor

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

Release Signatures

Releases are signed with E88F5E48 and published on GitHub. swaylock releases are managed independently of sway releases.

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.