README.md
1# swaylock
2
3swaylock is a screen locking utility for Wayland compositors. It is compatible
4with any Wayland compositor which implements the following Wayland protocols:
5
6- wlr-layer-shell
7- wlr-input-inhibitor
8- xdg-output
9- xdg-shell
10
11See the man page, `swaylock(1)`, for instructions on using swaylock.
12
13## Release Signatures
14
15Releases are signed with [B22DA89A](http://pgp.mit.edu/pks/lookup?op=vindex&search=0x52CB6609B22DA89A)
16and published [on GitHub](https://github.com/swaywm/swaylock/releases). swaylock
17releases are managed independently of sway releases.
18
19## Installation
20
21### From Packages
22
23Swaylock is available in many distributions. Try installing the "swaylock"
24package for yours.
25
26If you're interested in packaging swaylock for your distribution, stop by the
27IRC channel or shoot an email to sir@cmpwn.com for advice.
28
29### Compiling from Source
30
31Install dependencies:
32
33* meson \*
34* wayland
35* wayland-protocols \*
36* libxkbcommon
37* cairo
38* gdk-pixbuf2 \*\*
39* pam (optional)
40* [scdoc](https://git.sr.ht/~sircmpwn/scdoc) (optional: man pages) \*
41* git \*
42
43_\*Compile-time dep_
44
45_\*\*optional: required for background images other than PNG_
46
47Run these commands:
48
49 meson build
50 ninja -C build
51 sudo ninja -C build install
52
53On systems without PAM, you need to suid the swaylock binary:
54
55 sudo chmod a+s /usr/local/bin/swaylock
56
57Swaylock will drop root permissions shortly after startup.
58