1gtkgreet(1) General Commands Manual gtkgreet(1)
2
3
4
6 gtkgreet - A Gtk-based greeter for greetd
7
9 gtkgreet [options]
10
12 -h, --help
13 Show help message and quit.
14
15 -c, --command <command>
16 Specifies the command to run on successful login. gtkgreet will ask
17 if none is specified.
18
19 -l, --layer-shell
20 Use wlr-layer-shell to display a window on every output. Must be
21 enabled at compile-time.
22
23 -b, --background
24 Specifies a background image to be used by gtkgreet. JPG and PNG
25 are known to work. The image will be anchored to the upper left
26 corner, and is rendered 1:1 when DPI scaling is 1.
27
28 Note: This does not handle scaling values other than 1 correctly.
29 Use a stylesheet for more flexible and correct background rendi‐
30 tion.
31
32 -s, --style <file.css>
33 Specifies a custom CSS stylesheet with additional styles for the
34 gtkgreet window. See https://developer.gnome.org/gtk3/stable/them‐
35 ing.html for the description of CSS subset supported in GTK.
36
37 Note: This is not able to load Gtk theme stylesheets, and is only
38 for application-level modifications. To select a theme, use the
39 regular Gtk theme selection mechanisms.
40
42 gtkgreet is a Gtk-based, graphical greeter for greetd(1).
43
44 gtkgreet allows selection of which application to start at login. See
45 the ENVIRONMENTS section for more information on how to configure the
46 provided options. The user can also specify the application directly at
47 login by writing the command line they wish.
48
49 gtkgreet requires a Wayland compositor to run, such as cage(1) or
50 sway(1).
51
53 To use gtkgreet, configure a Wayland compositor of your choice to be
54 your greeter. Make the compositor start gtkgreet, and importantly, shut
55 itself down once gtkgreet terminates.
56
57 Using cage, the command-line simply becomes "cage gtkgreet".
58
59 Using sway(1), one can use a sway config containing "exec 'gtkgreet;
60 swaymsg exit'", and a command-line similar to "sway --config
61 /etc/greetd/sway-config". The "; swaymg exit" component is important,
62 as that makes sway terminate once gtkgreet has finalized a login.
63
64 See greetd(5) for information on how to configure greetd. Read the doc‐
65 umentation of your chosen compositor for information on how to use it
66 correctly.
67
69 The stylesheet can be used to modify styling of gtkgreet elements, such
70 as the window background, fonts, login prompt container and others.
71
72 An example stylesheet can be seen here:
73
74 window {
75 background-image: url("file:///etc/greetd/gtkgreet-background.jpg");
76 background-size: cover;
77 background-position: center;
78 }
79
80 box#body {
81 background-color: rgba(50, 50, 50, 0.5);
82 border-radius: 10px;
83 padding: 50px;
84 }
85
87 gtkgreet populates the user options for applications to start at login
88 using both a configuration file and the '-c' command-line argument.
89
90 The configuration file is read from /etc/greetd/environments, and is a
91 newline-seperated list of of options, each being a command line to run
92 on login if selected.
93
95 Maintained by Kenny Levinsen <contact@kl.wtf>. For more information
96 about gtkgreet development, see https://git.sr.ht/~kennylevinsen/gtk‐
97 greet.
98
100 greetd(1)
101
102
103
104 2023-11-12 gtkgreet(1)