From 26c48240471898c87f9b67fef66297e2e5a4c060 Mon Sep 17 00:00:00 2001 From: Ivan Molodetskikh Date: Tue, 26 Mar 2024 08:12:55 +0400 Subject: wiki: Input and more Overview --- wiki/Configuration:-Overview.md | 76 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) (limited to 'wiki/Configuration:-Overview.md') diff --git a/wiki/Configuration:-Overview.md b/wiki/Configuration:-Overview.md index ea8f6561..15acb2ef 100644 --- a/wiki/Configuration:-Overview.md +++ b/wiki/Configuration:-Overview.md @@ -15,6 +15,9 @@ To use a different config file path, pass it in the `--config` or `-c` argument ### Syntax The config is written in [KDL]. + +#### Comments + Lines starting with `//` are comments; they are ignored. Also, you can put `/-` in front of a node to comment out the entire node: @@ -26,6 +29,79 @@ Also, you can put `/-` in front of a node to comment out the entire node: } ``` +#### Flags + +Toggle options in niri are commonly represented as flags. +Writing out the flag enables it, and omitting it or commenting it out disables it. +For example: + +``` +// "Focus follows mouse" is enabled. +input { + focus-follows-mouse + + // Other settings... +} +``` + +``` +// "Focus follows mouse" is disabled. +input { + // Other settings... +} +``` + +#### Sections + +Most sections cannot be repeated. For example: + +``` +// This is valid: every section appears once. +input { + keyboard { + // ... + } + + touchpad { + // ... + } +} +``` + +``` +// This is NOT valid: input section appears twice. +input { + keyboard { + // ... + } +} + +input { + touchpad { + // ... + } +} +``` + +Exceptions are for example sections that configure different devices by name: + +``` +output "eDP-1" { + // ... +} + +// This is valid: this section configures a different output. +output "HDMI-A-1" { + // ... +} + +// This is NOT valid: "eDP-1" already appeared above. +// It will either throw a config parsing error, or otherwise not work. +output "eDP-1" { + // ... +} +``` + ### Defaults Omitting most of the sections of the config file will leave you with the default values for that section. -- cgit