Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.38 KB

README.md

File metadata and controls

57 lines (38 loc) · 1.38 KB
Raw

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
  • xdg-output
  • xdg-shell

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

Release Signatures

Releases are signed with B22DA89A 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.

If you're interested in packaging swaylock for your distribution, stop by the IRC channel or shoot an email to sir@cmpwn.com for advice.

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.