Skip to content
Jovan Lanik edited this page Jun 15, 2022 · 23 revisions

Summary

Usage

  • Lock screen: $ gtklock
  • Lock screen and daemonize: $ gtklock -d
  • Specify config file: $ gtklock -c /path/to/config.ini
  • Specify style file: $ gtklock -s ./assets/example-style.css
  • Load a module: $ gtklock -m /path/to/module.so
  • Show help options: $ gtklock --help-all

Config

By default gtklock will load ~/.config/gtklock/config.ini.

Available options are:

  • gtk-theme - Specify GTK theme
  • style - Specify style file
  • module - Load a module

All options should be in the main group.

Example config

[main]
gtk-theme=Adwaita-dark

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.

Example style

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 background

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

A full example can be found here.

References

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

Modules

Module support is work-in-progress.

References

Clone this wiki locally