docs: explain the detect-client-leader option better

Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
yshui · Sep 22, 2021 · ad18d12 · ad18d12
1 parent 4f817c4
commit ad18d12
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/man/picom.1.asciidoc b/man/picom.1.asciidoc
@@ -167,7 +167,7 @@ OPTIONS
 	Use 'WM_TRANSIENT_FOR' to group windows, and consider windows in the same group focused at the same time.
 
 *--detect-client-leader*::
-	Use 'WM_CLIENT_LEADER' to group windows, and consider windows in the same group focused at the same time. 'WM_TRANSIENT_FOR' has higher priority if *--detect-transient* is enabled, too.
+	Use 'WM_CLIENT_LEADER' to group windows, and consider windows in the same group focused at the same time. This usually means windows from the same application will be considered focused or unfocused at the same time.'WM_TRANSIENT_FOR' has higher priority if *--detect-transient* is enabled, too.
 
 *--blur-method*, *--blur-size*, *--blur-deviation*, *--blur-strength*::
 	Parameters for background blurring, see the *BLUR* section for more information.

diff --git a/picom.sample.conf b/picom.sample.conf
@@ -272,8 +272,9 @@ refresh-rate = 0;
 detect-transient = true;
 
 # Use 'WM_CLIENT_LEADER' to group windows, and consider windows in the same
-# group focused at the same time. 'WM_TRANSIENT_FOR' has higher priority if
-# detect-transient is enabled, too.
+# group focused at the same time. This usually means windows from the same application
+# will be considered focused or unfocused at the same time.
+# 'WM_TRANSIENT_FOR' has higher priority if detect-transient is enabled, too.
 #
 # detect-client-leader = false
 

diff --git a/src/options.c b/src/options.c
@@ -204,8 +204,10 @@ static void usage(const char *argv0, int ret) {
 	    "\n"
 	    "--detect-client-leader\n"
 	    "  Use WM_CLIENT_LEADER to group windows, and consider windows in\n"
-	    "  the same group focused at the same time. WM_TRANSIENT_FOR has\n"
-	    "  higher priority if --detect-transient is enabled, too.\n"
+	    "  the same group focused at the same time. This usually means windows\n"
+	    "  from the same application will be considered focused or unfocused at\n"
+	    "  the same time. WM_TRANSIENT_FOR has higher priority if\n"
+	    "  --detect-transient is enabled, too.\n"
 	    "\n"
 	    "--blur-method\n"
 	    "  The algorithm used for background bluring. Available choices are:\n"