diff --git a/options.xhtml b/options.xhtml index 87bcc1ac7..62cec90bf 100644 --- a/options.xhtml +++ b/options.xhtml @@ -70239,6 +70239,301 @@ boolean

+
+ + wayland.windowManager.river.enable + + +
+
+

Whether to enable the river window manager.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/window-managers/river.nix> + +
+
+
+ + wayland.windowManager.river.package + + +
+
+

The river package to use. Set to null to not add any river package to your path. +This should be done if you want to use the NixOS river module to install river.

+ +

Type: +null or package

+ +

Default: +pkgs.river

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/window-managers/river.nix> + +
+
+
+ + wayland.windowManager.river.extraConfig + + +
+
+

Extra lines appended to $XDG_CONFIG_HOME/river/init.

+ +

Type: +strings concatenated with ā€œ\nā€

+ +

Default: +""

+ +

Example:

''
+  rivertile -view-padding 6 -outer-padding 6 &
+''
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/window-managers/river.nix> + +
+
+
+ + wayland.windowManager.river.extraSessionVariables + + +
+
+

Extra session variables set when running the compositor.

+ +

Type: +attribute set

+ +

Default: +{ }

+ +

Example:

{
+  MOZ_ENABLE_WAYLAND = "1";
+}
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/window-managers/river.nix> + +
+
+
+ + wayland.windowManager.river.settings + + +
+
+

General settings given to riverctl.

+ +

Type: +River configuration value

+ +

Default: +{ }

+ +

Example:

{
+  border-width = 2;
+  declare-mode = [
+    "locked"
+    "normal"
+    "passthrough"
+  ];
+  input = {
+    pointer-foo-bar = {
+      accel-profile = "flat";
+      events = true;
+      pointer-accel = -0.3;
+      tap = false;
+    };
+  };
+  map = {
+    normal = {
+      "Alt Q" = "close";
+    };
+  };
+  rule-add = {
+    "-app-id" = {
+      "'bar'" = "csd";
+      "'float*'" = {
+        "-title" = {
+          "'foo'" = "float";
+        };
+      };
+    };
+  };
+  set-cursor-warp = "on-output-change";
+  set-repeat = "50 300";
+  spawn = [
+    "firefox"
+    "'foot -a terminal'"
+  ];
+  xcursor-theme = "someGreatTheme 12";
+}
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/window-managers/river.nix> + +
+
+
+ + wayland.windowManager.river.systemd.enable + + +
+
+

Whether to enable river-session.target on +river startup. This links to graphical-session.target}. +Some important environment variables will be imported to systemd +and D-Bus user environment before reaching the target, including

+ +

Type: +boolean

+ +

Default: +true

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/window-managers/river.nix> + +
+
+
+ + wayland.windowManager.river.systemd.extraCommands + + +
+
+

Extra commands to be run after D-Bus activation.

+ +

Type: +list of string

+ +

Default:

[
+  "systemctl --user stop river-session.target"
+  "systemctl --user start river-session.target"
+]
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/window-managers/river.nix> + +
+
+
+ + wayland.windowManager.river.systemd.variables + + +
+
+

Environment variables to be imported in the systemd & D-Bus user +environment.

+ +

Type: +list of string

+ +

Default:

[
+  "DISPLAY"
+  "WAYLAND_DISPLAY"
+  "XDG_CURRENT_DESKTOP"
+  "NIXOS_OZONE_WL"
+  "XCURSOR_THEME"
+  "XCURSOR_SIZE"
+]
+
+ +

Example:

[
+  "-all"
+]
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/window-managers/river.nix> + +
+
+
+ + wayland.windowManager.river.xwayland.enable + + +
+
+

Whether to enable XWayland.

+ +

Type: +boolean

+ +

Default: +true

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/window-managers/river.nix> + +
+
wayland.windowManager.sway.enable