Screen locker for Wayland
Branch: master
Clone or download
ddevault Merge pull request #53 from swaywm/fix-meson-version
Fix --version when building from tarball
Latest commit 6b3be42 Feb 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
completions Add completions Jan 15, 2019
include Display xkb layout while typing Feb 6, 2019
pam Add FreeBSD-specific PAM configuration Aug 30, 2018
.build.yml Remove references to pango Jan 23, 2019
.gitignore Convert swaylock into standalone project Jan 14, 2019
LICENSE MIT license Jan 14, 2019
README.md Remove references to pango Jan 23, 2019
background-image.c background-image.c: remove stdbool header Jan 23, 2019
cairo.c Remove unused functions in common code Jan 14, 2019
comm.c Check password without blocking Jan 17, 2019
log.c Implement logging and remove wlroots dependency Jan 15, 2019
loop.c loop: fix loop_add_fd when called multiple times Jan 17, 2019
main.c Display xkb layout while typing Feb 6, 2019
meson.build Fix --version when building from tarball Feb 12, 2019
meson_options.txt Set version in project file Feb 5, 2019
pam.c Make setuid error clearer. Jan 18, 2019
password.c Check password without blocking Jan 17, 2019
pool-buffer.c Remove references to pango Jan 23, 2019
render.c Display xkb layout while typing Feb 6, 2019
seat.c Implement logging and remove wlroots dependency Jan 15, 2019
shadow.c Merge pull request #36 from c-edw/feature/ShadowBackendSleep Jan 27, 2019
swaylock.1.scd Fix minor typo in man page Feb 12, 2019
unicode.c unicode.c: remove utf8_decode Jan 22, 2019
wlr-input-inhibitor-unstable-v1.xml Convert swaylock into standalone project Jan 14, 2019
wlr-layer-shell-unstable-v1.xml Convert swaylock into standalone project Jan 14, 2019

README.md

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.