From 86b5794fa392520908a03616f1805b0f2335bff3 Mon Sep 17 00:00:00 2001 From: HuntedByTheIRS Date: Fri, 3 Jul 2026 04:21:18 -0400 Subject: [PATCH] docs: update example/config.lua with rule field descriptions --- example/config.lua | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/example/config.lua b/example/config.lua index cceeadf..a3fcf55 100644 --- a/example/config.lua +++ b/example/config.lua @@ -33,9 +33,22 @@ input = { accel_speed = 0.0, } +-- Rules let you match windows by app_id, title, or class and apply window-manager +-- settings. Set `apply_effects = false` to disable compositor effects (shadows, +-- transparency, rounded corners) on a matched window. rules = { - -- { app_id = "Gimp", floating = true, monitor = -1 }, - -- { app_id = "firefox", tags = 1 << 8, floating = false, monitor = -1 }, + -- { app_id = "Gimp", floating = true, monitor = -1 }, + -- { app_id = "firefox", tags = 1 << 8, floating = false, monitor = -1 }, + -- + -- -- `tags = "any"` places the window on whichever tag happens to be focused + -- -- `monitor = "default"` sends the window to the current / primary monitor + -- { app_id = "Alacritty", tags = "any", monitor = "default" }, + -- + -- -- `can_float = false` locks the window into tiling (prevents togglefloating) + -- { app_id = "pavucontrol", floating = true, can_float = false }, + -- + -- -- `title` matching works alongside or instead of app_id: + -- -- { title = "Save As", floating = true, apply_effects = false }, } monitors = {