Go to file
2019-01-13 21:30:20 -05:00
include Remove unused functions in common code 2019-01-13 21:19:43 -05:00
pam Add FreeBSD-specific PAM configuration 2018-08-30 09:58:57 +02:00
.gitignore Convert swaylock into standalone project 2019-01-13 21:16:47 -05:00
background-image.c Convert swaylock into standalone project 2019-01-13 21:16:47 -05:00
cairo.c Remove unused functions in common code 2019-01-13 21:19:43 -05:00
LICENSE MIT license 2019-01-13 21:21:09 -05:00
list.c Remove unused functions in common code 2019-01-13 21:19:43 -05:00
loop.c Convert swaylock into standalone project 2019-01-13 21:16:47 -05:00
main.c Convert swaylock into standalone project 2019-01-13 21:16:47 -05:00
meson_options.txt Convert swaylock into standalone project 2019-01-13 21:16:47 -05:00
meson.build Add README.md, compile man pages 2019-01-13 21:24:33 -05:00
pam.c Convert swaylock into standalone project 2019-01-13 21:16:47 -05:00
pango.c Convert swaylock into standalone project 2019-01-13 21:16:47 -05:00
password.c Convert swaylock into standalone project 2019-01-13 21:16:47 -05:00
pool-buffer.c Convert swaylock into standalone project 2019-01-13 21:16:47 -05:00
README.md Correct references to swayidle in readme 2019-01-13 21:30:20 -05:00
render.c Convert swaylock into standalone project 2019-01-13 21:16:47 -05:00
seat.c Convert swaylock into standalone project 2019-01-13 21:16:47 -05:00
shadow.c Replace _XOPEN_SOURCE with _POSIX_C_SOURCE 2018-11-25 17:19:43 +01:00
swaylock.1.scd fix typo 2018-12-02 20:48:29 +01:00
unicode.c Convert swaylock into standalone project 2019-01-13 21:16:47 -05: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

Sway is available in many distributions. Try installing the "swaylock" package for yours. If it's not available, check out this wiki page for information on installation for your distributions.

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

Compiling from Source

Install dependencies:

  • meson *
  • wlroots
  • wayland
  • wayland-protocols *
  • pango
  • 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.