diff options
| author | Sughosha <sughosha@disroot.org> | 2026-04-14 23:50:30 +0530 |
|---|---|---|
| committer | Sharlatan Hellseher <sharlatanus@gmail.com> | 2026-06-24 21:30:45 +0100 |
| commit | c64bf4fe738b5e0232cc942c70e27002fb61a480 (patch) | |
| tree | 930e201c0dc892820b584b71ca08576ac9a36e95 /doc | |
| parent | 552ab52b17ec3deda49c9795f6b4743dad3e3864 (diff) | |
services: Add nwg-hello greeter for greetd.
* gnu/services/base.scm (nwg-hello-configuration): New configuration.
(nwg-hello-configuration-file): New variable.
(nwg-hello-style): New configuration.
(nwg-hello-stylesheet): New variable.
(greetd-nwg-hello-sway-session): New configuration.
(make-greetd-nwg-hello-sway-session-sway-config): New variable.
(greetd-nwg-hello-sway-session-compiler): New gexp compiler.
* doc/guix.texi (Base Services): Document the new greeter.
Merges: guix/guix!7644
Reviewed-by: Maxim Cournoyer <maxim@guixotic.coop>
Signed-off-by: Sharlatan Hellseher <sharlatanus@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guix.texi | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index 127c87f7f48..c349ffc6d33 100644 --- a/doc/guix.texi +++ b/doc/guix.texi | |||
| @@ -154,6 +154,7 @@ Copyright @copyright{} 2026 Yarl Baudig@* | |||
| 154 | Copyright @copyright{} 2026 Joan Vilardaga Castro@* | 154 | Copyright @copyright{} 2026 Joan Vilardaga Castro@* |
| 155 | Copyright @copyright{} 2026 Nemin@* | 155 | Copyright @copyright{} 2026 Nemin@* |
| 156 | Copyright @copyright{} 2026 Fredrik Salomonsson@* | 156 | Copyright @copyright{} 2026 Fredrik Salomonsson@* |
| 157 | Copyright @copyright{} 2026 Sughosha@* | ||
| 157 | 158 | ||
| 158 | Permission is granted to copy, distribute and/or modify this document | 159 | Permission is granted to copy, distribute and/or modify this document |
| 159 | under the terms of the GNU Free Documentation License, Version 1.3 or | 160 | under the terms of the GNU Free Documentation License, Version 1.3 or |
| @@ -22126,6 +22127,131 @@ instance of @code{greetd-user-session}. | |||
| 22126 | @end table | 22127 | @end table |
| 22127 | @end deftp | 22128 | @end deftp |
| 22128 | 22129 | ||
| 22130 | @c %start of fragment | ||
| 22131 | |||
| 22132 | @deftp {Data Type} greetd-nwg-hello-sway-session | ||
| 22133 | Configuration record for the nwg-hello greetd greeter. It can be used as | ||
| 22134 | follows: | ||
| 22135 | |||
| 22136 | @lisp | ||
| 22137 | (greetd-configuration | ||
| 22138 | ;; The graphical greeter requires additional groups membership. | ||
| 22139 | (greeter-supplementary-groups (list "input" "video")) | ||
| 22140 | (terminals | ||
| 22141 | (list (greetd-terminal-configuration | ||
| 22142 | ;; Sway requires either seatd or elogind service, but elogind | ||
| 22143 | ;; is preferred for nwg-hello to reboot, shutdown or halt as | ||
| 22144 | ;; user by using the loginctl command. | ||
| 22145 | (extra-shepherd-requirement '(elogind)) | ||
| 22146 | (terminal-vt "1") | ||
| 22147 | (terminal-switch #t) | ||
| 22148 | (default-session-command | ||
| 22149 | (greetd-nwg-hello-sway-session)))))) | ||
| 22150 | @end lisp | ||
| 22151 | |||
| 22152 | Available @code{greetd-nwg-hello-sway-session} fields are: | ||
| 22153 | |||
| 22154 | @table @asis | ||
| 22155 | @item @code{sway} (default: @code{sway}) (type: package) | ||
| 22156 | Package providing the @command{sway} and @command{swaymsg} commands. | ||
| 22157 | |||
| 22158 | @item @code{sway-configuration} (type: maybe-file-like) | ||
| 22159 | Extra configuration for @command{sway} to be included before executing | ||
| 22160 | the greeter. | ||
| 22161 | |||
| 22162 | @item @code{nwg-hello} (default: @code{nwg-hello}) (type: package) | ||
| 22163 | Package providing the @command{nwg-hello} command. | ||
| 22164 | |||
| 22165 | @item @code{nwg-hello-config} (type: nwg-hello-configuration) | ||
| 22166 | Configuration of @command{nwg-hello}. | ||
| 22167 | |||
| 22168 | @item @code{nwg-hello-style} (type: nwg-hello-style) | ||
| 22169 | CSS style rules for @command{nwg-hello}. | ||
| 22170 | |||
| 22171 | @end table | ||
| 22172 | |||
| 22173 | @end deftp | ||
| 22174 | |||
| 22175 | |||
| 22176 | @c %end of fragment | ||
| 22177 | |||
| 22178 | @c %start of fragment | ||
| 22179 | |||
| 22180 | @deftp {Data Type} nwg-hello-configuration | ||
| 22181 | Available @code{nwg-hello-configuration} fields are: | ||
| 22182 | |||
| 22183 | @table @asis | ||
| 22184 | @item @code{session-dirs} (default: @code{("/run/current-system/profile/share/wayland-sessions" "/run/current-system/profile/share/xsessions")}) (type: list-of-strings) | ||
| 22185 | List of directories containing Wayland or X session desktop files. | ||
| 22186 | |||
| 22187 | @item @code{custom-sessions} (type: alist-of-strings-to-greetd-user-sessions) | ||
| 22188 | Session names and the commands. | ||
| 22189 | |||
| 22190 | @item @code{environment-variables} (default: @code{()}) (type: alist-of-strings-to-strings) | ||
| 22191 | Environment variables associated to their values to pass to user | ||
| 22192 | sessions. | ||
| 22193 | |||
| 22194 | @item @code{halt-command} (default: @code{"loginctl suspend"}) (type: string) | ||
| 22195 | Command to run when halting the device. | ||
| 22196 | |||
| 22197 | @item @code{reboot-command} (default: @code{"loginctl reboot"}) (type: string) | ||
| 22198 | Command to run when rebooting the device. | ||
| 22199 | |||
| 22200 | @item @code{shutdown-command} (default: @code{"loginctl poweroff"}) (type: string) | ||
| 22201 | Command to run when shutting down the device. | ||
| 22202 | |||
| 22203 | @item @code{gtk-theme} (default: @code{"Advaita"}) (type: string) | ||
| 22204 | GTK theme to use. | ||
| 22205 | |||
| 22206 | @item @code{icon-theme} (default: @code{"Advaita"}) (type: string) | ||
| 22207 | Icon theme to use. | ||
| 22208 | |||
| 22209 | @item @code{cursor-theme} (default: @code{"Adwaita"}) (type: string) | ||
| 22210 | Cursor theme to use. | ||
| 22211 | |||
| 22212 | @item @code{prefer-dark-theme?} (default: @code{#t}) (type: boolean) | ||
| 22213 | Flag to prefer dark mode for the theme. | ||
| 22214 | |||
| 22215 | @item @code{extra-config} (type: maybe-alist-of-strings-to-strings) | ||
| 22216 | Extra configuration of keys and values. | ||
| 22217 | |||
| 22218 | @end table | ||
| 22219 | |||
| 22220 | @end deftp | ||
| 22221 | |||
| 22222 | |||
| 22223 | @c %end of fragment | ||
| 22224 | |||
| 22225 | @c %start of fragment | ||
| 22226 | |||
| 22227 | @deftp {Data Type} nwg-hello-style | ||
| 22228 | Available @code{nwg-hello-style} fields are: | ||
| 22229 | |||
| 22230 | @table @asis | ||
| 22231 | @item @code{background-image} (type: file-like-or-#f) | ||
| 22232 | Image file to be set as the background. Setting this to @code{#f} | ||
| 22233 | respects the background color. | ||
| 22234 | |||
| 22235 | @item @code{background-size} (default: @code{"auto 100%"}) (type: string) | ||
| 22236 | Size of the background image. It can be @code{"auto"} (for preserving | ||
| 22237 | the original size), @code{"cover"} (for resizing to fill while allowing | ||
| 22238 | to cut or to stretch), @code{"contain"} (for resizing to fit assuring | ||
| 22239 | the full visibility of the image), or a string of a number suffixed with | ||
| 22240 | with @code{px} (to represent in pixels) or @code{%} (to represent in | ||
| 22241 | percentage). It can also be a string of two such values separated by a | ||
| 22242 | whitespace, representing width and height respectively. | ||
| 22243 | |||
| 22244 | @item @code{extra-style} (type: maybe-alist-of-strings-to-alists-of-strings-to-strings) | ||
| 22245 | List of CSS selectors associated to their lists of CSS properties | ||
| 22246 | associated to their values. | ||
| 22247 | |||
| 22248 | @end table | ||
| 22249 | |||
| 22250 | @end deftp | ||
| 22251 | |||
| 22252 | |||
| 22253 | @c %end of fragment | ||
| 22254 | |||
| 22129 | @node Scheduled Job Execution | 22255 | @node Scheduled Job Execution |
| 22130 | @subsection Scheduled Job Execution | 22256 | @subsection Scheduled Job Execution |
| 22131 | 22257 | ||
