From f59c59df7792b0fd45af037d5041fb4ad9f6629e Mon Sep 17 00:00:00 2001 From: rycee Date: Fri, 10 May 2024 11:43:40 +0000 Subject: [PATCH] deploy: 4855bfb6ce20225a1b0e2aae2379da909ab38350 --- options.xhtml | 434 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 433 insertions(+), 1 deletion(-) diff --git a/options.xhtml b/options.xhtml index 25d9bfdad..cd024dae5 100644 --- a/options.xhtml +++ b/options.xhtml @@ -61381,7 +61381,7 @@ strings concatenated with “\n”

-

List of profiles.

+

Attribute set of profiles.

Type: attribute set of (submodule)

@@ -61439,6 +61439,30 @@ executed asynchronously with no guaranteed ordering.

Example: "[ \${pkg.sway}/bin/swaymsg workspace 1, move workspace to eDP-1 ]"

+

Declared by:

+ + +
+ +<home-manager/modules/services/kanshi.nix> + +
+
+
+ + services.kanshi.profiles.<name>.name + + +
+
+

Profile name

+ +

Type: +string

+ +

Default: +""

+

Declared by:

@@ -61657,6 +61681,414 @@ null or one of “normal”, “90”, “180”, “270”, “flipped”, “f
+
+ + services.kanshi.settings + + +
+
+

Ordered list of directives. +See kanshi(5) for informations.

+ +

Type: +list of attribute-tagged union

+ +

Default: +[ ]

+ +

Example:

{ include = "path/to/included/files"; }
+{ output.criteria = "eDP-1";
+  output.scale = 2;
+}
+{ profile.name = "undocked";
+  profile.outputs = [
+    {
+      criteria = "eDP-1";
+    }
+  ];
+}
+{ profile.name = "docked";
+  profile.outputs = [
+    {
+      criteria = "eDP-1";
+    }
+    {
+      criteria = "Some Company ASDF 4242";
+      transform = "90";
+    }
+  ];
+}
+
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/kanshi.nix> + +
+
+
+ + services.kanshi.settings.*.include + + +
+
+

Include as another file from path. +Expands shell syntax (see wordexp(3) for details).

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/kanshi.nix> + +
+
+
+ + services.kanshi.settings.*.output + + +
+
+

output attribute set.

+ +

Type: +submodule

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/kanshi.nix> + +
+
+
+ + services.kanshi.settings.*.output.adaptiveSync + + +
+
+

Enables or disables adaptive synchronization +(aka. Variable Refresh Rate).

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Example: +true

+
+
+ + services.kanshi.settings.*.output.criteria + + +
+
+

The criteria can either be an output name, an output description or “*”. +The latter can be used to match any output.

On +sway(1), +output names and descriptions can be obtained via +swaymsg -t get_outputs.

+ +

Type: +string

+
+
+ + services.kanshi.settings.*.output.mode + + +
+
+

<width>x<height>[@<rate>[Hz]]

Configures the specified output to use the specified mode. +Modes are a combination of width and height (in pixels) and +a refresh rate (in Hz) that your display can be configured to use.

+ +

Type: +null or string

+ +

Default: +null

+ +

Example: +"1920x1080@60Hz"

+
+
+ + services.kanshi.settings.*.output.position + + +
+
+

<x>,<y>

Places the output at the specified position in the global coordinates +space.

+ +

Type: +null or string

+ +

Default: +null

+ +

Example: +"1600,0"

+
+
+ + services.kanshi.settings.*.output.scale + + +
+
+

Scales the output by the specified scale factor.

+ +

Type: +null or floating point number

+ +

Default: +null

+ +

Example: +2

+
+
+ + services.kanshi.settings.*.output.status + + +
+
+

Enables or disables the specified output.

+ +

Type: +null or one of “enable”, “disable”

+ +

Default: +null

+
+
+ + services.kanshi.settings.*.output.transform + + +
+
+

Sets the output transform.

+ +

Type: +null or one of “normal”, “90”, “180”, “270”, “flipped”, “flipped-90”, “flipped-180”, “flipped-270”

+ +

Default: +null

+
+
+ + services.kanshi.settings.*.profile + + +
+
+

profile attribute set.

+ +

Type: +submodule

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/kanshi.nix> + +
+
+
+ + services.kanshi.settings.*.profile.exec + + +
+
+

Commands executed after the profile is successfully applied. +Note that if you provide multiple commands, they will be +executed asynchronously with no guaranteed ordering.

+ +

Type: +(list of string) or string convertible to it

+ +

Default: +[ ]

+ +

Example: +"[ \${pkg.sway}/bin/swaymsg workspace 1, move workspace to eDP-1 ]"

+
+
+ + services.kanshi.settings.*.profile.name + + +
+
+

Profile name

+ +

Type: +string

+ +

Default: +""

+
+
+ + services.kanshi.settings.*.profile.outputs + + +
+
+

Outputs configuration.

+ +

Type: +list of (submodule)

+ +

Default: +[ ]

+
+
+ + services.kanshi.settings.*.profile.outputs.*.adaptiveSync + + +
+
+

Enables or disables adaptive synchronization +(aka. Variable Refresh Rate).

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Example: +true

+
+
+ + services.kanshi.settings.*.profile.outputs.*.criteria + + +
+
+

The criteria can either be an output name, an output description or “*”. +The latter can be used to match any output.

On +sway(1), +output names and descriptions can be obtained via +swaymsg -t get_outputs.

+ +

Type: +string

+
+
+ + services.kanshi.settings.*.profile.outputs.*.mode + + +
+
+

<width>x<height>[@<rate>[Hz]]

Configures the specified output to use the specified mode. +Modes are a combination of width and height (in pixels) and +a refresh rate (in Hz) that your display can be configured to use.

+ +

Type: +null or string

+ +

Default: +null

+ +

Example: +"1920x1080@60Hz"

+
+
+ + services.kanshi.settings.*.profile.outputs.*.position + + +
+
+

<x>,<y>

Places the output at the specified position in the global coordinates +space.

+ +

Type: +null or string

+ +

Default: +null

+ +

Example: +"1600,0"

+
+
+ + services.kanshi.settings.*.profile.outputs.*.scale + + +
+
+

Scales the output by the specified scale factor.

+ +

Type: +null or floating point number

+ +

Default: +null

+ +

Example: +2

+
+
+ + services.kanshi.settings.*.profile.outputs.*.status + + +
+
+

Enables or disables the specified output.

+ +

Type: +null or one of “enable”, “disable”

+ +

Default: +null

+
+
+ + services.kanshi.settings.*.profile.outputs.*.transform + + +
+
+

Sets the output transform.

+ +

Type: +null or one of “normal”, “90”, “180”, “270”, “flipped”, “flipped-90”, “flipped-180”, “flipped-270”

+ +

Default: +null

+
services.kanshi.systemdTarget