https://github.com/swaywm/swaylock

Screen locker for Wayland
https://github.com/swaywm/swaylock

sway wayland wlroots

Last synced: 2 days ago
JSON representation

Screen locker for Wayland

• Host: GitHub
• URL: https://github.com/swaywm/swaylock
• Owner: swaywm
• License: mit
• Created: 2019-01-14T02:25:09.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-12T15:23:50.000Z (27 days ago)
• Last Synced: 2024-10-31T04:34:50.338Z (8 days ago)
• Topics: sway, wayland, wlroots
• Language: C
• Size: 310 KB
• Stars: 843
• Watchers: 25
• Forks: 200
• Open Issues: 83
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hyprland - swaylock
• awesome-starred - swaylock - Screen locker for Wayland (C)
• awesome-linux-ricing - swaylock - Screen locker for Wayland. (Screen Lock / Utilities)

README

        
# swaylock

swaylock is a screen locking utility for Wayland compositors. It is compatible

with any Wayland compositor which implements the ext-session-lock-v1 Wayland

protocol.

See the man page, [swaylock(1)](swaylock.1.scd), for instructions on using swaylock.

## Release Signatures

Releases are signed with [E88F5E48](https://keys.openpgp.org/search?q=34FF9526CFEF0E97A340E2E40FDE7BE0E88F5E48)

and published [on GitHub](https://github.com/swaywm/swaylock/releases). swaylock

releases are managed independently of sway releases.

## Installation

### From Packages

Swaylock is available in many distributions. Try installing the "swaylock"

package for yours.

### Compiling from Source

Install dependencies:

* meson \*

* wayland

* wayland-protocols \*

* libxkbcommon

* 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.