.\" 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 "gtkgreet" "1" "2024-05-04" .PP .SH NAME .PP gtkgreet - A Gtk-based greeter for greetd .PP .SH SYNOPSIS .PP \fBgtkgreet\fR [options] .PP .SH OPTIONS .PP \fB-h, --help\fR .RS 4 Show help message and quit.\& .PP .RE \fB-c, --command <command>\fR .RS 4 Specifies the command to run on successful login.\& gtkgreet will ask if none is specified.\& .PP .RE \fB-l, --layer-shell\fR .RS 4 Use wlr-layer-shell to display a window on every output.\& Must be enabled at compile-time.\& .PP .RE \fB-b, --background\fR .RS 4 Specifies a background image to be used by gtkgreet.\& JPG and PNG are known to work.\& The image will be anchored to the upper left corner, and is rendered 1:1 when DPI scaling is 1.\& .PP \fBNote:\fR This does not handle scaling values other than 1 correctly.\& Use a stylesheet for more flexible and correct background rendition.\& .PP .RE \fB-s, --style <file.\&css>\fR .RS 4 Specifies a custom CSS stylesheet with additional styles for the gtkgreet window.\& See https://developer.\&gnome.\&org/gtk3/stable/theming.\&html for the description of CSS subset supported in GTK.\& .PP \fBNote:\fR This is not able to load Gtk theme stylesheets, and is only for application-level modifications.\& To select a theme, use the regular Gtk theme selection mechanisms.\& .PP .RE .SH DESCRIPTION .PP gtkgreet is a Gtk-based, graphical greeter for \fBgreetd\fR(1).\& .PP gtkgreet allows selection of which application to start at login.\& See the ENVIRONMENTS section for more information on how to configure the provided options.\& The user can also specify the application directly at login by writing the command line they wish.\& .PP gtkgreet requires a Wayland compositor to run, such as \fBcage\fR(1) or \fBsway\fR(1).\& .PP .SH SETUP .PP To use gtkgreet, configure a Wayland compositor of your choice to be your greeter.\& Make the compositor start gtkgreet, and importantly, shut itself down once gtkgreet terminates.\& .PP Using \fBcage\fR, the command-line simply becomes "cage gtkgreet".\& .PP Using \fBsway\fR(1), one can use a sway config containing "exec '\>kgreet; swaymsg exit'\&", and a command-line similar to "sway --config /etc/greetd/sway-config".\& The "; swaymg exit" component is important, as that makes sway terminate once gtkgreet has finalized a login.\& .PP See \fBgreetd\fR(5) for information on how to configure greetd.\& Read the documentation of your chosen compositor for information on how to use it correctly.\& .PP .SH STYLING .PP The stylesheet can be used to modify styling of gtkgreet elements, such as the window background, fonts, login prompt container and others.\& .PP An example stylesheet can be seen here: .PP .nf .RS 4 window { background-image: url("file:///etc/greetd/gtkgreet-background\&.jpg"); background-size: cover; background-position: center; } box#body { background-color: rgba(50, 50, 50, 0\&.5); border-radius: 10px; padding: 50px; } .fi .RE .PP .SH ENVIRONMENTS .PP gtkgreet populates the user options for applications to start at login using both a configuration file and the '\&-c'\& command-line argument.\& .PP The configuration file is read from /etc/greetd/environments, and is a newline-seperated list of of options, each being a command line to run on login if selected.\& .PP .SH AUTHORS .PP Maintained by Kenny Levinsen <contact@kl.\&wtf>.\& For more information about gtkgreet development, see https://git.\&sr.\&ht/~kennylevinsen/gtkgreet.\& .PP .SH SEE ALSO \fBgreetd\fR(1)