From 362f734db79debac680112dcd2fc4506cd9ca51c Mon Sep 17 00:00:00 2001
From: Godefroid Chapelle <gotcha@bubblenet.be>
Date: Wed, 15 Nov 2023 13:57:50 +0100
Subject: [PATCH] zellij: document KDL settings

Describe how to set KDL arguments.
---
 modules/programs/zellij.nix | 26 ++++++++++++++++++++++++--
 1 file changed, 24 insertions(+), 2 deletions(-)

diff --git a/modules/programs/zellij.nix b/modules/programs/zellij.nix
index 44a3d69f4..5f047f3d0 100644
--- a/modules/programs/zellij.nix
+++ b/modules/programs/zellij.nix
@@ -33,10 +33,32 @@ in {
       '';
       description = ''
         Configuration written to
-        {file}`$XDG_CONFIG_HOME/zellij/config.yaml`.
+        {file}`$XDG_CONFIG_HOME/zellij/config.kdl`.
 
-        See <https://zellij.dev/documentation> for the full
+        See <https://zellij.dev/documentation/options> for the full
         list of options.
+
+        KDL is generated from YAML with the ``toKDL`` generator.
+        To create KDL with arguments like needed among others by ``keybinds``:
+        ```kdl
+        keybinds {
+          shared_except "move" "locked" {
+            bind "Ctrl m" { SwitchToMode "move"; }
+          }
+        }
+        ```
+        use the following:
+        ```yaml
+        keybinds = {
+          shared_except = {
+            _args = [ "move" "locked" ];
+            bind = {
+              _args = [ "Ctrl m" ];
+              SwitchToMode = "move";
+            };
+          };
+        };
+        ``` 
       '';
     };