Go to file
Namkhai B dee002155b Remove FreeBSD-specific PAM configuration
Something in FreeBSD's PAM modules changed, and
now using the "passwd" configuration file fails to unlock
2020-01-06 13:18:25 -07:00
completions Fix, clean up and sync docs and completions 2019-09-12 16:33:24 -04:00
include Added option to adjust ring position via CLI arguments and the config file 2019-11-27 19:53:07 -05:00
pam Remove FreeBSD-specific PAM configuration 2020-01-06 13:18:25 -07:00
.build.yml Remove references to pango 2019-01-23 12:20:24 +00:00
.gitignore Convert swaylock into standalone project 2019-01-13 21:16:47 -05:00
background-image.c background-image.c: remove stdbool header 2019-01-23 12:18:22 +00:00
cairo.c Remove unused functions in common code 2019-01-13 21:19:43 -05:00
comm.c Check password without blocking 2019-01-17 12:42:13 +01:00
LICENSE MIT license 2019-01-13 21:21:09 -05:00
log.c Implement logging and remove wlroots dependency 2019-01-14 23:30:54 -05:00
loop.c loop: bump required POSIX version for poll() 2019-05-20 19:51:48 +03:00
main.c Added option to adjust ring position via CLI arguments and the config file 2019-11-27 19:53:07 -05:00
meson_options.txt Set version in project file 2019-02-05 14:19:14 +01:00
meson.build Remove FreeBSD-specific PAM configuration 2020-01-06 13:18:25 -07:00
pam.c Make setuid error clearer. 2019-01-18 13:52:17 +00:00
password.c Submit password by pressing Ctrl+m 2019-08-15 18:47:27 +03:00
pool-buffer.c pool-buffer: add L suffix to POSIX version for consistency 2019-05-20 19:51:48 +03:00
README.md Remove references to pango 2019-01-23 12:20:24 +00:00
render.c Added option to adjust ring position via CLI arguments and the config file 2019-11-27 19:53:07 -05:00
seat.c Damage state when the keyboard layout changes 2019-06-22 22:36:53 +03:00
shadow.c Merge pull request #36 from c-edw/feature/ShadowBackendSleep 2019-01-27 18:03:29 -05:00
swaylock.1.scd Fix, clean up and sync docs and completions 2019-09-12 16:33:24 -04:00
unicode.c unicode.c: remove utf8_decode 2019-01-22 17:38:34 +00:00
wlr-input-inhibitor-unstable-v1.xml Convert swaylock into standalone project 2019-01-13 21:16:47 -05:00
wlr-layer-shell-unstable-v1.xml Convert swaylock into standalone project 2019-01-13 21:16:47 -05:00

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.