Home

Summary

• Usage
• Styling
• Fingerprint support
• Modules

Usage

• Lock screen: $ gtklock
• Lock screen and daemonize: $ gtklock -d
• Load example style: $ gtklock -s ./assets/example-style.css
• Load a module: $ gtklock -m /path/to/module.so
• Show help options: $ gtklock -h

Styling

The best way to style gtklock is by running $ GTK_DEBUG=interactive gtklock -li and using the widget names as selectors. Some of the widgets are #window-box, #clock-label, #body, #error-label and #input-label.

Setting the background

window {
   background-image: url("background.png");
   background-size: cover;
   background-repeat: no-repeat;
   background-position: center;
   background-color: black;
}

The background url can be absolute or relative to the style file. If the image fails to load, the color is used.

Per monitor backgrounds

Each window is named after the output, for example window#eDP-1 or window#HDMI-A-1.

References

• https://docs.gtk.org/gtk3/css-overview.html
• https://github.com/jovanlanik/gtklock/issues/2
• https://github.com/jovanlanik/gtklock/issues/14
• https://github.com/jovanlanik/gtklock/issues/16

Fingerprint support

Add the lines to the top of /etc/pam.d/gtklock:

auth            sufficient      pam_unix.so try_first_pass likeauth nullok
auth            sufficient      pam_fprintd.so

References

• https://wiki.archlinux.org/title/Fprint
• https://github.com/swaywm/swaylock/issues/61#issuecomment-965175390
• https://github.com/jovanlanik/gtklock/issues/11

Modules

Module support is work-in-progress.

References

• https://github.com/jovanlanik/gtklock-example-module