summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorOleg Pykhalov <go.wigust@gmail.com>2025-10-08 16:17:41 +0300
committerOleg Pykhalov <go.wigust@gmail.com>2025-10-10 12:11:12 +0300
commit18ea7bc470e38b655d263847611ac5f0980f0cf8 (patch)
treee9906e9789faef26eea772d5b6773b129c17ffa8 /doc
parent2e1be00d0b4a73f60d1cfc06107327dd528cd6f5 (diff)
home: services: Add niri.
This introduces a new home service for Niri, a scrollable tiling Wayland compositor that combines traditional tiling window management with smooth scrolling between workspaces. The service provides: - home-niri-service-type for installing and configuring Niri - Shepherd service that starts Niri in a DBus session - Proper Wayland environment variables (XDG_CURRENT_DESKTOP, XDG_SESSION_DESKTOP, etc.) - Integration with xdg-desktop-portal and related components The service starts Niri with appropriate environment variables for Wayland compatibility and includes necessary dependencies like xdg-desktop-portal-gnome and xdg-desktop-portal-gtk for proper desktop integration. * gnu/home/services/niri.scm: New file containing the service implementation. * gnu/local.mk (GNU_SYSTEM_MODULES): Register the new module. * doc/guix.texi (Niri window manager): Add comprehensive documentation. Change-Id: I9ef081226b4aaa31706d1fbc0d8b7aa1a202cd6e
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 9109ce4a388..23062498106 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -49888,6 +49888,7 @@ services)}.
* Mail: Mail Home Services. Services for managing mail.
* Messaging: Messaging Home Services. Services for managing messaging.
* Media: Media Home Services. Services for managing media.
+* Niri: Niri window manager. Setting up the Niri.
* Sway: Sway window manager. Setting up the Sway configuration.
* Networking: Networking Home Services. Networking services.
* Miscellaneous: Miscellaneous Home Services. More services.
@@ -52420,6 +52421,35 @@ object @code{%unset-value} (from @code{(gnu services configuration)}).
@end deffn
+@node Niri window manager
+@subsection Niri window manager
+
+@cindex niri, Home Service
+@cindex niri, configuration
+@cindex Wayland compositor
+@cindex scrollable tiling window manager
+The @code{(gnu home services niri)} module provides the
+@code{home-niri-service-type} service, which installs and configures
+@uref{https://github.com/YaLTeR/niri, Niri}, a scrollable tiling Wayland
+compositor. Niri combines traditional tiling window management with
+smooth scrolling between workspaces.
+
+This service starts Niri as a user-level desktop session with proper
+environment variables configured for Wayland compatibility, including
+@code{XDG_CURRENT_DESKTOP}, @code{XDG_SESSION_DESKTOP}, and
+@code{DESKTOP_SESSION}.
+
+Here is a minimal example service declaration for your
+@code{home-environment} configuration:
+
+@example
+(service home-niri-service-type)
+@end example
+
+For more advanced configurations, you can customize the service with a
+@code{niri-configuration} record to specify additional environment
+variables.
+
@node Sway window manager
@subsection Sway window manager