gtkgreet(1)

✨ gtkgreet(1) ✨

Hey bestie! Welcome to the gtkgreet(1) manual page. It's giving graphical login screen realness, and I'm gonna walk you through it like we're texting. No cap, every detail is here. 💅

---

🎀 NAME 🎀

gtkgreet — A Gtk-based greeter for greetd. That's the whole vibe.

---

🌸 SYNOPSIS 🌸

gtkgreet [options]

---

💖 OPTIONS 💖

• -h, --help — Show help message and quit. Slay, a quick exit.
• -c, --command <command> — Specifies the command to run on successful login. gtkgreet will ask if none is specified. So if you don't set this, it's gonna ask you, no cap.
• -l, --layer-shell — Use wlr-layer-shell to display a window on every output. Must be enabled at compile-time. Lowkey, your build has to have it, bestie.
• -b, --background — 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.

Note: This does not handle scaling values other than 1 correctly. Use a stylesheet for more flexible and correct background rendition.

Ngl, if your DPI scaling is not 1, it's gonna look a mess. Use CSS instead, periodt.

• -s, --style <file.css> — 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.

Note: 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.

So this is just for your app-level tweaks, not for swapping themes. If you want a theme, use the normal Gtk theme stuff, iykyk.

---

🦋 DESCRIPTION 🦋

gtkgreet is a Gtk-based, graphical greeter for greetd(1). It's giving graphical login screen energy.

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. So you can pick from a list or just type your own command, main character energy.

gtkgreet requires a Wayland compositor to run, such as cage(1) or sway(1). No Wayland, no vibe check.

---

🌈 SETUP 🌈

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. So the compositor runs gtkgreet, and when gtkgreet is done, the compositor bails.

Using cage, the command-line simply becomes "cage gtkgreet".

Using sway(1), one can use a sway config containing "exec 'gtkgreet; 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. So don't skip that part, bestie, or sway will just hang out.

See greetd(5) for information on how to configure greetd. Read the documentation of your chosen compositor for information on how to use it correctly.

---

🧚 STYLING 🧚

The stylesheet can be used to modify styling of gtkgreet elements, such as the window background, fonts, login prompt container and others.

An example stylesheet can be seen here:

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;
}

---

💜 ENVIRONMENTS 💜

gtkgreet populates the user options for applications to start at login using both a configuration file and the '-c' command-line argument.

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. So it reads that file, splits by newlines, and each line is a command you can pick. The '-c' argument also adds a command, iykyk.

---

👑 AUTHORS 👑

Maintained by Kenny Levinsen <contact@kl.wtf>. For more information about gtkgreet development, see https://git.sr.ht/~kennylevinsen/gtkgreet. So big ups to Kenny, the maintainer, periodt.

---

⭐ SEE ALSO ⭐

greetd(1) — that's the one other manual page to check out.

---

That's the whole manual, bestie! This page is from 2024-01-17, and it's for gtkgreet(1). Hope that helped, and remember: stay slay, stay secure, and keep your compositors shutting down properly. 💅✨