2019-01-13 20:24:33 -06:00
|
|
|
# swaylock
|
|
|
|
|
|
|
|
|
|
swaylock is a screen locking utility for Wayland compositors. It is compatible
|
|
|
|
|
with any Wayland compositor which implements the following Wayland protocols:
|
|
|
|
|
|
2022-02-02 08:52:17 -06:00
|
|
|
- wlr-layer-shell + wlr-input-inhibitor, or ext-session-lock-v1
|
2019-01-13 20:24:33 -06:00
|
|
|
- xdg-output
|
|
|
|
|
- xdg-shell
|
|
|
|
|
|
2019-01-13 20:30:20 -06:00
|
|
|
See the man page, `swaylock(1)`, for instructions on using swaylock.
|
2019-01-13 20:24:33 -06:00
|
|
|
|
|
|
|
|
## Release Signatures
|
|
|
|
|
|
2022-02-02 08:48:45 -06:00
|
|
|
Releases are signed with [E88F5E48](https://keys.openpgp.org/search?q=34FF9526CFEF0E97A340E2E40FDE7BE0E88F5E48)
|
2019-01-17 10:17:36 -06:00
|
|
|
and published [on GitHub](https://github.com/swaywm/swaylock/releases). swaylock
|
2019-01-13 20:24:33 -06:00
|
|
|
releases are managed independently of sway releases.
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
### From Packages
|
|
|
|
|
|
2019-01-17 10:17:36 -06:00
|
|
|
Swaylock is available in many distributions. Try installing the "swaylock"
|
|
|
|
|
package for yours.
|
2019-01-13 20:24:33 -06:00
|
|
|
|
2019-01-17 10:17:36 -06:00
|
|
|
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.
|
2019-01-13 20:24:33 -06:00
|
|
|
|
|
|
|
|
### Compiling from Source
|
|
|
|
|
|
|
|
|
|
Install dependencies:
|
|
|
|
|
|
|
|
|
|
* meson \*
|
|
|
|
|
* wayland
|
|
|
|
|
* wayland-protocols \*
|
2019-01-16 09:20:45 -06:00
|
|
|
* libxkbcommon
|
2019-01-13 20:24:33 -06:00
|
|
|
* cairo
|
|
|
|
|
* gdk-pixbuf2 \*\*
|
|
|
|
|
* pam (optional)
|
|
|
|
|
* [scdoc](https://git.sr.ht/~sircmpwn/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.
|
