.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "gtklock" "1" "2024-10-22"
.PP
.SH NAME
.PP
gtklock - GTK-based lockscreen for Wayland
.PP
.SH SYNOPSIS
.PP
gtklock [options.\&.\&.\&]
.PP
.SH OPTIONS
.PP
\fB-h, --help\fR
.RS 4
Show help options
.PP
.RE
\fB--help-config\fR
.RS 4
Show options available in the config.\&
See \fBCONFIGURATION\fR.\&
.PP
.RE
\fB-d, --daemonize\fR
.RS 4
Detach from controlling terminal.\&
.PP
.RE
\fB-c, --config\fR <path>
.RS 4
Specify config file to use.\& By default, the following paths are checked
in the following order: $XDG_CONFIG_HOME/gtklock/config.\&ini and
gtklock/config.\&ini under each directory in $XDG_CONFIG_DIRS.\&
.PP
.RE
.SH CONFIGURATION
.PP
Configuration is stored in glib key file format.\& Options are specified as
name=value and can be used from the command-line as --name=value.\& All options
should be under the main group.\&
.PP
All available options are:
.PP
\fB-g, --gtk-theme\fR <string>
.RS 4
Set the GTK theme.\&
.PP
.RE
\fB-s, --style\fR <path>
.RS 4
Load CSS style file.\&
.PP
.RE
\fB-x, --layout\fR <path>
.RS 4
Load XML layout file.\&
.PP
.RE
\fB-m, --modules\fR <name>
.RS 4
Load gtklock modules.\& Module name can be an absolute path, relative path
(starting with .\&/ or .\&.\&/) or name in system directory (such as
example-module.\&so for /usr/lib/gtklock/example-module.\&so).\& The .\&so suffix
can be ommited.\&
.PP
.RE
\fB-b, --background\fR <path>
.RS 4
Load background.\& Specified background can be overwritten by CSS.\&
.PP
.RE
\fB-t, --time-format\fR <string>
.RS 4
Set time format.\& See date(1).\&
.PP
.RE
\fB-d, --date-format\fR <string>
.RS 4
Set date format.\& See date(1).\&
.PP
.RE
\fB-f, --follow-focus\fR
.RS 4
Follow focus between monitors.\& May not work for all compositors,
recommended for hyprland.\&
.PP
.RE
\fB-H, --idle-hide\fR
.RS 4
Hide input form when idle.\&
.PP
.RE
\fB-T, --idle-timeout\fR <int>
.RS 4
Idle timeout in seconds.\&
.PP
.RE
\fB-S, --start-hidden\fR
.RS 4
Start with input form hidden.\&
.PP
.RE
\fB-L, --lock-command\fR
.RS 4
Command to execute after locking.\& Command is executed asynchronously.\&
.PP
.RE
\fB-U, --unlock-command\fR
.RS 4
Command to execute after unlocking.\& Command is executed asynchronously.\&
.PP
.RE
\fB-M, --monitor-priority\fR <name>
.RS 4
Set monitor focus priority.\& Option can be specified multiple times.\&
.PP
.RE
.SH EXAMPLE
.PP
Example config:
.PP
.nf
.RS 4
[main]
gtk-theme=Adwaita-dark
.fi
.RE
.PP
Example style:
.PP
.nf
.RS 4
window {
   background-image: url("background\&.png");
   background-size: cover;
   background-repeat: no-repeat;
   background-position: center;
   background-color: black;
}
.fi
.RE
.PP
.SH AUTHORS
.PP
Maintained by Jovan Lanik <jox969@gmail.\&com>, who is assisted by other
contributors.\& For more information about gtklock development,
see <https://github.\&com/jovanlanik/gtklock>.\&
.PP